Ability functions

Enumerations
enum	backwards_compatibility::unit_checksum_version { backwards_compatibility::unit_checksum_version::current, backwards_compatibility::unit_checksum_version::version_1_16_or_older }
	Optional parameter for get_checksum to use the algorithm of an older version of Wesnoth, thus preventing spurious OOS warnings while watching old replays. More...

Functions
static std::string	unit::upkeep_full::type ()
static std::string	unit::upkeep_loyal::type ()
	unit::upkeep_value_visitor::upkeep_value_visitor (const unit &unit)
int	unit::upkeep_value_visitor::operator() (const upkeep_full &) const
	Full upkeep equals the unit's level. More...
int	unit::upkeep_value_visitor::operator() (const upkeep_loyal &) const
	Loyal units cost no upkeep. More...
int	unit::upkeep_value_visitor::operator() (int v) const
template<typename T >
std::enable_if_t<!std::is_same_v< int, T >, std::string >	unit::upkeep_type_visitor::operator() (T &) const
std::string	unit::upkeep_type_visitor::operator() (int v) const
template<typename N >
std::enable_if_t< std::is_arithmetic_v< N >, upkeep_t >	unit::upkeep_parser_visitor::operator() (N n) const
template<typename B >
std::enable_if_t< std::is_convertible_v< B, bool > &&!std::is_arithmetic_v< B >, upkeep_t >	unit::upkeep_parser_visitor::operator() (B b) const
upkeep_t	unit::upkeep_parser_visitor::operator() (utils::monostate) const
upkeep_t	unit::upkeep_parser_visitor::operator() (const std::string &s) const
bool	unit::get_ability_bool (const std::string &tag_name, const map_location &loc) const
	Checks whether this unit currently possesses or is affected by a given ability. More...
bool	unit::get_ability_bool (const std::string &tag_name) const
	Checks whether this unit currently possesses or is affected by a given ability. More...
unit_ability_list	unit::get_abilities (const std::string &tag_name, const map_location &loc) const
	Gets the unit's active abilities of a particular type if it were on a specified location. More...
unit_ability_list	unit::get_abilities (const std::string &tag_name) const
	Gets the unit's active abilities of a particular type. More...
