unit_animator Class Reference

#include <animation.hpp>

Classes
struct	anim_elem

Public Member Functions
	unit_animator ()
void	add_animation (const unit *animated_unit, const unit_animation *animation, const map_location &src=map_location::null_location(), bool with_bars=false, const std::string &text="", const Uint32 text_color=0)
void	add_animation (const unit *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 Uint32 text_color=0, const unit_animation::hit_type hit_type=unit_animation::INVALID, const attack_type *attack=nullptr, const attack_type *second_attack=nullptr, int value2=0)
void	replace_anim_if_invalid (const unit *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 Uint32 text_color=0, const unit_animation::hit_type hit_type=unit_animation::INVALID, const attack_type *attack=nullptr, const attack_type *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 151 of file animation.hpp.

Constructor & Destructor Documentation

unit_animator::unit_animator ( )

inline

Definition at line 154 of file animation.hpp.

Member Function Documentation

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

Definition at line 1294 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 dialogs::animate_unit_advancement(), unit_display::unit_mover::finish(), unit_display::unit_mover::start(), teleport_unit_between(), 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::wml_animation_internal().

void unit_animator::add_animation	(	const unit *	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 Uint32	text_color = 0,
		const unit_animation::hit_type	hit_type = unit_animation::INVALID,
		const attack_type *	attack = nullptr,
		const attack_type *	second_attack = nullptr,
		int	value2 = 0
	)

Definition at line 1266 of file animation.cpp.

References unit::anim_comp(), unit_animator::anim_elem::animation, unit_animation_component::choose_animation(), unit_animation::get_begin_time(), display::get_singleton(), 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.

void unit_animator::clear ( )

inline

Definition at line 196 of file animation.hpp.

References animated_units_, and start_time_.

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

int unit_animator::get_animation_time

(

)

const

Definition at line 1416 of file animation.cpp.

Referenced by unit_display::unit_attack().

int unit_animator::get_animation_time_potential

(

)

const

Definition at line 1420 of file animation.cpp.

Referenced by move_unit_between(), and unit_display::unit_attack().

int unit_animator::get_end_time

(

)

const

Definition at line 1424 of file animation.cpp.

Referenced by unit_display::unit_attack().

void unit_animator::pause_animation

(

)

Definition at line 1435 of file animation.cpp.

Referenced by move_unit_between().

void unit_animator::replace_anim_if_invalid	(	const unit *	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 Uint32	text_color = 0,
		const unit_animation::hit_type	hit_type = unit_animation::INVALID,
		const attack_type *	attack = nullptr,
		const attack_type *	second_attack = nullptr,
		int	value2 = 0
	)

Definition at line 1315 of file animation.cpp.

References unit::anim_comp(), unit_animator::anim_elem::animation, unit_animation::animation_finished_potential(), unit_animation_component::get_animation(), display::get_singleton(), unit_animation::MATCH_FAIL, unit_animation::matches(), 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 move_unit_between().

void unit_animator::restart_animation

(

)

Definition at line 1444 of file animation.cpp.

Referenced by move_unit_between().

void unit_animator::set_all_standing

(

)

Definition at line 1453 of file animation.cpp.

Referenced by dialogs::animate_unit_advancement(), unit_display::unit_healing(), unit_display::unit_recruited(), and unit_display::wml_animation().

void unit_animator::start_animations

(

)

Definition at line 1346 of file animation.cpp.

Referenced by dialogs::animate_unit_advancement(), unit_display::unit_mover::finish(), move_unit_between(), unit_display::unit_mover::start(), teleport_unit_between(), 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::wml_animation().

void unit_animator::wait_for_end

(

)

const

Definition at line 1399 of file animation.cpp.

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

Referenced by dialogs::animate_unit_advancement(), unit_display::unit_mover::finish(), unit_display::unit_mover::start(), teleport_unit_between(), 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(), unit_display::unit_mover::wait_for_anims(), and unit_display::wml_animation().

void unit_animator::wait_until

(

int

animation_time

)

const

Definition at line 1380 of file animation.cpp.

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

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

bool unit_animator::would_end

(

)

const

Definition at line 1371 of file animation.cpp.

Referenced by unit_display::unit_attack().

Member Data Documentation

std::vector<anim_elem> unit_animator::animated_units_

private

Definition at line 226 of file animation.hpp.

Referenced by clear().

int unit_animator::start_time_

private

Definition at line 227 of file animation.hpp.

Referenced by clear().

---

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

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