unit_animator Class Reference

#include <unit_animation.hpp>

List of all members.

Public Member Functions

 unit_animator ()
void add_animation (unit *animated_unit, const std::string &event, const gamemap::location &src=gamemap::location::null_location, const int value=0, bool with_bars=false, bool cycles=false, const std::string text="", const Uint32 text_color=0, const unit_animation::hit_type hit_type=unit_animation::INVALID, const attack_type *attack=NULL, const attack_type *second_attack=NULL, int swing_num=0)
void replace_anim_if_invalid (unit *animated_unit, const std::string &event, const gamemap::location &src=gamemap::location::null_location, const int value=0, bool with_bars=false, bool cycles=false, const std::string text="", const Uint32 text_color=0, const unit_animation::hit_type hit_type=unit_animation::INVALID, const attack_type *attack=NULL, const attack_type *second_attack=NULL, int swing_num=0)
void start_animations ()
void pause_animation ()
void restart_animation ()
void empty ()
bool would_end () const
int get_animation_time () const
int get_animation_time_potential () const
int get_end_time () const
void wait_for_end () const
void wait_until (int animation_time) const

Private Attributes

std::vector< anim_elemanimated_units_
int start_time_

Classes

struct  anim_elem


Detailed Description

Definition at line 116 of file unit_animation.hpp.


Constructor & Destructor Documentation

unit_animator::unit_animator (  )  [inline]

Definition at line 119 of file unit_animation.hpp.


Member Function Documentation

void unit_animator::add_animation ( unit animated_unit,
const std::string &  event,
const gamemap::location src = gamemap::location::null_location,
const int  value = 0,
bool  with_bars = false,
bool  cycles = false,
const std::string  text = "",
const Uint32  text_color = 0,
const unit_animation::hit_type  hit_type = unit_animation::INVALID,
const attack_type attack = NULL,
const attack_type second_attack = NULL,
int  swing_num = 0 
)

void unit_animator::replace_anim_if_invalid ( unit animated_unit,
const std::string &  event,
const gamemap::location src = gamemap::location::null_location,
const int  value = 0,
bool  with_bars = false,
bool  cycles = false,
const std::string  text = "",
const Uint32  text_color = 0,
const unit_animation::hit_type  hit_type = unit_animation::INVALID,
const attack_type attack = NULL,
const attack_type second_attack = NULL,
int  swing_num = 0 
)

void unit_animator::start_animations (  ) 

void unit_animator::pause_animation (  ) 

Definition at line 916 of file unit_animation.cpp.

References animated_units_.

Referenced by move_unit_between().

void unit_animator::restart_animation (  ) 

Definition at line 924 of file unit_animation.cpp.

References animated_units_.

Referenced by move_unit_between().

void unit_animator::empty (  )  [inline]

Definition at line 137 of file unit_animation.hpp.

References animated_units_, and start_time_.

bool unit_animator::would_end (  )  const

Definition at line 859 of file unit_animation.cpp.

References animated_units_.

int unit_animator::get_animation_time (  )  const

Definition at line 898 of file unit_animation.cpp.

References animated_units_.

Referenced by wait_until().

int unit_animator::get_animation_time_potential (  )  const

Definition at line 902 of file unit_animation.cpp.

References animated_units_.

Referenced by move_unit_between().

int unit_animator::get_end_time (  )  const

Definition at line 906 of file unit_animation.cpp.

References animated_units_.

void unit_animator::wait_for_end (  )  const

void unit_animator::wait_until ( int  animation_time  )  const


Member Data Documentation

std::vector<anim_elem> unit_animator::animated_units_ [private]

Definition at line 157 of file unit_animation.hpp.

Referenced by add_animation(), and empty().


The documentation for this class was generated from the following files:

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs