unit_animator Class Reference

#include <animation.hpp>

Classes
struct	anim_elem

Public Member Functions
	unit_animator ()
void	add_animation (unit_const_ptr animated_unit, const unit_animation *animation, const map_location &src=map_location::null_location(), bool with_bars=false, const std::string &text="", const color_t text_color={0, 0, 0})
void	add_animation (unit_const_ptr animated_unit, const std::string &event, const map_location &src=map_location::null_location(), const map_location &dst=map_location::null_location(), const int value=0, bool with_bars=false, const std::string &text="", const color_t text_color={0, 0, 0}, const strike_result::type hit_type=strike_result::type::invalid, const_attack_ptr attack=nullptr, const_attack_ptr second_attack=nullptr, int value2=0)
bool	has_animation (unit_const_ptr animated_unit, const std::string &event, const map_location &src=map_location::null_location(), const map_location &dst=map_location::null_location(), const int value=0, const strike_result::type hit_type=strike_result::type::invalid, const_attack_ptr attack=nullptr, const_attack_ptr second_attack=nullptr, int value2=0) const
	has_animation : return an boolean value if animated unit present and have animation specified, used for verify prensence of [leading_anim] or [resistance_anim] for playability of [teaching_anim] More...
void	replace_anim_if_invalid (unit_const_ptr animated_unit, const std::string &event, const map_location &src=map_location::null_location(), const map_location &dst=map_location::null_location(), const int value=0, bool with_bars=false, const std::string &text="", const color_t text_color={0, 0, 0}, const strike_result::type hit_type=strike_result::type::invalid, const_attack_ptr attack=nullptr, const_attack_ptr second_attack=nullptr, int value2=0)
void	start_animations ()
void	pause_animation ()
void	restart_animation ()
void	clear ()
void	set_all_standing ()
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_elem >	animated_units_
int	start_time_

Detailed Description

Definition at line 190 of file animation.hpp.

Constructor & Destructor Documentation

unit_animator()

unit_animator::unit_animator ( )

inline

Definition at line 193 of file animation.hpp.

Member Function Documentation

add_animation() [1/2]

void unit_animator::add_animation	(	unit_const_ptr	animated_unit,
		const std::string &	event,
		const map_location &	src = map_location::null_location(),
		const map_location &	dst = map_location::null_location(),
		const int	value = 0,
		bool	with_bars = false,
		const std::string &	text = "",
		const color_t	text_color = {0,0,0},
		const strike_result::type	hit_type = strike_result::type::invalid,
		const_attack_ptr	attack = nullptr,
		const_attack_ptr	second_attack = nullptr,
		int	value2 = 0
	)

Definition at line 1296 of file animation.cpp.

References unit_animator::anim_elem::animation, unit_animation::get_begin_time(), unit_animator::anim_elem::my_unit, unit_animator::anim_elem::src, unit_animator::anim_elem::text, unit_animator::anim_elem::text_color, and unit_animator::anim_elem::with_bars.

add_animation() [2/2]

void unit_animator::add_animation	(	unit_const_ptr	animated_unit,
		const unit_animation *	animation,
		const map_location &	src = map_location::null_location(),
		bool	with_bars = false,
		const std::string &	text = "",
		const color_t	text_color = {0,0,0}
	)

Definition at line 1325 of file animation.cpp.

References unit_animator::anim_elem::animation, unit_animation::get_begin_time(), unit_animator::anim_elem::my_unit, unit_animator::anim_elem::src, unit_animator::anim_elem::text, unit_animator::anim_elem::text_color, and unit_animator::anim_elem::with_bars.

Referenced by unit_display::unit_mover::finish(), impl_add_animation(), unit_display::unit_mover::start(), unit_display::unit_attack(), unit_display::unit_die(), unit_display::unit_draw_weapon(), unit_display::unit_healing(), unit_display::unit_recruited(), and unit_display::unit_sheath_weapon().

clear()

void unit_animator::clear ( )

inline

Definition at line 256 of file animation.hpp.

References animated_units_, and start_time_.

Referenced by unit_display::unit_mover::finish(), impl_clear_animation(), game_lua_kernel::impl_run_animation(), unit_display::unit_mover::start(), unit_display::unit_mover::wait_for_anims(), and unit_display::unit_mover::~unit_mover().

get_animation_time()

int unit_animator::get_animation_time

(

)

const

Definition at line 1477 of file animation.cpp.

Referenced by unit_display::unit_attack().

get_animation_time_potential()

int unit_animator::get_animation_time_potential

(

)

const

Definition at line 1485 of file animation.cpp.

Referenced by unit_display::unit_attack().

get_end_time()

int unit_animator::get_end_time

(

)

const

Definition at line 1493 of file animation.cpp.

Referenced by unit_display::unit_attack().

has_animation()

bool unit_animator::has_animation	(	unit_const_ptr	animated_unit,
		const std::string &	event,
		const map_location &	src = map_location::null_location(),
		const map_location &	dst = map_location::null_location(),
		const int	value = 0,
		const strike_result::type	hit_type = strike_result::type::invalid,
		const_attack_ptr	attack = nullptr,
		const_attack_ptr	second_attack = nullptr,
		int	value2 = 0
	)		const

has_animation : return an boolean value if animated unit present and have animation specified, used for verify prensence of [leading_anim] or [resistance_anim] for playability of [teaching_anim]

Returns

True if the animated_unit is present and have animation.

Parameters

animated_unit	the unit who is checked.
event	the animation who is checked([leading_anim] or [resistance_anim].
src	the location of animated_unit.
dst	location of unit student(attacker or defender).
value	value of damage.
hit_type	type of damage inflicted.
attack	weapon used by student.
second_attack	weapon used by opponent.
value2	i don't understand myself.but this value is used in choose_animation.

Definition at line 1348 of file animation.cpp.

Referenced by unit_display::unit_attack().

pause_animation()

void unit_animator::pause_animation

(

)

Definition at line 1505 of file animation.cpp.

replace_anim_if_invalid()

void unit_animator::replace_anim_if_invalid	(	unit_const_ptr	animated_unit,
		const std::string &	event,
		const map_location &	src = map_location::null_location(),
		const map_location &	dst = map_location::null_location(),
		const int	value = 0,
		bool	with_bars = false,
		const std::string &	text = "",
		const color_t	text_color = {0,0,0},
		const strike_result::type	hit_type = strike_result::type::invalid,
		const_attack_ptr	attack = nullptr,
		const_attack_ptr	second_attack = nullptr,
		int	value2 = 0
	)

Definition at line 1361 of file animation.cpp.

References unit_animator::anim_elem::animation, unit_animation::MATCH_FAIL, unit_animator::anim_elem::my_unit, unit_animator::anim_elem::src, unit_animator::anim_elem::text, unit_animator::anim_elem::text_color, and unit_animator::anim_elem::with_bars.

restart_animation()

void unit_animator::restart_animation

(

)

Definition at line 1514 of file animation.cpp.

set_all_standing()

void unit_animator::set_all_standing

(

)

Definition at line 1523 of file animation.cpp.

Referenced by game_lua_kernel::impl_run_animation(), unit_display::unit_healing(), and unit_display::unit_recruited().

start_animations()

void unit_animator::start_animations

(

)

Definition at line 1395 of file animation.cpp.

Referenced by unit_display::unit_mover::finish(), game_lua_kernel::impl_run_animation(), unit_display::unit_mover::start(), unit_display::unit_attack(), unit_display::unit_die(), unit_display::unit_draw_weapon(), unit_display::unit_healing(), unit_display::unit_recruited(), and unit_display::unit_sheath_weapon().

wait_for_end()

void unit_animator::wait_for_end

(

)

const

Definition at line 1460 of file animation.cpp.

References resources::controller, game_config::no_delay, and controller_base::play_slice().

Referenced by unit_display::unit_mover::finish(), game_lua_kernel::impl_run_animation(), unit_display::unit_mover::start(), unit_display::unit_attack(), unit_display::unit_die(), unit_display::unit_draw_weapon(), unit_display::unit_healing(), unit_display::unit_recruited(), unit_display::unit_sheath_weapon(), and unit_display::unit_mover::wait_for_anims().

wait_until()

void unit_animator::wait_until

(

int

animation_time

)

const

Definition at line 1429 of file animation.cpp.

References resources::controller, unit_animation::get_animation_time(), display::get_singleton(), new_animation_frame(), game_config::no_delay, controller_base::play_slice(), and display::turbo_speed().

Referenced by unit_display::unit_attack(), and unit_display::unit_mover::wait_for_anims().

would_end()

bool unit_animator::would_end

(

)

const

Definition at line 1419 of file animation.cpp.

Referenced by unit_display::unit_attack().

Member Data Documentation

animated_units_

std::vector<anim_elem> unit_animator::animated_units_

private

Definition at line 291 of file animation.hpp.

Referenced by clear().

start_time_

int unit_animator::start_time_

private

Definition at line 292 of file animation.hpp.

Referenced by clear().

---

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

• units/animation.hpp
• units/animation.cpp