Ability functions

Enumerations
enum class	backwards_compatibility::unit_checksum_version { backwards_compatibility::current , backwards_compatibility::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...
active_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...
active_ability_list	unit::get_abilities (const std::string &tag_name) const
	Gets the unit's active abilities of a particular type. More...
active_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
active_ability_list	unit::get_abilities_weapons (const std::string &tag_name, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
config	unit::abilities_cfg () const
const ability_vector &	unit::abilities () const
ability_vector	unit::abilities (const std::string &tag) const
std::vector< unit_ability_t::tooltip_info >	unit::ability_tooltips () const
	Gets the names and descriptions of this unit's abilities. More...
std::vector< unit_ability_t::tooltip_info >	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_id_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...
void	unit::remove_ability_by_attribute (const config &filter)
	Removes a unit's abilities with a specific ID or other attribute. More...
bool	unit::ability_active (const unit_ability_t &ab, const map_location &loc) const
	Check if an ability is active. More...
bool	unit::ability_active_impl (const unit_ability_t &ab, const map_location &loc) const
	Check if an ability is active. More...
bool	unit::ability_affects_adjacent (const unit_ability_t &ab, std::size_t dist, int dir, const map_location &loc, const unit &from) const
	Check if an ability affects distant units. More...
bool	unit::ability_affects_self (const unit_ability_t &ab, const map_location &loc) const
	Check if an ability affects the owning unit. More...
bool	unit::ability_affects_weapon (const unit_ability_t &ab, const 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...
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
bool	unit::favorite () const
void	unit::set_favorite (bool favorite)
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...
void	unit::set_has_ability_distant ()
	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_
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::set< std::string >	unit::recruit_list_
unit_alignments::type	unit::alignment_
std::string	unit::flag_rgb_
std::string	unit::image_mods_
bool	unit::unrenamable_
bool	unit::dismissable_
t_string	unit::dismiss_message_
int	unit::side_
unit_race::GENDER	unit::gender_
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 = state_t::NUMBER_OF_STATES
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_
std::vector< std::string >	unit::trait_nonhidden_ids_
int	unit::unit_value_
map_location	unit::goto_
map_location	unit::interrupted_move_
bool	unit::is_fearless_
bool	unit::is_healthy_
bool	unit::is_favorite_
utils::string_map	unit::modification_descriptions_
std::unique_ptr< unit_animation_component >	unit::anim_comp_
bool	unit::hidden_
config	unit::modifications_
ability_vector	unit::abilities_
std::vector< config >	unit::advancements_
t_string	unit::description_
std::vector< t_string >	unit::special_notes_
utils::optional< std::string >	unit::usage_
utils::optional< std::string >	unit::halo_
utils::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...
std::map< std::string, std::size_t >	unit::max_ability_radius_type_
	Used for easing checking if unit own a ability of specified type with [affect_adjacent] sub tag. More...
std::size_t	unit::max_ability_radius_
	Used for easing checking if unit own a ability with [affect_adjacent] sub tag. More...
std::size_t	unit::max_ability_radius_image_
	used if ability own halo_image or overlay_image attributes in same time what [affect_adjacent]. 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 unit_ability_t &ab, const map_location &loc) const
	Checks whether this unit currently possesses a given ability, and that that ability is active. More...
bool	unit::get_adj_ability_bool (const unit_ability_t &ab, std::size_t dist, int dir, const map_location &loc, const unit &from, const map_location &from_loc) const
	Checks whether this unit is affected by a given ability, and that that ability is active. 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 2042 of file unit.hpp.

Function Documentation

abilities() [1/2]

const ability_vector& unit::abilities ( ) const

inline

Definition at line 1715 of file unit.hpp.

References unit::abilities_.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit_filter_impl::unit_filter_compound::fill(), unit::init(), and unit::set_has_ability_distant().

abilities() [2/2]

ability_vector unit::abilities ( const std::string &  tag ) const

inline

Definition at line 1719 of file unit.hpp.

References unit::abilities_, unit_ability_t::filter_tag(), and markup::tag().

abilities_cfg()

config unit::abilities_cfg ( ) const

inline

Definition at line 1710 of file unit.hpp.

References unit::abilities_, and unit_ability_t::vector_to_cfg().

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

ability_active()

bool unit::ability_active ( const unit_ability_t &  ab, const map_location &  loc  ) const

private

Check if an ability is active.

Includes checks to prevent excessive recursion.

Parameters

ab	the ability checked
loc	The location on which to resolve the ability

Returns

true if it is active

Definition at line 724 of file abilities.cpp.

References unit_ability_t::guard_against_recursion(), and loc.

ability_active_impl()

bool unit::ability_active_impl ( const unit_ability_t &  ab, const map_location &  loc  ) const

private

Check if an ability is active.

The caller is responsible for preventing excessive recursion, so must hold a recursion_guard.

Parameters

ab	the ability checked
loc	The location on which to resolve the ability

Returns

true if it is active

Definition at line 733 of file abilities.cpp.

References unit_ability_t::cfg(), loc, config::optional_child(), and unit_ability_t::tag().

Referenced by unit::get_adj_ability_bool().

ability_affects_adjacent()

bool unit::ability_affects_adjacent ( const unit_ability_t &  ab, std::size_t  dist, int  dir, const map_location &  loc, const unit &  from  ) const

private

Check if an ability affects distant units.

Parameters

ab	the ability checked
loc	The location on which to resolve the ability
from	The "other unit" for filter matching
dist	distance between unit distant and this.
dir	direction to research a unit distant to this.

Definition at line 746 of file abilities.cpp.

References unit_ability_t::cfg(), config::child_range(), utils::contains(), utils::views::filter, config::has_child(), i, loc, map_location::parse_directions(), and unit_ability_t::tag().

ability_affects_self()

bool unit::ability_affects_self ( const unit_ability_t &  ab, const map_location &  loc  ) const

private

Check if an ability affects the owning unit.

Parameters

ab	the ability checked
loc	The location on which to resolve the ability

Definition at line 781 of file abilities.cpp.

References unit_ability_t::affects_self(), unit_ability_t::cfg(), utils::views::filter, loc, unit_filter::matches(), config::optional_child(), unit_filter::set_use_flat_tod(), and unit_ability_t::tag().

ability_affects_weapon()

bool unit::ability_affects_weapon ( const unit_ability_t &  ab, const 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)

ability_tooltips() [1/2]

std::vector< unit_ability_t::tooltip_info > 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 695 of file abilities.cpp.

Referenced by gui2::unit_preview_pane::set_display_data(), and unit_abilities_report().

ability_tooltips() [2/2]

std::vector< unit_ability_t::tooltip_info > 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 707 of file abilities.cpp.

References loc.

appearance_changed()

bool unit::appearance_changed ( ) const

inline

Definition at line 1842 of file unit.hpp.

References unit::appearance_changed_.

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 1995 of file unit.hpp.

References unit::invisibility_cache_.

favorite()

bool unit::favorite ( ) const

inline

Definition at line 1941 of file unit.hpp.

References unit::is_favorite_.

Referenced by gui2::dialogs::units_dialog::build_recall_dialog(), gui2::dialogs::units_dialog::build_unit_list_dialog(), unit::set_favorite(), and gui2::dialogs::units_dialog::toggle_favorite().

generate_name()

void unit::generate_name

(

)

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

Definition at line 832 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]

active_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 1698 of file unit.hpp.

References unit::get_abilities(), and unit::loc_.

get_abilities() [2/2]

active_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 634 of file abilities.cpp.

References active_ability_list::emplace_back(), and loc.

Referenced by unit::defense_modifier(), unit_filter_impl::unit_filter_compound::fill(), unit::get_abilities(), pathfind::get_teleport_locations(), unit_display::reset_helpers(), and unit::resistance_against().

get_abilities_weapons() [1/2]

active_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 647 of file abilities.cpp.

References utils::erase_if(), i, loc, unit_ability_t::SELF, and attack_type::special_active_impl().

Referenced by unit::get_abilities_weapons(), under_leadership(), and unit_display::unit_attack().

get_abilities_weapons() [2/2]

active_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 1705 of file unit.hpp.

References unit::get_abilities_weapons(), and unit::loc_.

get_ability_bool() [1/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 1663 of file unit.hpp.

References unit::get_ability_bool(), and unit::loc_.

get_ability_bool() [2/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 623 of file abilities.cpp.

References loc.

Referenced by pathfind::shortest_path_calculator::cost(), ai::ai_default_rca::get_healing_phase::evaluate(), pathfind::find_routes(), unit::get_ability_bool(), 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_id_list()

std::vector< std::string > unit::get_ability_id_list

(

)

const

Get a list of all abilities by ID.

Definition at line 657 of file abilities.cpp.

Referenced by wfl::unit_callable::get_value(), gui2::unit_preview_pane::set_display_data(), and UNIT_GETTER().

get_adj_ability_bool()

bool unit::get_adj_ability_bool	(	const unit_ability_t &	ab,
		std::size_t	dist,
		int	dir,
		const map_location &	loc,
		const unit &	from,
		const map_location &	from_loc
	)		const

Checks whether this unit is affected by a given ability, and that that ability is active.

Returns

True if the ability tag_name is active.

Parameters

ab	the ability checked
loc	location of the unit checked.
from	unit distant to this is checked in case of [affect_adjacent] abilities.
from_loc	the 'other unit' location.
dist	distance between unit distant and this.
dir	direction to research a unit distant to this.

Definition at line 1600 of file abilities.cpp.

References unit::ability_active_impl(), unit_ability_t::guard_against_recursion(), loc, and unit::side().

Referenced by unit_filter_impl::unit_filter_compound::fill().

get_self_ability_bool()

bool unit::get_self_ability_bool	(	const unit_ability_t &	ab,
		const map_location &	loc
	)		const

Checks whether this unit currently possesses a given ability, and that that ability is active.

Returns

True if the ability tag_name is active.

Parameters

ab	the ability checked
loc	location of the unit checked.

Definition at line 1591 of file abilities.cpp.

References unit_ability_t::guard_against_recursion(), and loc.

Referenced by unit_filter_impl::unit_filter_compound::fill().

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 1507 of file unit.cpp.

References unit::abilities_.

Referenced by unit::apply_builtin_effect(), and unit_filter_impl::unit_filter_compound::fill().

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 789 of file abilities.cpp.

Referenced by unit_filter_impl::unit_filter_compound::fill().

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 2619 of file unit.cpp.

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

Referenced by gui2::dialogs::units_dialog::build_unit_list_dialog(), unit::is_visible_to_team(), pathfind::mark_route(), unit_drawer::redraw_unit(), and unit_status().

is_visible_to_team() [1/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 2668 of file unit.cpp.

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

is_visible_to_team() [2/2]

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

Definition at line 2662 of file unit.cpp.

References unit::get_location(), and loc.

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

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 2720 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]

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 1144 of file unit.hpp.

References b.

operator()() [2/9]

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

inline

Definition at line 1154 of file unit.hpp.

References s.

operator()() [3/9]

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

inline

Full upkeep equals the unit's level.

Definition at line 1086 of file unit.hpp.

References unit::level(), and unit::upkeep_value_visitor::u_.

operator()() [4/9]

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

inline

Loyal units cost no upkeep.

Definition at line 1092 of file unit.hpp.

operator()() [5/9]

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

inline

Definition at line 1097 of file unit.hpp.

operator()() [6/9]

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

inline

Definition at line 1120 of file unit.hpp.

operator()() [7/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 1135 of file unit.hpp.

References n.

operator()() [8/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 1114 of file unit.hpp.

operator()() [9/9]

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

inline

Definition at line 1149 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 2845 of file unit.cpp.

References e, unit::upkeep(), unit::upkeep_, and WRN_UT.

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

remove_ability_by_attribute()

void unit::remove_ability_by_attribute

(

const config &

filter

)

Removes a unit's abilities with a specific ID or other attribute.

Parameters

filter

the config of ability to remove.

Definition at line 1531 of file unit.cpp.

References unit::abilities_, utils::views::filter, i, unit::set_attr_changed(), and unit::UA_ABILITIES.

Referenced by unit::apply_builtin_effect().

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 1518 of file unit.cpp.

References unit::abilities_, i, 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 1841 of file unit.hpp.

References unit::appearance_changed_.

set_favorite()

void unit::set_favorite ( bool  favorite )

inline

Definition at line 1943 of file unit.hpp.

References unit::favorite(), and unit::is_favorite_.

Referenced by gui2::dialogs::units_dialog::toggle_favorite().

set_has_ability_distant()

void unit::set_has_ability_distant ( )

private

Definition at line 418 of file unit.cpp.

References unit::abilities(), i, unit::max_ability_radius_, unit::max_ability_radius_image_, and unit::max_ability_radius_type_.

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

type() [1/2]

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

inlinestatic

Definition at line 1066 of file unit.hpp.

type() [2/2]

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

inlinestatic

Definition at line 1071 of file unit.hpp.

Referenced by unit::apply_builtin_effect().

unit_movement_resetter() [1/2]

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

Definition at line 2745 of file unit.cpp.

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

unit_movement_resetter() [2/2]

unit_movement_resetter::unit_movement_resetter ( const unit_movement_resetter &  )

delete

upkeep_value_visitor()

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

inlineexplicit

Definition at line 1083 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 1555 of file unit.cpp.

References unit::abilities_cfg(), config::add_child(), unit::advancements_, unit::advances_to_, unit::alignment_, config::append(), unit::attacks_, unit::attacks_left_, unit::can_recruit(), cfg, config::clear_children(), unit::description_, unit::dismiss_message_, unit::dismissable_, unit::ellipse_, unit::emit_zoc_, unit::events_, unit::experience_, unit::facing_, unit::filter_recall_, unit::flag_rgb_, 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::is_favorite_, 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_type::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 get_checksum(), and UNIT_GETTER().

write_upkeep()

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

private

Definition at line 2859 of file unit.cpp.

References unit::upkeep(), and unit::upkeep_.

Referenced by unit::write().

~unit_movement_resetter()

unit_movement_resetter::~unit_movement_resetter

(

)

Definition at line 2754 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_

ability_vector unit::abilities_

private

Definition at line 1957 of file unit.hpp.

Referenced by unit::abilities(), unit::abilities_cfg(), unit::advance_to(), unit::apply_builtin_effect(), unit::has_ability_by_id(), unit::init(), unit::remove_ability_by_attribute(), unit::remove_ability_by_id(), and unit::unit().

advancements_

std::vector<config> unit::advancements_

private

Definition at line 1959 of file unit.hpp.

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

advances_to_

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

private

Definition at line 1849 of file unit.hpp.

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

alignment_

unit_alignments::type unit::alignment_

private

Definition at line 1877 of file unit.hpp.

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

anim_comp_

std::unique_ptr<unit_animation_component> unit::anim_comp_

private

Definition at line 1952 of file unit.hpp.

Referenced by unit::advance_to(), unit::anim_comp(), unit::apply_builtin_effect(), unit::expire_modifications(), unit::init(), unit::set_hidden(), unit::set_image_halo(), and unit::~unit().

appearance_changed_

bool unit::appearance_changed_ = true

mutableprivate

Definition at line 1977 of file unit.hpp.

Referenced by unit::advance_to(), unit::appearance_changed(), unit::apply_builtin_effect(), unit::set_appearance_changed(), unit::set_facing(), unit::set_image_ellipse(), unit::set_image_halo(), and unit::set_state().

attacks_

attack_list unit::attacks_

private

Definition at line 1920 of file unit.hpp.

Referenced by unit::add_attack(), unit::advance_to(), unit::apply_builtin_effect(), unit::attacks(), unit::clear_changed_attributes(), unit::describe_builtin_effect(), unit::get_attacks_changed(), unit::init(), unit::remove_attack(), unit::unit(), and unit::write().

attacks_left_

int unit::attacks_left_

private

Definition at line 1901 of file unit.hpp.

Referenced by unit::attacks_left(), unit::init(), unit::new_turn(), unit::remove_attacks_ai(), unit::set_attacks(), and unit::write().

canrecruit_

bool unit::canrecruit_

private

Definition at line 1875 of file unit.hpp.

Referenced by unit::can_recruit(), unit::init(), and unit::set_can_recruit().

changed_attributes_

std::bitset<UA_COUNT> unit::changed_attributes_

private

Definition at line 1978 of file unit.hpp.

Referenced by unit::clear_changed_attributes(), unit::get_attr_changed(), and unit::set_attr_changed().

description_

t_string unit::description_

private

Definition at line 1961 of file unit.hpp.

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

dismiss_message_

t_string unit::dismiss_message_

private

Definition at line 1884 of file unit.hpp.

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

dismissable_

bool unit::dismissable_

private

Definition at line 1883 of file unit.hpp.

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

ellipse_

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

private

Definition at line 1966 of file unit.hpp.

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

emit_zoc_

bool unit::emit_zoc_

private

Definition at line 1915 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::emits_zoc(), unit::get_emit_zoc(), unit::set_emit_zoc(), and unit::write().

end_turn_

bool unit::end_turn_

private

Definition at line 1898 of file unit.hpp.

Referenced by unit::new_turn(), unit::set_movement(), unit::set_user_end_turn(), unit::toggle_hold_position(), unit::toggle_user_end_turn(), and unit::user_end_turn().

events_

config unit::events_

private

Definition at line 1912 of file unit.hpp.

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

experience_

int unit::experience_

private

Definition at line 1869 of file unit.hpp.

Referenced by unit::advances(), unit::apply_builtin_effect(), unit::experience(), unit::experience_overflow(), unit::experience_to_advance(), unit::init(), unit::set_experience(), and unit::write().

facing_

map_location::direction unit::facing_

mutableprotected

Definition at line 1925 of file unit.hpp.

Referenced by unit::facing(), unit::init(), unit::set_facing(), and unit::write().

filter_recall_

config unit::filter_recall_

private

Definition at line 1913 of file unit.hpp.

Referenced by unit::init(), unit::recall_filter(), unit::set_recall_filter(), and unit::write().

flag_rgb_

std::string unit::flag_rgb_

private

Definition at line 1879 of file unit.hpp.

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

gender_

unit_race::GENDER unit::gender_

private

Definition at line 1888 of file unit.hpp.

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

generate_name_

bool unit::generate_name_

private

Definition at line 1969 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 1933 of file unit.hpp.

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

halo_

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

private

Definition at line 1965 of file unit.hpp.

Referenced by unit::image_halo(), unit::set_image_halo(), and unit::write().

hidden_

bool unit::hidden_

mutableprivate

Definition at line 1954 of file unit.hpp.

Referenced by unit::get_hidden(), unit::init(), unit::set_hidden(), and unit::write().

hit_points_

int unit::hit_points_

private

Definition at line 1867 of file unit.hpp.

Referenced by unit::apply_builtin_effect(), unit::heal(), unit::heal_fully(), unit::hitpoints(), unit::init(), unit::set_hitpoints(), unit::take_hit(), and unit::write().

hold_position_

bool unit::hold_position_

private

Definition at line 1897 of file unit.hpp.

Referenced by unit::hold_position(), unit::new_turn(), unit::set_movement(), unit::toggle_hold_position(), and unit::toggle_user_end_turn().

id_

std::string unit::id_

private

Definition at line 1860 of file unit.hpp.

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

image_mods_

std::string unit::image_mods_

private

Definition at line 1880 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::effect_image_mods(), and unit::image_mods().

interrupted_move_

map_location unit::interrupted_move_

private

Definition at line 1933 of file unit.hpp.

Referenced by unit::get_interrupted_move(), unit::move_interrupted(), and unit::set_interrupted_move().

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 1987 of file unit.hpp.

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

is_favorite_

bool unit::is_favorite_

private

Definition at line 1938 of file unit.hpp.

Referenced by unit::favorite(), unit::init(), unit::set_favorite(), and unit::write().

is_fearless_

bool unit::is_fearless_

private

Definition at line 1935 of file unit.hpp.

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

is_healthy_

bool unit::is_healthy_

private

Definition at line 1935 of file unit.hpp.

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

jamming_

int unit::jamming_

private

Definition at line 1893 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::jamming(), 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},
    {"invulnerable", STATE_INVULNERABLE},
}

Definition at line 1909 of file unit.hpp.

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

known_boolean_states_

std::bitset<num_bool_states> unit::known_boolean_states_

private

Definition at line 1908 of file unit.hpp.

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

level_

int unit::level_

private

Definition at line 1872 of file unit.hpp.

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

loc_

map_location unit::loc_

private

Definition at line 1847 of file unit.hpp.

Referenced by unit::add_modification(), unit::defense_modifier(), unit::get_abilities(), unit::get_abilities_weapons(), unit::get_ability_bool(), unit::get_location(), unit::get_modification_advances(), unit::init(), and unit::set_location().

max_ability_radius_

std::size_t unit::max_ability_radius_

private

Used for easing checking if unit own a ability with [affect_adjacent] sub tag.

Definition at line 2009 of file unit.hpp.

Referenced by unit::max_ability_radius(), and unit::set_has_ability_distant().

max_ability_radius_image_

std::size_t unit::max_ability_radius_image_

private

used if ability own halo_image or overlay_image attributes in same time what [affect_adjacent].

Definition at line 2013 of file unit.hpp.

Referenced by unit::max_ability_radius_image(), and unit::set_has_ability_distant().

max_ability_radius_type_

std::map<std::string, std::size_t> unit::max_ability_radius_type_

private

Used for easing checking if unit own a ability of specified type with [affect_adjacent] sub tag.

Definition at line 2004 of file unit.hpp.

Referenced by unit::max_ability_radius_type(), unit::set_has_ability_distant(), and unit::unit().

max_attacks_

int unit::max_attacks_

private

Definition at line 1902 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::max_attacks(), unit::new_turn(), unit::remove_attacks_ai(), unit::set_max_attacks(), and unit::write().

max_experience_

int unit::max_experience_

private

Definition at line 1870 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::experience_overflow(), unit::experience_to_advance(), unit::init(), unit::max_experience(), unit::set_max_experience(), and unit::write().

max_hit_points_

int unit::max_hit_points_

private

Definition at line 1868 of file unit.hpp.

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

max_movement_

int unit::max_movement_

private

Definition at line 1891 of file unit.hpp.

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

modification_descriptions_

utils::string_map unit::modification_descriptions_

private

Definition at line 1947 of file unit.hpp.

Referenced by unit::advance_to().

modifications_

config unit::modifications_

private

Definition at line 1956 of file unit.hpp.

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

movement_

int unit::movement_

private

Definition at line 1890 of file unit.hpp.

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

movement_type_

movetype unit::movement_type_

private

Definition at line 1895 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::defense_modifier(), unit::get_base_resistances(), unit::init(), unit::is_flying(), unit::jamming_cost(), unit::movement_cost(), unit::movement_type(), unit::resistance_value(), unit::vision_cost(), and unit::write().

moves_

int unit_movement_resetter::moves_

private

Definition at line 2033 of file unit.hpp.

Referenced by unit_movement_resetter::~unit_movement_resetter().

name_

t_string unit::name_

private

Definition at line 1861 of file unit.hpp.

Referenced by unit::generate_name(), unit::init(), unit::name(), unit::rename(), unit::set_name(), and unit::write().

num_bool_states

const std::size_t unit::num_bool_states = state_t::NUMBER_OF_STATES

staticprivate

Definition at line 1906 of file unit.hpp.

overlays_

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

private

Definition at line 1917 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::overlays(), and unit::set_loyal().

profile_

std::string unit::profile_

private

Definition at line 1973 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 1858 of file unit.hpp.

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

random_traits_

bool unit::random_traits_

private

Definition at line 1968 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 1874 of file unit.hpp.

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

recruit_list_

std::set<std::string> unit::recruit_list_

private

Definition at line 1876 of file unit.hpp.

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

resting_

bool unit::resting_

private

Definition at line 1899 of file unit.hpp.

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

role_

std::string unit::role_

private

Definition at line 1919 of file unit.hpp.

Referenced by unit::get_role(), unit::init(), unit::set_role(), and unit::write().

side_

int unit::side_

private

Definition at line 1886 of file unit.hpp.

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

small_profile_

std::string unit::small_profile_

private

Definition at line 1974 of file unit.hpp.

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

special_notes_

std::vector<t_string> unit::special_notes_

private

Definition at line 1962 of file unit.hpp.

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

states_

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

private

Definition at line 1904 of file unit.hpp.

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

trait_descriptions_

std::vector<t_string> unit::trait_descriptions_

private

Definition at line 1929 of file unit.hpp.

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

trait_names_

std::vector<t_string> unit::trait_names_

private

Definition at line 1928 of file unit.hpp.

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

trait_nonhidden_ids_

std::vector<std::string> unit::trait_nonhidden_ids_

private

Definition at line 1930 of file unit.hpp.

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

type_

const unit_type* unit::type_

private

Never nullptr.

Adjusted for gender and variation.

Definition at line 1852 of file unit.hpp.

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

type_name_

t_string unit::type_name_

private

The displayed name of this unit type.

Definition at line 1855 of file unit.hpp.

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

u_ [1/2]

const unit& unit::upkeep_value_visitor::u_

private

Definition at line 1103 of file unit.hpp.

Referenced by unit::upkeep_value_visitor::operator()().

u_ [2/2]

unit& unit_movement_resetter::u_

private

Definition at line 2032 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 1864 of file unit.hpp.

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

underlying_id_

n_unit::unit_id unit::underlying_id_

private

Definition at line 1862 of file unit.hpp.

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

unit_value_

int unit::unit_value_

private

Definition at line 1932 of file unit.hpp.

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

unrenamable_

bool unit::unrenamable_

private

Definition at line 1882 of file unit.hpp.

Referenced by unit::init(), unit::rename(), unit::set_unrenamable(), unit::unrenamable(), and unit::write().

upkeep_

upkeep_t unit::upkeep_

private

Definition at line 1971 of file unit.hpp.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), unit::init(), unit::loyal(), unit::parse_upkeep(), unit::set_loyal(), unit::set_upkeep(), unit::upkeep(), unit::upkeep_raw(), and unit::write_upkeep().

usage_

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

private

Definition at line 1964 of file unit.hpp.

Referenced by unit::set_usage(), unit::usage(), and unit::write().

variables_

config unit::variables_

private

Definition at line 1911 of file unit.hpp.

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

variation_

std::string unit::variation_

private

Definition at line 1865 of file unit.hpp.

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

vision_

int unit::vision_

private

Definition at line 1892 of file unit.hpp.

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

Friends

unit_animation_component

friend class unit_animation_component

friend

Definition at line 1950 of file unit.hpp.