unit_ability_list	unit::get_abilities_weapons (const std::string &tag_name, const map_location &loc, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
unit_ability_list	unit::get_abilities_weapons (const std::string &tag_name, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
const config &	unit::abilities () const
const std::set< std::string > &	unit::checking_tags () const
std::vector< std::tuple< std::string, t_string, t_string, t_string > >	unit::ability_tooltips () const
	Gets the names and descriptions of this unit's abilities. More...
std::vector< std::tuple< std::string, t_string, t_string, t_string > >	unit::ability_tooltips (boost::dynamic_bitset<> &active_list, const map_location &loc) const
	Gets the names and descriptions of this unit's abilities. More...
std::vector< std::string >	unit::get_ability_list () const
	Get a list of all abilities by ID. More...
bool	unit::has_ability_type (const std::string &ability) const
	Check if the unit has an ability of a specific type. More...
bool	unit::has_ability_by_id (const std::string &ability) const
	Check if the unit has an ability of a specific ID. More...
void	unit::remove_ability_by_id (const std::string &ability)
	Removes a unit's abilities with a specific ID. More...
bool	unit::ability_active (const std::string &ability, const config &cfg, const map_location &loc) const
	Check if an ability is active. More...
bool	unit::ability_affects_adjacent (const std::string &ability, const config &cfg, int dir, const map_location &loc, const unit &from) const
	Check if an ability affects adjacent units. More...
bool	unit::ability_affects_self (const std::string &ability, const config &cfg, const map_location &loc) const
	Check if an ability affects the owning unit. More...
bool	unit::ability_affects_weapon (const config &cfg, const_attack_ptr weapon, bool is_opp) const
	filters the weapons that condition the use of abilities for combat ([resistance],[leadership] or abilities used like specials (deprecated in two last cases) More...
unit_formula_manager &	unit::formula_manager () const
	Get the unit formula manager. More...
void	unit::generate_name ()
	Generates a random race-appropriate name if one has not already been provided. More...
bool	unit::invisible (const map_location &loc, bool see_all=true) const
bool	unit::is_visible_to_team (const team &team, bool const see_all=true) const
bool	unit::is_visible_to_team (const map_location &loc, const team &team, bool const see_all=true) const
	Return true if the unit would be visible to team if its location were loc. More...
void	unit::write (config &cfg, bool write_all=true) const
	Serializes the current unit metadata values. More...
unit &	unit::mark_clone (bool is_temporary)
	Mark this unit as clone so it can be inserted to unit_map. More...
void	unit::set_appearance_changed (bool value)
bool	unit::appearance_changed () const
void	unit::parse_upkeep (const config::attribute_value &upkeep)
void	unit::write_upkeep (config::attribute_value &upkeep) const
void	unit::clear_visibility_cache () const
	Clears the cache. More...
	unit_movement_resetter::unit_movement_resetter (const unit_movement_resetter &)=delete
unit_movement_resetter &	unit_movement_resetter::operator= (const unit_movement_resetter &)=delete
	unit_movement_resetter::unit_movement_resetter (const unit &u, bool operate=true)
	unit_movement_resetter::~unit_movement_resetter ()

Variables
const unit &	unit::upkeep_value_visitor::u_
const std::set< std::string >	unit::checking_tags_ {"attacks", "damage", "chance_to_hit", "berserk", "swarm", "drains", "heal_on_hit", "plague", "slow", "petrifies", "firststrike", "poison"}
map_location	unit::loc_
std::vector< std::string >	unit::advances_to_
const unit_type *	unit::type_
	Never nullptr. More...
t_string	unit::type_name_
	The displayed name of this unit type. More...
const unit_race *	unit::race_
	Never nullptr, but may point to the null race. More...
std::string	unit::id_
t_string	unit::name_
n_unit::unit_id	unit::underlying_id_
std::string	unit::undead_variation_
std::string	unit::variation_
int	unit::hit_points_
int	unit::max_hit_points_
int	unit::experience_
int	unit::max_experience_
int	unit::level_
int	unit::recall_cost_
bool	unit::canrecruit_
std::vector< std::string >	unit::recruit_list_
unit_alignments::type	unit::alignment_
std::string	unit::flag_rgb_
std::string	unit::image_mods_
bool	unit::unrenamable_
int	unit::side_
unit_race::GENDER	unit::gender_
std::unique_ptr< unit_formula_manager >	unit::formula_man_
int	unit::movement_
int	unit::max_movement_
int	unit::vision_
int	unit::jamming_
movetype	unit::movement_type_
bool	unit::hold_position_
bool	unit::end_turn_
bool	unit::resting_
int	unit::attacks_left_
int	unit::max_attacks_
std::set< std::string >	unit::states_
static const std::size_t	unit::num_bool_states = 7
std::bitset< num_bool_states >	unit::known_boolean_states_
static std::map< std::string, state_t >	unit::known_boolean_state_names_
config	unit::variables_
config	unit::events_
config	unit::filter_recall_
bool	unit::emit_zoc_
std::vector< std::string >	unit::overlays_
std::string	unit::role_
attack_list	unit::attacks_
map_location::DIRECTION	unit::facing_
std::vector< t_string >	unit::trait_names_
std::vector< t_string >	unit::trait_descriptions_
int	unit::unit_value_
map_location	unit::goto_
map_location	unit::interrupted_move_
bool	unit::is_fearless_
bool	unit::is_healthy_
utils::string_map	unit::modification_descriptions_
std::unique_ptr< unit_animation_component >	unit::anim_comp_
bool	unit::hidden_
double	unit::hp_bar_scaling_
double	unit::xp_bar_scaling_
config	unit::modifications_
config	unit::abilities_
std::vector< config >	unit::advancements_
t_string	unit::description_
std::vector< t_string >	unit::special_notes_
std::optional< std::string >	unit::usage_
std::optional< std::string >	unit::halo_
std::optional< std::string >	unit::ellipse_
bool	unit::random_traits_
bool	unit::generate_name_
upkeep_t	unit::upkeep_
std::string	unit::profile_
std::string	unit::small_profile_
bool	unit::appearance_changed_ = true
std::bitset< UA_COUNT >	unit::changed_attributes_
std::map< map_location, bool >	unit::invisibility_cache_
	Hold the visibility status cache for a unit, when not uncovered. More...
unit &	unit_movement_resetter::u_
int	unit_movement_resetter::moves_

Friends
class	unit::unit_animation_component

already added
bool	unit::get_self_ability_bool (const config &special, const std::string &tag_name, const map_location &loc) const
	Checks whether this unit currently possesses a given ability used like weapon. More...
bool	unit::get_self_ability_bool_weapon (const config &special, const std::string &tag_name, const map_location &loc, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
	Checks whether this unit currently possesses a given ability of leadership type. More...
bool	unit::get_adj_ability_bool (const config &special, const std::string &tag_name, int dir, const map_location &loc, const unit &from) const
	Checks whether this unit is affected by a given ability used like weapon. More...
bool	unit::get_adj_ability_bool_weapon (const config &special, const std::string &tag_name, int dir, const map_location &loc, const unit &from, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
	Checks whether this unit is affected by a given ability of leadership type. More...

Detailed Description

Enumeration Type Documentation

unit_checksum_version

enum backwards_compatibility::unit_checksum_version

strong

Optional parameter for get_checksum to use the algorithm of an older version of Wesnoth, thus preventing spurious OOS warnings while watching old replays.

Enumerator
current
version_1_16_or_older	Included some of the flavortext from weapon specials.

Definition at line 2023 of file unit.hpp.

Function Documentation

abilities()

const config& unit::abilities ( ) const

inline

Definition at line 1724 of file unit.hpp.

Referenced by unit::init().

ability_active()

bool unit::ability_active ( const std::string &  ability, const config &  cfg, const map_location &  loc  ) const

private

Check if an ability is active.

Parameters

ability	The type (tag name) of the ability
cfg	an ability WML structure
loc	The location on which to resolve the ability

Returns

true if it is active

Definition at line 381 of file abilities.cpp.

References config::child(), config::child_range(), unit_map::end(), resources::filter_con, unit_map::find(), get_adjacent_tiles(), filter_context::get_disp_context(), display_context::get_team(), i, utf8::index(), unit_filter::matches(), map_location::NDIRECTIONS, map_location::parse_directions(), utils::parse_ranges(), and unit_filter::set_use_flat_tod().

Referenced by unit::get_adj_ability_bool().

ability_affects_adjacent()

bool unit::ability_affects_adjacent ( const std::string &  ability, const config &  cfg, int  dir, const map_location &  loc, const unit &  from  ) const

private

Check if an ability affects adjacent units.

Parameters

ability	The type (tag name) of the ability
cfg	an ability WML structure
loc	The location on which to resolve the ability
from	The "other unit" for filter matching
dir	The direction the unit is facing

Definition at line 451 of file abilities.cpp.

References config::child_range(), i, and map_location::parse_directions().

ability_affects_self()

bool unit::ability_affects_self ( const std::string &  ability, const config &  cfg, const map_location &  loc  ) const

private

Check if an ability affects the owning unit.

Parameters

ability	The type (tag name) of the ability
cfg	an ability WML structure
loc	The location on which to resolve the ability

Definition at line 475 of file abilities.cpp.

References config::child(), unit_filter::matches(), and unit_filter::set_use_flat_tod().

ability_affects_weapon()

bool unit::ability_affects_weapon ( const config &  cfg, const_attack_ptr  weapon, bool  is_opp  ) const

private

filters the weapons that condition the use of abilities for combat ([resistance],[leadership] or abilities used like specials (deprecated in two last cases)

Definition at line 483 of file abilities.cpp.

References config::child(), and config::has_child().

ability_tooltips() [1/2]

std::vector< std::tuple< std::string, t_string, t_string, t_string > > unit::ability_tooltips

(

)

const

Gets the names and descriptions of this unit's abilities.

Location-independent variant with all abilities shown as active.

Returns

A list of quadruples consisting of (in order) id, base name, male or female name as appropriate for the unit, and description.

Definition at line 353 of file abilities.cpp.

Referenced by gui2::unit_preview_pane::set_displayed_unit(), and unit_abilities().

ability_tooltips() [2/2]

std::vector< std::tuple< std::string, t_string, t_string, t_string > > unit::ability_tooltips	(	boost::dynamic_bitset<> &	active_list,
		const map_location &	loc
	)		const

Gets the names and descriptions of this unit's abilities.

Parameters

active_list	This vector will be the same length as the returned one and will indicate whether or not the corresponding ability is active.
loc	The location on which to resolve the ability.

Returns

A list of quadruples consisting of (in order) id, base name, male or female name as appropriate for the unit, and description.

Definition at line 365 of file abilities.cpp.

appearance_changed()

bool unit::appearance_changed ( ) const

inline

Definition at line 1846 of file unit.hpp.

checking_tags()

const std::set<std::string>& unit::checking_tags ( ) const

inline

Definition at line 1726 of file unit.hpp.

Referenced by unit_display::reset_helpers().

clear_visibility_cache()

void unit::clear_visibility_cache ( ) const

inlineprivate

Clears the cache.

Since we don't change the state of the object we're marked const (also required since the objects in the cache need to be marked const).

Definition at line 1989 of file unit.hpp.

References swap().

formula_manager()

unit_formula_manager& unit::formula_manager ( ) const

inline

Get the unit formula manager.

Definition at line 1814 of file unit.hpp.

References write().

Referenced by wfl::unit_callable::get_value().

generate_name()

void unit::generate_name

(

)

Generates a random race-appropriate name if one has not already been provided.

Definition at line 795 of file unit.cpp.

References t_string::empty(), unit::gender_, unit_race::generate_name(), unit::generate_name_, unit::name_, and unit::race_.

Referenced by unit::init().

get_abilities() [1/2]

unit_ability_list unit::get_abilities	(	const std::string &	tag_name,
		const map_location &	loc
	)		const

Gets the unit's active abilities of a particular type if it were on a specified location.

Parameters

tag_name	The type of ability to check for
loc	The location to use for resolving abilities

Returns

A list of active abilities, paired with the location they are active on

Definition at line 220 of file abilities.cpp.

References unit_ability_list::emplace_back(), unit_map::end(), unit_map::find(), get_adjacent_tiles(), i, and loc_.

Referenced by unit::defense_modifier(), pathfind::get_teleport_locations(), and unit_display::reset_helpers().

get_abilities() [2/2]

unit_ability_list unit::get_abilities ( const std::string &  tag_name ) const

inline

Gets the unit's active abilities of a particular type.

Parameters

tag_name

The type of ability to check for

Returns

A list of active abilities, paired with the location they are active on

Definition at line 1712 of file unit.hpp.

References loc_.

get_abilities_weapons() [1/2]

unit_ability_list unit::get_abilities_weapons	(	const std::string &	tag_name,
		const map_location &	loc,
		const_attack_ptr	weapon = nullptr,
		const_attack_ptr	opp_weapon = nullptr
	)		const

Definition at line 260 of file abilities.cpp.

References unit_ability::ability_cfg, utils::erase_if(), and i.

Referenced by unit::resistance_against(), and under_leadership().

get_abilities_weapons() [2/2]

unit_ability_list unit::get_abilities_weapons ( const std::string &  tag_name, const_attack_ptr  weapon = nullptr, const_attack_ptr  opp_weapon = nullptr  ) const

inline

Definition at line 1719 of file unit.hpp.

References loc_.

get_ability_bool() [1/2]

bool unit::get_ability_bool	(	const std::string &	tag_name,
		const map_location &	loc
	)		const

Checks whether this unit currently possesses or is affected by a given ability.

This means that the ability could be owned by this unit itself or by an adjacent unit, should the ability affect an AoE in which this unit happens to be.

Parameters

tag_name	The name of the ability to check for.
loc	The location around which to check for affected units. This may or may not be the location of this unit.

Definition at line 182 of file abilities.cpp.

References unit_map::end(), unit_map::find(), get_adjacent_tiles(), and i.

Referenced by pathfind::shortest_path_calculator::cost(), ai::ai_default_rca::get_healing_phase::evaluate(), pathfind::find_routes(), game_lua_kernel::intf_unit_ability(), unit::invisible(), pathfind::mark_route(), ai::ai_default_rca::aspect_attacks_base::rate_terrain(), and ai::default_ai_context_impl::rate_terrain().

get_ability_bool() [2/2]

bool unit::get_ability_bool ( const std::string &  tag_name ) const

inline

Checks whether this unit currently possesses or is affected by a given ability.

This means that the ability could be owned by this unit itself or by an adjacent unit, should the ability affect an AoE in which this unit happens to be.

This overload uses the location of this unit for calculations.

Parameters

tag_name

The name of the ability to check for.

Definition at line 1657 of file unit.hpp.

References loc_.

get_ability_list()

std::vector< std::string > unit::get_ability_list

(

)

const

Get a list of all abilities by ID.

Definition at line 269 of file abilities.cpp.

References config_attribute_value::blank(), config::any_child::cfg, t_string::empty(), unit_race::MALE, and config_attribute_value::t_str().

Referenced by wfl::unit_callable::get_value(), wfl::unit_type_callable::get_value(), and gui2::unit_preview_pane::set_displayed_unit().

get_adj_ability_bool()

bool unit::get_adj_ability_bool	(	const config &	special,
		const std::string &	tag_name,
		int	dir,
		const map_location &	loc,
		const unit &	from
	)		const

Checks whether this unit is affected by a given ability used like weapon.

Returns

True if the ability tag_name is active.

Parameters

special	the const config to one of abilities tag_name checked.
tag_name	name of ability type checked.
loc	location of the unit checked.
from	unit adjacent to this is checked in case of [affect_adjacent] abilities.
dir	direction to research a unit adjacent to this.

Definition at line 1374 of file abilities.cpp.

References unit::ability_active(), get_adjacent_tiles(), and unit::side().

get_adj_ability_bool_weapon()

bool unit::get_adj_ability_bool_weapon	(	const config &	special,
		const std::string &	tag_name,
		int	dir,
		const map_location &	loc,
		const unit &	from,
		const_attack_ptr	weapon = nullptr,
		const_attack_ptr	opp_weapon = nullptr
	)		const

Checks whether this unit is affected by a given ability of leadership type.

Returns

True if the ability tag_name is active.

Parameters

special	the const config to one of abilities tag_name checked.
tag_name	name of ability type checked.
loc	location of the unit checked.
from	unit adjacent to this is checked in case of [affect_adjacent] abilities.
dir	direction to research a unit adjacent to this.
weapon	the attack used by unit checked in this function.
opp_weapon	the attack used by opponent to unit checked.

Definition at line 1385 of file abilities.cpp.

get_self_ability_bool()

bool unit::get_self_ability_bool	(	const config &	special,
		const std::string &	tag_name,
		const map_location &	loc
	)		const

Checks whether this unit currently possesses a given ability used like weapon.

Returns

True if the ability tag_name is active.

Parameters

special	the const config to one of abilities tag_name checked.
tag_name	name of ability type checked.
loc	location of the unit checked.

Definition at line 1369 of file abilities.cpp.

get_self_ability_bool_weapon()

bool unit::get_self_ability_bool_weapon	(	const config &	special,
		const std::string &	tag_name,
		const map_location &	loc,
		const_attack_ptr	weapon = nullptr,
		const_attack_ptr	opp_weapon = nullptr
	)		const

Checks whether this unit currently possesses a given ability of leadership type.

Returns

True if the ability tag_name is active.

Parameters

special	the const config to one of abilities tag_name checked.
tag_name	name of ability type checked.
loc	location of the unit checked.
weapon	the attack used by unit checked in this function.
opp_weapon	the attack used by opponent to unit checked.

Definition at line 1380 of file abilities.cpp.

has_ability_by_id()

bool unit::has_ability_by_id

(

const std::string &

ability

)

const

Check if the unit has an ability of a specific ID.

Parameters

ability

The ID of ability to check for.

Returns

true if the ability is present

Definition at line 1463 of file unit.cpp.

References unit::abilities_, and config::all_children_range().

Referenced by unit::apply_builtin_effect().

has_ability_type()

bool unit::has_ability_type

(

const std::string &

ability

)

const

Check if the unit has an ability of a specific type.

Parameters

ability

The type of ability (tag name) to check for.

Returns

true if the ability is present

Definition at line 496 of file abilities.cpp.

invisible()

bool unit::invisible	(	const map_location &	loc,
		bool	see_all = true
	)		const

Todo:

FIXME: We use the cache only when using the default see_all=true Maybe add a second cache if the see_all=false become more frequent.

Definition at line 2513 of file unit.cpp.

References DBG_UT, resources::gameboard, unit::get_ability_bool(), unit::get_location(), unit::get_state(), unit::id(), unit::invisibility_cache_, unit::side_, unit::STATE_UNCOVERED, and display_context::would_be_discovered().

Referenced by unit::is_visible_to_team(), pathfind::mark_route(), gui2::dialogs::unit_list::pre_show(), unit_drawer::redraw_unit(), unit_status(), and display_context::would_be_discovered().

is_visible_to_team() [1/2]

bool unit::is_visible_to_team	(	const team &	team,
		bool const	see_all = true
	)		const

Definition at line 2556 of file unit.cpp.

References unit::get_location().

Referenced by actions::actor_sighted(), actions::get_sides_not_seeing(), and unit_drawer::redraw_unit().

is_visible_to_team() [2/2]

bool unit::is_visible_to_team	(	const map_location &	loc,
		const team &	team,
		bool const	see_all = true
	)		const

Return true if the unit would be visible to team if its location were loc.

Definition at line 2562 of file unit.cpp.

References team::fogged(), display::get_singleton(), unit::invisible(), team::is_enemy(), n_unit::unit_id::is_fake(), team::side(), unit::side(), and unit::underlying_id_.

mark_clone()

unit & unit::mark_clone

(

bool

is_temporary

)

Mark this unit as clone so it can be inserted to unit_map.

Returns

self (for convenience)

Definition at line 2614 of file unit.cpp.

References resources::gameboard, resources::gamedata, n_unit::id_manager::global_instance(), unit::id_, game_data::INITIAL, synced_context::is_synced(), n_unit::id_manager::next_fake_id(), n_unit::id_manager::next_id(), unit::set_underlying_id(), unit::underlying_id_, game_board::unit_id_manager(), and WRN_UT.

Referenced by temporary_unit_placer::temporary_unit_placer().

operator()() [1/9]

int unit::upkeep_value_visitor::operator() ( const upkeep_full &  ) const

inline

Full upkeep equals the unit's level.

Definition at line 1150 of file unit.hpp.

operator()() [2/9]

int unit::upkeep_value_visitor::operator() ( const upkeep_loyal &  ) const

inline

Loyal units cost no upkeep.

Definition at line 1156 of file unit.hpp.

operator()() [3/9]

int unit::upkeep_value_visitor::operator() ( int  v ) const

inline

Definition at line 1161 of file unit.hpp.

operator()() [4/9]

template<typename T >

std::enable_if_t<!std::is_same_v<int, T>, std::string> unit::upkeep_type_visitor::operator() ( T &  ) const

inline

Definition at line 1178 of file unit.hpp.

operator()() [5/9]

std::string unit::upkeep_type_visitor::operator() ( int  v ) const

inline

Definition at line 1184 of file unit.hpp.

operator()() [6/9]

template<typename N >

std::enable_if_t<std::is_arithmetic_v<N>, upkeep_t> unit::upkeep_parser_visitor::operator() ( N  n ) const

inline

Definition at line 1199 of file unit.hpp.

References n.

operator()() [7/9]

template<typename B >

std::enable_if_t<std::is_convertible_v<B, bool> && !std::is_arithmetic_v<B>, upkeep_t> unit::upkeep_parser_visitor::operator() ( B  b ) const

inline

Definition at line 1208 of file unit.hpp.

operator()() [8/9]

upkeep_t unit::upkeep_parser_visitor::operator() ( utils::monostate  ) const

inline

Definition at line 1213 of file unit.hpp.

operator()() [9/9]

upkeep_t unit::upkeep_parser_visitor::operator() ( const std::string &  s ) const

inline

Definition at line 1218 of file unit.hpp.

operator=()

unit_movement_resetter& unit_movement_resetter::operator= ( const unit_movement_resetter &  )

delete

parse_upkeep()

void unit::parse_upkeep ( const config::attribute_value &  upkeep )

private

Definition at line 2730 of file unit.cpp.

References config_attribute_value::apply_visitor(), e, config_attribute_value::empty(), and WRN_UT.

Referenced by unit::advance_to(), and unit::init().

remove_ability_by_id()

void unit::remove_ability_by_id

(

const std::string &

ability

)

Removes a unit's abilities with a specific ID.

Parameters

ability

The type of ability (tag name) to remove.

Definition at line 1474 of file unit.cpp.

References unit::abilities_, config::erase(), i, config::ordered_begin(), config::ordered_end(), unit::set_attr_changed(), and unit::UA_ABILITIES.

Referenced by unit::apply_builtin_effect().

set_appearance_changed()

void unit::set_appearance_changed ( bool  value )

inline

Definition at line 1845 of file unit.hpp.

type() [1/2]

static std::string unit::upkeep_full::type ( )

inlinestatic

Definition at line 1130 of file unit.hpp.

type() [2/2]

static std::string unit::upkeep_loyal::type ( )

inlinestatic

Definition at line 1135 of file unit.hpp.

Referenced by unit::apply_builtin_effect().

unit_movement_resetter() [1/2]

unit_movement_resetter::unit_movement_resetter ( const unit_movement_resetter &  )

delete

unit_movement_resetter() [2/2]

unit_movement_resetter::unit_movement_resetter	(	const unit &	u,
		bool	operate = true
	)

Definition at line 2639 of file unit.cpp.

References unit::set_movement(), unit::total_movement(), and unit_movement_resetter::u_.

upkeep_value_visitor()

unit::upkeep_value_visitor::upkeep_value_visitor ( const unit &  unit )

inlineexplicit

Definition at line 1147 of file unit.hpp.

write()

void unit::write	(	config &	cfg,
		bool	write_all = true
	)		const

Serializes the current unit metadata values.

Parameters

cfg	The config to write to.
write_all	set this to false to not write unchanged attributes.

Definition at line 1497 of file unit.cpp.

References unit::abilities_, config::add_child(), unit::advancements_, unit::advances_to_, unit::alignment_, config::append(), unit::attacks_, unit::attacks_left_, unit::can_recruit(), config::clear_children(), unit::description_, unit::ellipse_, unit::emit_zoc_, unit::events_, unit::experience_, unit::facing_, unit::filter_recall_, unit::flag_rgb_, unit::formula_man_, unit::gender_, gender_string(), unit::generate_name_, unit::get_attacks_changed(), unit::get_attr_changed(), unit::get_states(), string_enums::enum_base< Definition >::get_string(), unit::goto_, unit::halo_, unit::hidden_, unit::hit_points_, i, unit_type::icon(), unit_race::id(), unit::id_, unit_type::image(), unit::jamming_, utils::join(), unit::level_, unit::max_attacks_, unit::max_experience_, unit::max_hit_points_, unit::max_movement_, unit::modifications_, unit::movement_, unit::movement_type_, unit::name_, unit_type::parent_id(), unit::profile_, unit::race_, unit::random_traits_, unit::recall_cost_, unit::recruit_list_, unit::resting_, unit::role_, unit::side_, unit::small_profile_, unit::special_notes_, unit::type(), unit::type_id(), unit::type_name_, unit::UA_ABILITIES, unit::UA_ADVANCE_TO, unit::UA_ADVANCEMENTS, unit::UA_ALIGNMENT, unit::UA_ATTACKS, unit::UA_LEVEL, unit::UA_MAX_AP, unit::UA_MAX_HP, unit::UA_MAX_MP, unit::UA_MAX_XP, unit::UA_MOVEMENT_TYPE, unit::UA_NOTES, unit::UA_PROFILE, unit::UA_SMALL_PROFILE, unit::UA_ZOC, unit::undead_variation_, unit::underlying_id_, unit::unit_description(), unit::unit_value_, unit::unrenamable_, unit::usage_, n_unit::unit_id::value, unit::variables_, unit::variation_, unit::vision_, map_location::wml_x(), map_location::wml_y(), movetype::write(), map_location::write_direction(), and unit::write_upkeep().

Referenced by actions::find_recruit_location(), and get_checksum().

write_upkeep()

void unit::write_upkeep ( config::attribute_value &  upkeep ) const

private

Definition at line 2744 of file unit.cpp.

Referenced by unit::write().

~unit_movement_resetter()

unit_movement_resetter::~unit_movement_resetter

(

)

Definition at line 2648 of file unit.cpp.

References DBG_UT, resources::gameboard, utils::get_unknown_exception_type(), unit_movement_resetter::moves_, unit::set_movement(), and unit_movement_resetter::u_.

Variable Documentation

abilities_

config unit::abilities_

private

Definition at line 1951 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::has_ability_by_id(), unit::init(), unit::remove_ability_by_id(), and unit::write().

advancements_

std::vector<config> unit::advancements_

private

Definition at line 1953 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::set_advancements(), and unit::write().

advances_to_

std::vector<std::string> unit::advances_to_

private

Definition at line 1853 of file unit.hpp.

Referenced by unit::advance_to(), unit::advancement_icons(), unit::advances_to_translated(), unit::apply_builtin_effect(), unit::get_modification_advances(), unit::set_advances_to(), unit::swap(), and unit::write().

alignment_

unit_alignments::type unit::alignment_

private

Definition at line 1881 of file unit.hpp.

Referenced by unit::advance_to(), unit::init(), unit::swap(), and unit::write().

anim_comp_

std::unique_ptr<unit_animation_component> unit::anim_comp_

private

Definition at line 1945 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::expire_modifications(), unit::init(), unit::swap(), and unit::~unit().

appearance_changed_

bool unit::appearance_changed_ = true

mutableprivate

Definition at line 1971 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::set_facing(), and unit::set_state().

attacks_

attack_list unit::attacks_

private

Definition at line 1924 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::describe_builtin_effect(), unit::get_attacks_changed(), unit::init(), unit::swap(), unit::unit(), and unit::write().

attacks_left_

int unit::attacks_left_

private

Definition at line 1905 of file unit.hpp.

Referenced by unit::init(), unit::new_turn(), unit::swap(), and unit::write().

canrecruit_

bool unit::canrecruit_

private

Definition at line 1879 of file unit.hpp.

Referenced by unit::init(), and unit::swap().

changed_attributes_

std::bitset<UA_COUNT> unit::changed_attributes_

private

Definition at line 1972 of file unit.hpp.

Referenced by unit::unit().

checking_tags_

const std::set<std::string> unit::checking_tags_ {"attacks", "damage", "chance_to_hit", "berserk", "swarm", "drains", "heal_on_hit", "plague", "slow", "petrifies", "firststrike", "poison"}

private

Definition at line 1778 of file unit.hpp.

description_

t_string unit::description_

private

Definition at line 1955 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), and unit::write().

ellipse_

std::optional<std::string> unit::ellipse_

private

Definition at line 1960 of file unit.hpp.

Referenced by unit::advance_to(), and unit::write().

emit_zoc_

bool unit::emit_zoc_

private

Definition at line 1919 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::swap(), and unit::write().

end_turn_

bool unit::end_turn_

private

Definition at line 1902 of file unit.hpp.

Referenced by unit::new_turn(), unit::set_movement(), and unit::swap().

events_

config unit::events_

private

Definition at line 1916 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

experience_

int unit::experience_

private

Definition at line 1873 of file unit.hpp.

Referenced by unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

facing_

map_location::DIRECTION unit::facing_

mutableprotected

Definition at line 1929 of file unit.hpp.

Referenced by unit::init(), unit::set_facing(), unit_animation_component::start_animation(), unit::swap(), and unit::write().

filter_recall_

config unit::filter_recall_

private

Definition at line 1917 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

flag_rgb_

std::string unit::flag_rgb_

private

Definition at line 1883 of file unit.hpp.

Referenced by unit::advance_to(), unit::flag_rgb(), unit::swap(), and unit::write().

formula_man_

std::unique_ptr<unit_formula_manager> unit::formula_man_

private

Definition at line 1892 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

gender_

unit_race::GENDER unit::gender_

private

Definition at line 1890 of file unit.hpp.

Referenced by unit::add_trait_description(), unit::advance_to(), unit::apply_builtin_effect(), unit::generate_name(), unit::init(), unit::swap(), and unit::write().

generate_name_

bool unit::generate_name_

private

Definition at line 1963 of file unit.hpp.

Referenced by unit::advance_to(), unit::generate_name(), unit::init(), and unit::write().

goto_

map_location unit::goto_

private

Definition at line 1936 of file unit.hpp.

Referenced by unit::init(), unit::new_scenario(), unit::swap(), and unit::write().

halo_

std::optional<std::string> unit::halo_

private

Definition at line 1959 of file unit.hpp.

Referenced by unit::write().

hidden_

bool unit::hidden_

mutableprivate

Definition at line 1947 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

hit_points_

int unit::hit_points_

private

Definition at line 1871 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::expire_modifications(), unit::heal(), unit::init(), unit::swap(), and unit::write().

hold_position_

bool unit::hold_position_

private

Definition at line 1901 of file unit.hpp.

Referenced by unit::new_turn(), unit::set_movement(), and unit::swap().

hp_bar_scaling_

double unit::hp_bar_scaling_

private

Definition at line 1948 of file unit.hpp.

Referenced by unit::advance_to(), and unit::init().

id_

std::string unit::id_

private

Definition at line 1864 of file unit.hpp.

Referenced by unit::init(), unit::mark_clone(), unit::set_underlying_id(), unit::swap(), and unit::write().

image_mods_

std::string unit::image_mods_

private

Definition at line 1884 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), and unit::swap().

interrupted_move_

map_location unit::interrupted_move_

private

Definition at line 1936 of file unit.hpp.

Referenced by unit::swap().

invisibility_cache_

std::map<map_location, bool> unit::invisibility_cache_

mutableprivate

Hold the visibility status cache for a unit, when not uncovered.

This is mutable since it is a cache.

Definition at line 1981 of file unit.hpp.

Referenced by unit::invisible(), unit::swap(), and unit::unit().

is_fearless_

bool unit::is_fearless_

private

Definition at line 1938 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), and unit::swap().

is_healthy_

bool unit::is_healthy_

private

Definition at line 1938 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), and unit::swap().

jamming_

int unit::jamming_

private

Definition at line 1897 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

known_boolean_state_names_

std::map< std::string, unit::state_t > unit::known_boolean_state_names_

staticprivate

Initial value:

{
    {"slowed",     STATE_SLOWED},
    {"poisoned",   STATE_POISONED},
    {"petrified",  STATE_PETRIFIED},
    {"uncovered",  STATE_UNCOVERED},
    {"not_moved",  STATE_NOT_MOVED},
    {"unhealable", STATE_UNHEALABLE},
    {"guardian",   STATE_GUARDIAN},
}

Definition at line 1913 of file unit.hpp.

Referenced by unit::get_known_boolean_state_id(), and unit::get_states().

known_boolean_states_

std::bitset<num_bool_states> unit::known_boolean_states_

private

Definition at line 1912 of file unit.hpp.

Referenced by unit::get_state(), unit::set_state(), and unit::swap().

level_

int unit::level_

private

Definition at line 1876 of file unit.hpp.

Referenced by unit::add_modification(), unit::advance_to(), unit::init(), unit::swap(), and unit::write().

loc_

map_location unit::loc_

private

Definition at line 1851 of file unit.hpp.

Referenced by unit::add_modification(), unit::get_modification_advances(), unit::init(), unit_animation_component::invalidate(), unit_animation_component::refresh(), unit_animation_component::set_disabled_ghosted(), unit_animation_component::set_ghosted(), unit_animation_component::set_idling(), unit_animation_component::set_selecting(), unit_animation_component::set_standing(), unit_animation_component::start_animation(), and unit::swap().

max_attacks_

int unit::max_attacks_

private

Definition at line 1906 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::new_turn(), unit::swap(), and unit::write().

max_experience_

int unit::max_experience_

private

Definition at line 1874 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

max_hit_points_

int unit::max_hit_points_

private

Definition at line 1872 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

max_movement_

int unit::max_movement_

private

Definition at line 1895 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::expire_modifications(), unit::init(), unit::swap(), and unit::write().

modification_descriptions_

utils::string_map unit::modification_descriptions_

private

Definition at line 1940 of file unit.hpp.

Referenced by unit::advance_to(), and unit::swap().

modifications_

config unit::modifications_

private

Definition at line 1950 of file unit.hpp.

Referenced by unit::add_modification(), unit::apply_modifications(), unit::expire_modifications(), unit::generate_traits(), unit::get_traits_list(), unit::init(), unit::modification_count(), unit::swap(), and unit::write().

movement_

int unit::movement_

private

Definition at line 1894 of file unit.hpp.

Referenced by unit::apply_builtin_effect(), unit::end_turn(), unit::expire_modifications(), unit::init(), unit::new_turn(), unit::set_movement(), unit::swap(), and unit::write().

movement_type_

movetype unit::movement_type_

private

Definition at line 1899 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::defense_modifier(), unit::init(), unit::resistance_against(), unit::swap(), and unit::write().

moves_

int unit_movement_resetter::moves_

private

Definition at line 2014 of file unit.hpp.

Referenced by unit_movement_resetter::~unit_movement_resetter().

name_

t_string unit::name_

private

Definition at line 1865 of file unit.hpp.

Referenced by unit::generate_name(), unit::init(), unit::swap(), and unit::write().

num_bool_states

const std::size_t unit::num_bool_states = 7

staticprivate

Definition at line 1910 of file unit.hpp.

overlays_

std::vector<std::string> unit::overlays_

private

Definition at line 1921 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), and unit::swap().

profile_

std::string unit::profile_

private

Definition at line 1967 of file unit.hpp.

Referenced by unit::advance_to(), unit::big_profile(), unit::set_big_profile(), unit::small_profile(), and unit::write().

race_

const unit_race* unit::race_

private

Never nullptr, but may point to the null race.

Definition at line 1862 of file unit.hpp.

Referenced by unit::advance_to(), unit::generate_name(), unit::init(), unit::swap(), and unit::write().

random_traits_

bool unit::random_traits_

private

Definition at line 1962 of file unit.hpp.

Referenced by unit::advance_to(), unit::generate_traits(), unit::init(), and unit::write().

recall_cost_

int unit::recall_cost_

private

Definition at line 1878 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

recruit_list_

std::vector<std::string> unit::recruit_list_

private

Definition at line 1880 of file unit.hpp.

Referenced by unit::set_recruits(), unit::swap(), and unit::write().

resting_

bool unit::resting_

private

Definition at line 1903 of file unit.hpp.

Referenced by unit::end_turn(), unit::init(), unit::swap(), and unit::write().

role_

std::string unit::role_

private

Definition at line 1923 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

side_

int unit::side_

private

Definition at line 1888 of file unit.hpp.

Referenced by unit::apply_builtin_effect(), unit::init(), unit::invisible(), unit::swap(), and unit::write().

small_profile_

std::string unit::small_profile_

private

Definition at line 1968 of file unit.hpp.

Referenced by unit::advance_to(), unit::small_profile(), and unit::write().

special_notes_

std::vector<t_string> unit::special_notes_

private

Definition at line 1956 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), and unit::write().

states_

std::set<std::string> unit::states_

private

Definition at line 1908 of file unit.hpp.

Referenced by unit::get_state(), unit::get_states(), unit::set_state(), and unit::swap().

trait_descriptions_

std::vector<t_string> unit::trait_descriptions_

private

Definition at line 1933 of file unit.hpp.

Referenced by unit::add_trait_description(), unit::advance_to(), and unit::swap().

trait_names_

std::vector<t_string> unit::trait_names_

private

Definition at line 1932 of file unit.hpp.

Referenced by unit::add_trait_description(), unit::advance_to(), and unit::swap().

type_

const unit_type* unit::type_

private

Never nullptr.

Adjusted for gender and variation.

Definition at line 1856 of file unit.hpp.

Referenced by unit::advance_to(), unit::init(), unit::swap(), and unit::type_id().

type_name_

t_string unit::type_name_

private

The displayed name of this unit type.

Definition at line 1859 of file unit.hpp.

Referenced by unit::advance_to(), unit::swap(), and unit::write().

u_ [1/2]

const unit& unit::upkeep_value_visitor::u_

private

Definition at line 1167 of file unit.hpp.

u_ [2/2]

unit& unit_movement_resetter::u_

private

Definition at line 2013 of file unit.hpp.

Referenced by unit_movement_resetter::unit_movement_resetter(), and unit_movement_resetter::~unit_movement_resetter().

undead_variation_

std::string unit::undead_variation_

private

Definition at line 1868 of file unit.hpp.

Referenced by unit::advance_to(), unit::swap(), and unit::write().

underlying_id_

n_unit::unit_id unit::underlying_id_

private

Definition at line 1866 of file unit.hpp.

Referenced by unit::init(), unit::is_visible_to_team(), unit::mark_clone(), unit::set_underlying_id(), unit::swap(), and unit::write().

unit_value_

int unit::unit_value_

private

Definition at line 1935 of file unit.hpp.

Referenced by unit::advance_to(), unit::init(), unit::swap(), and unit::write().

unrenamable_

bool unit::unrenamable_

private

Definition at line 1886 of file unit.hpp.

Referenced by unit::init(), unit::swap(), and unit::write().

upkeep_

upkeep_t unit::upkeep_

private

Definition at line 1965 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::loyal(), and unit::upkeep().

usage_

std::optional<std::string> unit::usage_

private

Definition at line 1958 of file unit.hpp.

Referenced by unit::write().

variables_

config unit::variables_

private

Definition at line 1915 of file unit.hpp.

Referenced by unit::apply_modifications(), unit::init(), unit::swap(), and unit::write().

variation_

std::string unit::variation_

private

Definition at line 1869 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

vision_

int unit::vision_

private

Definition at line 1896 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::swap(), and unit::write().

xp_bar_scaling_

double unit::xp_bar_scaling_

private

Definition at line 1948 of file unit.hpp.

Referenced by unit::advance_to(), and unit::init().

Friends

unit_animation_component

friend class unit_animation_component

friend

Definition at line 1943 of file unit.hpp.