A single unit type that the player may recruit. More...

#include <types.hpp>

Classes
struct	ability_metadata

struct	defaut_ctor_t

Public Types
enum	BUILD_STATUS { NOT_BUILT , CREATED , VARIATIONS , HELP_INDEXED , FULL }
	Records the status of the lazy building of unit types. More...

using	error = unit_type_error

Public Member Functions
	unit_type (const config &cfg, const std::string &parent_id="")
	Creates a unit type for the given config, but delays its build till later. More...

	unit_type (config &&cfg, const std::string &parent_id="")
	Creates a unit type for the given config, but delays its build till later. More...

	unit_type ()

	unit_type (const unit_type &o)

	unit_type (unit_type &&o)=default

	~unit_type ()

void	build (BUILD_STATUS status, const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
	Performs a build of this to the indicated stage. More...

void	build (BUILD_STATUS status, const movement_type_map &movement_types, const race_map &races, const config_array_view &traits) const
	Performs a build of this to the indicated stage. More...

std::set< std::string >	advancement_tree () const
	Get the advancement tree. More...

const std::vector< std::string > &	advances_to () const
	A vector of unit_type ids that this unit_type can advance to. More...

const std::vector< std::string >	advances_from () const
	A vector of unit_type ids that can advance to this unit_type. More...

config::const_child_itors	modification_advancements () const
	Returns two iterators pointing to a range of AMLA configs. More...

const unit_type &	get_gender_unit_type (std::string gender) const
	Returns a gendered variant of this unit_type. More...

const unit_type &	get_gender_unit_type (unit_race::GENDER gender) const
	Returns a gendered variant of this unit_type based on the given parameter. More...

const unit_type &	get_variation (const std::string &id) const

const std::string &	undead_variation () const
	Info on the type of unit that the unit reanimates as. More...

unsigned int	num_traits () const

const t_string &	type_name () const
	The name of the unit in the current language setting. More...

const std::string &	id () const
	The id for this unit_type. More...

const std::string	log_id () const
	A variant on id() that is more descriptive, for use with message logging. More...

const std::string &	parent_id () const
	The id of the original type from which this (variation) descended. More...

const std::string &	variation_id () const
	The id of this variation; empty if it's a gender variation or a base unit. More...

t_string	unit_description () const

std::vector< t_string >	direct_special_notes () const
	Returns only the notes defined by [unit_type][special_note] tags, excluding any that would be found from abilities, attacks, etc. More...

std::vector< t_string >	special_notes () const
	Returns all notes that should be displayed in the help page for this type, including those found in abilities and attacks. More...

int	hitpoints () const

double	hp_bar_scaling () const

double	xp_bar_scaling () const

int	level () const

int	recall_cost () const

int	movement () const

int	vision () const

int	vision (bool base_value) const
	If base_value is set to true, do not fall back to movement(). More...

int	jamming () const

int	max_attacks () const

int	cost () const

const std::string &	default_variation () const

const t_string &	variation_name () const

const std::string &	usage () const

const std::string &	image () const

const std::string &	icon () const

const std::string &	small_profile () const

const std::string &	big_profile () const

std::string	halo () const

std::string	ellipse () const

bool	generate_name () const

const std::vector< unit_animation > &	animations () const

const std::string &	flag_rgb () const

const_attack_itors	attacks () const

const std::string	movement_type_id () const

const movetype &	movement_type () const

int	experience_needed (bool with_acceleration=true) const

unit_alignments::type	alignment () const

const std::vector< ability_metadata > &	abilities_metadata () const

const std::vector< ability_metadata > &	adv_abilities_metadata () const
	Some extra abilities that may be gained through AMLA advancements. More...

bool	can_advance () const

bool	musthave_status (const std::string &status) const

bool	has_zoc () const

bool	has_ability_by_id (const std::string &ability) const

std::vector< std::string >	get_ability_list () const

config::const_child_itors	possible_traits () const

const config &	abilities_cfg () const

config::const_child_itors	advancements () const

config::const_child_itors	events () const

bool	has_random_traits () const

const std::vector< unit_race::GENDER > &	genders () const
	The returned vector will not be empty, provided this has been built to the HELP_INDEXED status. More...

bool	has_gender_variation (const unit_race::GENDER gender) const

std::vector< std::string >	variations () const

const variations_map &	variation_types () const

bool	has_variation (const std::string &variation_id) const

bool	show_variations_in_help () const
	Whether the unit type has at least one help-visible variation. More...

std::string	race_id () const
	Returns the ID of this type's race without the need to build the type. More...

const unit_race *	race () const
	Never returns nullptr, but may point to the null race. More...

bool	hide_help () const

bool	do_not_list () const

const config &	get_cfg () const

int	resistance_against (const std::string &damage_name, bool attacker) const
	Gets resistance while considering custom WML abilities. More...

void	apply_scenario_fix (const config &cfg)

void	remove_scenario_fixes ()

Static Public Member Functions
static void	check_id (std::string &id)
	Validate the id argument. More...

static std::string	alignment_description (unit_alignments::type align, unit_race::GENDER gender=unit_race::MALE)
	Implementation detail of unit_type::alignment_description. More...

Private Types
typedef std::map< std::string, unit_type >	variations_map

Private Member Functions
	unit_type (defaut_ctor_t, const config &cfg, const std::string &parent_id)

void	build_full (const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
	Load data into an empty unit_type (build to FULL). More...

void	build_help_index (const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
	Partially load data into an empty unit_type (build to HELP_INDEXED). More...

void	build_created ()
	Load the most needed data into an empty unit_type (build to CREATE). More...

bool	resistance_filter_matches (const config &cfg, bool attacker, const std::string &damage_name, int res) const
	Identical to unit::resistance_filter_matches. More...

config &	writable_cfg ()

void	fill_variations ()
	Processes [variation] tags of ut_cfg, handling inheritance and child clearing. More...

void	fill_variations_and_gender ()

std::unique_ptr< unit_type >	create_sub_type (const config &var_cfg, bool default_inherit)
	Handles inheritance for configs of [male], [female], and [variation]. More...

unit_type &	operator= (const unit_type &o)=delete

Private Attributes
const config *	cfg_

std::unique_ptr< config >	built_cfg_

bool	has_cfg_build_

attack_list	attacks_cache_

std::string	id_

std::string	debug_id_
	A suffix for id_, used when logging messages. More...

std::string	parent_id_
	The id of the top ancestor of this unit_type. More...

std::string	base_unit_id_
	from [base_unit] More...

t_string	type_name_

t_string	description_

std::vector< t_string >	special_notes_

int	hitpoints_

double	hp_bar_scaling_

double	xp_bar_scaling_

int	level_

int	recall_cost_

int	movement_

int	vision_

int	jamming_

int	max_attacks_

int	cost_

std::string	usage_

std::string	undead_variation_

std::string	image_

std::string	icon_

std::string	small_profile_

std::string	profile_

std::string	flag_rgb_

unsigned int	num_traits_

std::array< std::unique_ptr< unit_type >, 2 >	gender_types_

variations_map	variations_

std::string	default_variation_

std::string	variation_id_

t_string	variation_name_

const unit_race *	race_
	Never nullptr, but may point to the null race. More...

std::vector< ability_metadata >	abilities_

std::vector< ability_metadata >	adv_abilities_

bool	zoc_

bool	hide_help_

bool	do_not_list_

std::vector< std::string >	advances_to_

config::const_child_itors	advancements_

int	experience_needed_

unit_alignments::type	alignment_

std::string	movement_type_id_

movetype	movement_type_

config	possible_traits_

std::vector< unit_race::GENDER >	genders_

std::vector< unit_animation >	animations_

BUILD_STATUS	build_status_

Friends
class	unit_type_data

Detailed Description

A single unit type that the player may recruit.

Individual units are defined by the unit class.

Definition at line 42 of file types.hpp.

Member Typedef Documentation

◆ error

using unit_type::error = unit_type_error

Definition at line 49 of file types.hpp.

◆ variations_map

typedef std::map<std::string,unit_type> unit_type::variations_map

private

Definition at line 94 of file types.hpp.

Member Enumeration Documentation

◆ BUILD_STATUS

enum unit_type::BUILD_STATUS

Records the status of the lazy building of unit types.

These are in order of increasing levels of being built. HELP_INDEX is already defined in a windows header under some conditions

Enumerator
NOT_BUILT
CREATED
VARIATIONS
HELP_INDEXED
FULL

Definition at line 74 of file types.hpp.

Constructor & Destructor Documentation

◆ unit_type() [1/6]

unit_type::unit_type	(	defaut_ctor_t	,
		const config &	cfg,
		const std::string &	parent_id
	)

private

Definition at line 102 of file types.cpp.

References base_unit_id_, check_id(), id_, LOG_UT, config::optional_child(), and parent_id_.

◆ unit_type() [2/6]

unit_type::unit_type	(	const config &	cfg,
		const std::string &	parent_id = `""`
	)

explicit

Creates a unit type for the given config, but delays its build till later.

Note: cfg is not copied, so it has to point to some permanent storage, that is, a child of unit_type_data::unit_cfg.

Definition at line 157 of file types.cpp.

References cfg_.

◆ unit_type() [3/6]

unit_type::unit_type	(	config &&	cfg,
		const std::string &	parent_id = `""`
	)

explicit

Creates a unit type for the given config, but delays its build till later.

Note: cfg is copied

Definition at line 164 of file types.cpp.

References built_cfg_.

◆ unit_type() [4/6]

unit_type::unit_type ( )

Referenced by unit_type().

◆ unit_type() [5/6]

unit_type::unit_type ( const unit_type & o )

Definition at line 53 of file types.cpp.

References gender_types_, and unit_type().

◆ unit_type() [6/6]

unit_type::unit_type ( unit_type && o )

default

◆ ~unit_type()

unit_type::~unit_type ( )

Definition at line 171 of file types.cpp.

Member Function Documentation

◆ abilities_cfg()

const config& unit_type::abilities_cfg ( ) const

inline

Definition at line 234 of file types.hpp.

References config::child_or_empty(), and get_cfg().

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

◆ abilities_metadata()

const std::vector<ability_metadata>& unit_type::abilities_metadata ( ) const

inline

Definition at line 217 of file types.hpp.

References abilities_.

Referenced by help::unit_topic_generator::operator()().

◆ adv_abilities_metadata()

const std::vector<ability_metadata>& unit_type::adv_abilities_metadata ( ) const

inline

Some extra abilities that may be gained through AMLA advancements.

Definition at line 220 of file types.hpp.

References adv_abilities_.

Referenced by help::unit_topic_generator::operator()().

◆ advancement_tree()

std::set< std::string > unit_type::advancement_tree ( ) const

Get the advancement tree.

Returns: A set of ids of all unit_type objects that this unit_type can directly or indirectly advance to.

Definition at line 647 of file types.cpp.

References advancement_tree_internal(), and id_.

Referenced by ai::default_recruitment::recruitment::do_similarity_penalty().

◆ advancements()

config::const_child_itors unit_type::advancements ( ) const

inline

Definition at line 237 of file types.hpp.

References advancements_.

Referenced by unit::advance_to().

◆ advances_from()

const std::vector< std::string > unit_type::advances_from ( ) const

A vector of unit_type ids that can advance to this unit_type.

Definition at line 654 of file types.cpp.

References unit_type_data::build_all(), HELP_INDEXED, id_, unit_type_data::types(), and unit_types.

Referenced by help::unit_topic_generator::operator()().

◆ advances_to()

const std::vector<std::string>& unit_type::advances_to ( ) const

inline

A vector of unit_type ids that this unit_type can advance to.

Definition at line 115 of file types.hpp.

References advances_to_.

Referenced by unit::advance_to(), advancement_tree_internal(), and help::unit_topic_generator::operator()().

◆ alignment()

unit_alignments::type unit_type::alignment ( ) const

inline

Definition at line 193 of file types.hpp.

References alignment_.

Referenced by unit::advance_to(), battle_context_unit_stats::battle_context_unit_stats(), wfl::unit_type_callable::get_value(), and help::unit_topic_generator::operator()().

◆ alignment_description()

std::string unit_type::alignment_description	(	unit_alignments::type	align,
		unit_race::GENDER	gender = `unit_race::MALE`
	)

static

Implementation detail of unit_type::alignment_description.

Definition at line 841 of file types.cpp.

References _(), and unit_race::FEMALE.

Referenced by attack_info(), gui2::dialogs::unit_recruit::filter_text_changed(), help::unit_topic_generator::operator()(), gui2::dialogs::unit_recall::pre_show(), gui2::unit_preview_pane::set_displayed_type(), gui2::unit_preview_pane::set_displayed_unit(), and unit_alignment().

◆ animations()

const std::vector< unit_animation > & unit_type::animations ( ) const

Definition at line 536 of file types.cpp.

References animations_, unit_animation::fill_initial_animations(), and get_cfg().

Referenced by unit_animation_component::reset_after_advance().

◆ apply_scenario_fix()

void unit_type::apply_scenario_fix ( const config & cfg )

Definition at line 1375 of file types.cpp.

References advancements_, advances_to_, build_created(), unit_type_data::build_unit_type(), config::child_range(), utils::contains(), cost_, experience_needed_, gender_types_, config::get(), get_cfg(), config::has_child(), config::optional_child(), utils::split(), unit_types, VARIATIONS, and variations_.

◆ attacks()

const_attack_itors unit_type::attacks ( ) const

Definition at line 545 of file types.cpp.

References attacks_cache_, get_cfg(), and make_attack_itors().

Referenced by unit::advance_to(), combine_special_notes(), wfl::unit_type_callable::get_value(), impl_unit_attacks_len(), help::unit_topic_generator::operator()(), ai::default_recruitment::recruitment::simulate_attack(), and special_notes().

◆ big_profile()

const std::string& unit_type::big_profile ( ) const

inline

Definition at line 179 of file types.hpp.

References profile_.

Referenced by unit::advance_to(), and help::unit_topic_generator::operator()().

◆ build() [1/2]

void unit_type::build	(	BUILD_STATUS	status,
		const movement_type_map &	movement_types,
		const race_map &	races,
		const config_array_view &	traits
	)

Performs a build of this to the indicated stage.

Definition at line 420 of file types.cpp.

References build_created(), build_full(), build_help_index(), CREATED, DBG_UT, ERR_UT, FULL, HELP_INDEXED, log_id(), NOT_BUILT, and VARIATIONS.

Referenced by build(), and unit_type_data::build_unit_type().

◆ build() [2/2]

void unit_type::build	(	BUILD_STATUS	status,
		const movement_type_map &	movement_types,
		const race_map &	races,
		const config_array_view &	traits
	)		const

inline

Performs a build of this to the indicated stage.

(This does not logically change the unit type, so allow const access.)

Definition at line 103 of file types.hpp.

References build().

◆ build_created()

void unit_type::build_created ( )

private

Load the most needed data into an empty unit_type (build to CREATE).

This creates the gender-specific types (if needed) and also defines how much experience is needed to advance as well as what this advances to.

Definition at line 377 of file types.cpp.

References advances_to_, build_status_, cost_, CREATED, DBG_UT, experience_needed_, gender_types_, get_cfg(), i, image_, log_id(), utils::split(), type_name_, variation_name_, and variations_.

Referenced by apply_scenario_fix(), build(), and build_help_index().

◆ build_full()

void unit_type::build_full	(	const movement_type_map &	movement_types,
		const race_map &	races,
		const config_array_view &	traits
	)

private

Load data into an empty unit_type (build to FULL).

Definition at line 193 of file types.cpp.

References game_config::add_color_info(), build_help_index(), build_status_, FULL, gender_types_, get_cfg(), game_config::hp_bar_scaling, hp_bar_scaling_, i, level_, unit_race::null_race, race_, unit_race::undead_variation(), undead_variation_, variations_, game_config_view::wrap(), game_config::xp_bar_scaling, xp_bar_scaling_, and zoc_.

Referenced by build().

◆ build_help_index()

void unit_type::build_help_index	(	const movement_type_map &	movement_types,
		const race_map &	races,
		const config_array_view &	traits
	)

private

Partially load data into an empty unit_type (build to HELP_INDEXED).

Definition at line 236 of file types.cpp.

References abilities_, config::add_child(), unit_race::additional_traits(), adjust_profile(), adv_abilities_, alignment_, build_created(), build_status_, config::child_range(), config::clear(), DBG_UT, default_variation_, description_, do_not_list_, flag_rgb_, g, gender_types_, genders_, get_cfg(), string_enums::enum_base< Definition >::get_enum(), HELP_INDEXED, hide_help_, hitpoints_, i, icon_, jamming_, level_, unit_race::MALE, max_attacks_, movetype::merge(), movement_, movement_type_, movement_type_id_, unit_race::null_race, unit_race::num_traits(), num_traits_, config::optional_child(), possible_traits_, profile_, race_, recall_cost_, small_profile_, special_notes_, utils::split(), string_gender(), t, type_name_, unit_race::undead_variation(), undead_variation_, usage_, unit_race::uses_global_traits(), variations_, and vision_.

Referenced by build(), and build_full().

◆ can_advance()

bool unit_type::can_advance ( ) const

inline

Definition at line 222 of file types.hpp.

References advances_to_.

Referenced by help::unit_topic_generator::operator()().

◆ check_id()

void unit_type::check_id ( std::string & id )

static

Validate the id argument.

Replaces invalid characters in the reference with underscores.

Parameters

id	The proposed id for a unit_type.

Exceptions

error if id starts with a space.

Definition at line 1474 of file types.cpp.

References c, and ERR_UT.

Referenced by get_unit_type(), and unit_type().

◆ cost()

int unit_type::cost ( ) const

inline

Definition at line 172 of file types.hpp.

References cost_.

Referenced by unit::advance_to(), events::menu_handler::can_recruit(), ai::default_recruitment::recruitment::compare_unit_types(), wfl::unit_type_callable::get_value(), team::minimum_recruit_price(), help::unit_topic_generator::operator()(), ai::default_recruitment::recruitment::recall_unit_value(), actions::recruit_unit(), ai::simulated_recruit(), SYNCED_COMMAND_HANDLER_FUNCTION(), and actions::undo::recruit_action::undo().

◆ create_sub_type()

std::unique_ptr< unit_type > unit_type::create_sub_type	(	const config &	var_cfg,
		bool	default_inherit
	)

private

Handles inheritance for configs of [male], [female], and [variation].

Also removes gendered children, as those serve no purpose. default_inherit is the default value for inherit=.

Definition at line 1034 of file types.cpp.

References config::clear_children(), get_cfg(), config::inherit_from(), and parent_id().

Referenced by fill_variations(), and fill_variations_and_gender().

◆ default_variation()

const std::string& unit_type::default_variation ( ) const

inline

Definition at line 173 of file types.hpp.

References default_variation_.

Referenced by unit::init().

◆ direct_special_notes()

std::vector<t_string> unit_type::direct_special_notes ( ) const

inline

Returns only the notes defined by [unit_type][special_note] tags, excluding any that would be found from abilities, attacks, etc.

Definition at line 155 of file types.hpp.

References special_notes_.

Referenced by unit::advance_to().

◆ do_not_list()

bool unit_type::do_not_list ( ) const

inline

Definition at line 279 of file types.hpp.

References do_not_list_.

◆ ellipse()

std::string unit_type::ellipse ( ) const

inline

Definition at line 181 of file types.hpp.

References get_cfg().

Referenced by unit::advance_to().

◆ events()

config::const_child_itors unit_type::events ( ) const

inline

Definition at line 240 of file types.hpp.

References config::child_range(), and get_cfg().

◆ experience_needed()

int unit_type::experience_needed ( bool with_acceleration = true ) const

Definition at line 579 of file types.cpp.

References experience_needed_.

Referenced by unit::advance_to(), battle_context_unit_stats::battle_context_unit_stats(), wfl::unit_type_callable::get_value(), and help::unit_topic_generator::operator()().

◆ fill_variations()

void unit_type::fill_variations ( )

private

Processes [variation] tags of ut_cfg, handling inheritance and child clearing.

Definition at line 1051 of file types.cpp.

References create_sub_type(), debug_id_, ERR_CF, get_cfg(), and variations_.

Referenced by fill_variations_and_gender().

◆ fill_variations_and_gender()

void unit_type::fill_variations_and_gender ( )

private

Definition at line 1080 of file types.cpp.

References create_sub_type(), fill_variations(), gender_types_, get_cfg(), and gui2::dialogs::loading_screen::progress().

◆ flag_rgb()

const std::string & unit_type::flag_rgb ( ) const

Definition at line 722 of file types.cpp.

References flag_rgb_, and game_config::unit_rgb.

Referenced by unit::advance_to(), help::unit_topic_generator::operator()(), editor::mouse_action_unit::set_unit_mouse_overlay(), editor::unit_palette::setup_item(), and gui2::dialogs::faction_select::update_leader_image().

◆ genders()

const std::vector<unit_race::GENDER>& unit_type::genders ( ) const

inline

The returned vector will not be empty, provided this has been built to the HELP_INDEXED status.

Definition at line 249 of file types.hpp.

References genders_.

Referenced by help::unit_topic_generator::operator()(), and editor::mouse_action_unit::up_left().

◆ generate_name()

bool unit_type::generate_name ( ) const

inline

Definition at line 182 of file types.hpp.

References get_cfg().

Referenced by unit::advance_to().

◆ get_ability_list()

std::vector< std::string > unit_type::get_ability_list ( ) const

Definition at line 606 of file types.cpp.

References get_cfg(), and config::optional_child().

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

◆ get_cfg()

const config& unit_type::get_cfg ( ) const

inline

Definition at line 281 of file types.hpp.

References built_cfg_, and cfg_.

Referenced by abilities_cfg(), unit::advance_to(), animations(), unit_type_data::apply_base_unit(), apply_scenario_fix(), attacks(), build_created(), build_full(), build_help_index(), create_sub_type(), ellipse(), events(), fill_variations(), fill_variations_and_gender(), generate_name(), get_ability_list(), halo(), has_ability_by_id(), help::unit_topic_generator::operator()(), race_id(), unit_drawer::redraw_unit(), remove_scenario_fixes(), and resistance_against().

◆ get_gender_unit_type() [1/2]

const unit_type & unit_type::get_gender_unit_type ( std::string gender ) const

Returns a gendered variant of this unit_type.

Parameters

gender "male" or "female".

Definition at line 455 of file types.cpp.

References unit_race::FEMALE, unit_race::MALE, unit_race::s_female, and unit_race::s_male.

Referenced by unit::advance_to(), unit::apply_builtin_effect(), impl_unit_type_lookup(), impl_unit_type_next(), help::unit_topic_generator::operator()(), and gui2::dialogs::faction_select::update_leader_image().

◆ get_gender_unit_type() [2/2]

const unit_type & unit_type::get_gender_unit_type ( unit_race::GENDER gender ) const

Returns a gendered variant of this unit_type based on the given parameter.

Definition at line 466 of file types.cpp.

References gender_types_, and i.

◆ get_variation()

const unit_type & unit_type::get_variation ( const std::string & id ) const

Definition at line 476 of file types.cpp.

References i, and variations_.

Referenced by unit::advance_to(), impl_unit_type_lookup(), intf_transform_unit(), help::unit_topic_generator::operator()(), and gui2::dialogs::unit_create::update_displayed_type().

◆ halo()

std::string unit_type::halo ( ) const

inline

Definition at line 180 of file types.hpp.

References get_cfg().

Referenced by unit::advance_to().

◆ has_ability_by_id()

bool unit_type::has_ability_by_id ( const std::string & ability ) const

Definition at line 593 of file types.cpp.

References get_cfg().

◆ has_gender_variation()

bool unit_type::has_gender_variation ( const unit_race::GENDER gender ) const

inline

Definition at line 250 of file types.hpp.

References genders_.

Referenced by impl_unit_type_next(), and help::unit_topic_generator::operator()().

◆ has_random_traits()

bool unit_type::has_random_traits ( ) const

Definition at line 727 of file types.cpp.

References config_attribute_value::blank(), num_traits(), possible_traits(), and config_attribute_value::str().

◆ has_variation()

bool unit_type::has_variation ( const std::string & variation_id ) const

Parameters

variation_id The id of the variation we search for.

Returns: Whether one of the type's variations' (or the siblings' if the unit_type is a variation itself) id matches variation_id.

Definition at line 759 of file types.cpp.

References variation_id(), and variations_.

Referenced by unit::apply_builtin_effect(), and intf_transform_unit().

◆ has_zoc()

bool unit_type::has_zoc ( ) const

inline

Definition at line 226 of file types.hpp.

References zoc_.

Referenced by unit::advance_to().

◆ hide_help()

bool unit_type::hide_help ( ) const

Definition at line 626 of file types.cpp.

References unit_type_data::hide_help(), hide_help_, unit_race::id(), id_, race_, and unit_types.

Referenced by help::generate_unit_sections(), and help::show_unit_description().

◆ hitpoints()

int unit_type::hitpoints ( ) const

inline

Definition at line 161 of file types.hpp.

References hitpoints_.

Referenced by unit::advance_to(), battle_context_unit_stats::battle_context_unit_stats(), ai::default_recruitment::recruitment::compare_unit_types(), ai::default_recruitment::recruitment::do_combat_analysis(), ai::default_recruitment::attack_simulation::get_avg_hp_of_combatant(), wfl::unit_type_callable::get_value(), help::unit_topic_generator::operator()(), and ai::default_recruitment::recruitment::simulate_attack().

◆ hp_bar_scaling()

double unit_type::hp_bar_scaling ( ) const

inline

Definition at line 162 of file types.hpp.

References hp_bar_scaling_.

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

◆ icon()

const std::string& unit_type::icon ( ) const

inline

Definition at line 177 of file types.hpp.

References icon_.

Referenced by unit::absolute_image(), unit::default_anim_image(), and unit::write().

◆ id()

const std::string& unit_type::id ( ) const

inline

The id for this unit_type.

Definition at line 141 of file types.hpp.

References id_.

Referenced by unit::advance_to(), wfl::unit_type_callable::do_compare(), ai::recruit_result::do_execute(), help::generate_unit_sections(), editor::unit_palette::get_id(), wfl::unit_type_callable::get_value(), impl_unit_type_tostring(), help::unit_topic_generator::operator()(), ai::default_recruitment::recruitment::recruit_matches_type(), and unit::type_id().

◆ image()

const std::string& unit_type::image ( ) const

inline

Definition at line 176 of file types.hpp.

References image_.

Referenced by unit::absolute_image(), unit::default_anim_image(), help::unit_topic_generator::operator()(), gui2::dialogs::unit_advance::pre_show(), editor::mouse_action_unit::set_unit_mouse_overlay(), editor::unit_palette::setup_item(), gui2::dialogs::faction_select::update_leader_image(), and unit::write().

◆ jamming()

int unit_type::jamming ( ) const

inline

Definition at line 170 of file types.hpp.

References jamming_.

Referenced by unit::advance_to(), and help::unit_topic_generator::operator()().

◆ level()

int unit_type::level ( ) const

inline

Definition at line 164 of file types.hpp.

References level_.

Referenced by unit::advance_to(), battle_context_unit_stats::battle_context_unit_stats(), wfl::unit_type_callable::get_value(), help::unit_topic_generator::operator()(), and ai::default_recruitment::recruitment::recruit_matches_type().

◆ log_id()

const std::string unit_type::log_id ( ) const

inline

A variant on id() that is more descriptive, for use with message logging.

Definition at line 143 of file types.hpp.

References debug_id_, and id_.

Referenced by unit::advances_to_translated(), build(), build_created(), and unit::generate_traits().

◆ max_attacks()

int unit_type::max_attacks ( ) const

inline

Definition at line 171 of file types.hpp.

References max_attacks_.

Referenced by unit::advance_to().

◆ modification_advancements()

config::const_child_itors unit_type::modification_advancements ( ) const

inline

Returns two iterators pointing to a range of AMLA configs.

Definition at line 120 of file types.hpp.

References advancements_.

Referenced by help::unit_topic_generator::operator()().

◆ movement()

int unit_type::movement ( ) const

inline

Definition at line 166 of file types.hpp.

References movement_.

Referenced by unit::advance_to(), wfl::unit_type_callable::get_value(), help::unit_topic_generator::operator()(), and vision().

◆ movement_type()

const movetype& unit_type::movement_type ( ) const

inline

Definition at line 189 of file types.hpp.

References movement_type_.

Referenced by unit::advance_to(), wfl::gamestate::DEFINE_WFL_FUNCTION(), ai::default_recruitment::recruitment::get_average_defense(), help::unit_topic_generator::operator()(), special_notes(), and ai::default_recruitment::recruitment::update_average_local_cost().

◆ movement_type_id()

const std::string unit_type::movement_type_id ( ) const

inline

Definition at line 188 of file types.hpp.

References movement_type_id_.

◆ musthave_status()

bool unit_type::musthave_status ( const std::string & status ) const

Definition at line 674 of file types.cpp.

References config::child_range(), possible_traits(), and utils::split().

Referenced by battle_context_unit_stats::battle_context_unit_stats(), and wfl::unit_type_callable::get_value().

◆ num_traits()

unsigned int unit_type::num_traits ( ) const

inline

Definition at line 135 of file types.hpp.

References num_traits_.

Referenced by unit::generate_traits(), has_random_traits(), and help::unit_topic_generator::operator()().

◆ operator=()

unit_type& unit_type::operator= ( const unit_type & o )

privatedelete

◆ parent_id()

const std::string& unit_type::parent_id ( ) const

inline

The id of the original type from which this (variation) descended.

Definition at line 145 of file types.hpp.

References parent_id_.

Referenced by unit::apply_builtin_effect(), battle_context_unit_stats::battle_context_unit_stats(), create_sub_type(), unit_filter_impl::unit_filter_compound::fill(), statistics_t::recruit_unit(), statistics_t::un_recruit_unit(), actions::undo::recruit_action::write(), and unit::write().

◆ possible_traits()

config::const_child_itors unit_type::possible_traits ( ) const

inline

Definition at line 231 of file types.hpp.

References config::child_range(), and possible_traits_.

Referenced by unit::generate_traits(), wfl::unit_type_callable::get_value(), has_random_traits(), musthave_status(), and help::unit_topic_generator::operator()().

◆ race()

const unit_race* unit_type::race ( ) const

inline

Never returns nullptr, but may point to the null race.

Requires building to the HELP_INDEXED status to get the correct race.

Definition at line 277 of file types.hpp.

References race_.

Referenced by unit::advance_to(), and help::unit_topic_generator::operator()().

◆ race_id()

std::string unit_type::race_id ( ) const

inline

Returns the ID of this type's race without the need to build the type.

Definition at line 272 of file types.hpp.

References get_cfg().

Referenced by wfl::unit_type_callable::get_value(), and help::unit_topic_generator::operator()().

◆ recall_cost()

int unit_type::recall_cost ( ) const

inline

Definition at line 165 of file types.hpp.

References recall_cost_.

Referenced by unit::advance_to(), and wfl::unit_type_callable::get_value().

◆ remove_scenario_fixes()

void unit_type::remove_scenario_fixes ( )

Definition at line 1444 of file types.cpp.

References advancements_, advances_to_, config::child_range(), cost_, experience_needed_, gender_types_, get_cfg(), utils::split(), and variations_.

◆ resistance_against()

int unit_type::resistance_against	(	const std::string &	damage_name,
		bool	attacker
	)		const

Gets resistance while considering custom WML abilities.

Attention: Filters in resistance-abilities will be ignored.

Definition at line 775 of file types.cpp.

References config::child_range(), unit_ability_list::emplace_back(), unit_ability_list::empty(), get_cfg(), unit_abilities::effect::get_composite_value(), unit_ability_list::highest(), movement_type_, map_location::null_location(), movetype::resistance_against(), and resistance_filter_matches().

Referenced by battle_context_unit_stats::battle_context_unit_stats().

◆ resistance_filter_matches()

bool unit_type::resistance_filter_matches	(	const config &	cfg,
		bool	attacker,
		const std::string &	damage_name,
		int	res
	)		const

private

Identical to unit::resistance_filter_matches.

Definition at line 806 of file types.cpp.

References unit_abilities::filter_base_matches(), and utils::split().

Referenced by resistance_against().

◆ show_variations_in_help()

bool unit_type::show_variations_in_help ( ) const

Whether the unit type has at least one help-visible variation.

Definition at line 764 of file types.cpp.

References variations_.

Referenced by help::unit_topic_generator::operator()(), unit_defense(), and unit_type().

◆ small_profile()

const std::string& unit_type::small_profile ( ) const

inline

Definition at line 178 of file types.hpp.

References small_profile_.

Referenced by unit::advance_to(), and help::unit_topic_generator::operator()().

◆ special_notes()

std::vector< t_string > unit_type::special_notes ( ) const

Returns all notes that should be displayed in the help page for this type, including those found in abilities and attacks.

Definition at line 495 of file types.cpp.

References abilities_cfg(), attacks(), combine_special_notes(), movement_type(), and special_notes_.

Referenced by help::unit_topic_generator::operator()().

◆ type_name()

const t_string& unit_type::type_name ( ) const

inline

The name of the unit in the current language setting.

Definition at line 138 of file types.hpp.

References type_name_.

Referenced by unit::advance_to(), events::menu_handler::can_recruit(), editor::unit_palette::get_help_string(), wfl::unit_type_callable::get_value(), gui2::dialogs::unit_create::list_item_clicked(), help::unit_topic_generator::operator()(), editor::unit_palette::setup_item(), and ai::simulated_recruit().

◆ undead_variation()

const std::string& unit_type::undead_variation ( ) const

inline

Info on the type of unit that the unit reanimates as.

Definition at line 133 of file types.hpp.

References undead_variation_.

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

◆ unit_description()

t_string unit_type::unit_description ( ) const

Definition at line 486 of file types.cpp.

References _(), description_, and t_string::empty().

Referenced by unit::advance_to(), help::unit_topic_generator::operator()(), and unit::write().

◆ usage()

const std::string& unit_type::usage ( ) const

inline

Definition at line 175 of file types.hpp.

References usage_.

Referenced by unit::advance_to(), wfl::unit_type_callable::get_value(), and ai::default_recruitment::recruitment::recruit_matches_type().

◆ variation_id()

const std::string& unit_type::variation_id ( ) const

inline

The id of this variation; empty if it's a gender variation or a base unit.

Definition at line 147 of file types.hpp.

References variation_id_.

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

◆ variation_name()

const t_string& unit_type::variation_name ( ) const

inline

Definition at line 174 of file types.hpp.

References variation_name_.

Referenced by help::generate_unit_sections(), and gui2::dialogs::unit_create::list_item_clicked().

◆ variation_types()

const variations_map& unit_type::variation_types ( ) const

inline

Definition at line 256 of file types.hpp.

References variations_.

Referenced by impl_unit_type_next().

◆ variations()

std::vector< std::string > unit_type::variations ( ) const

Definition at line 747 of file types.cpp.

References variations_.

Referenced by help::unit_topic_generator::operator()().

◆ vision() [1/2]

int unit_type::vision ( ) const

inline

Definition at line 167 of file types.hpp.

References movement(), and vision_.

Referenced by unit::advance_to(), and help::unit_topic_generator::operator()().

◆ vision() [2/2]

int unit_type::vision ( bool base_value ) const

inline

If base_value is set to true, do not fall back to movement().

Definition at line 169 of file types.hpp.

References vision(), and vision_.

Referenced by vision().

◆ writable_cfg()

config& unit_type::writable_cfg ( )

inlineprivate

Definition at line 304 of file types.hpp.

References built_cfg_, and cfg_.

◆ xp_bar_scaling()

double unit_type::xp_bar_scaling ( ) const

inline

Definition at line 163 of file types.hpp.

References xp_bar_scaling_.

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

Friends And Related Function Documentation

◆ unit_type_data

friend class unit_type_data

friend

Definition at line 317 of file types.hpp.

Member Data Documentation

◆ abilities_

std::vector<ability_metadata> unit_type::abilities_

private

Definition at line 362 of file types.hpp.

Referenced by abilities_metadata(), and build_help_index().

◆ adv_abilities_

std::vector<ability_metadata> unit_type::adv_abilities_

private

Definition at line 362 of file types.hpp.

Referenced by adv_abilities_metadata(), and build_help_index().

◆ advancements_

config::const_child_itors unit_type::advancements_

private

Definition at line 367 of file types.hpp.

Referenced by advancements(), apply_scenario_fix(), modification_advancements(), and remove_scenario_fixes().

◆ advances_to_

std::vector<std::string> unit_type::advances_to_

private

Definition at line 366 of file types.hpp.

Referenced by advances_to(), apply_scenario_fix(), build_created(), can_advance(), and remove_scenario_fixes().

◆ alignment_

unit_alignments::type unit_type::alignment_

private

Definition at line 371 of file types.hpp.

Referenced by alignment(), and build_help_index().

◆ animations_

std::vector<unit_animation> unit_type::animations_

mutableprivate

Definition at line 381 of file types.hpp.

Referenced by animations().

◆ attacks_cache_

attack_list unit_type::attacks_cache_

mutableprivate

Definition at line 320 of file types.hpp.

Referenced by attacks().

◆ base_unit_id_

std::string unit_type::base_unit_id_

private

from [base_unit]

Definition at line 328 of file types.hpp.

Referenced by unit_type().

◆ build_status_

BUILD_STATUS unit_type::build_status_

private

Definition at line 383 of file types.hpp.

Referenced by build_created(), build_full(), and build_help_index().

◆ built_cfg_

std::unique_ptr<config> unit_type::built_cfg_

mutableprivate

Definition at line 318 of file types.hpp.

Referenced by get_cfg(), unit_type(), and writable_cfg().

◆ cfg_

const config* unit_type::cfg_

private

Definition at line 316 of file types.hpp.

Referenced by get_cfg(), unit_type(), and writable_cfg().

◆ cost_

int unit_type::cost_

private

Definition at line 340 of file types.hpp.

Referenced by apply_scenario_fix(), build_created(), cost(), and remove_scenario_fixes().

◆ debug_id_

std::string unit_type::debug_id_

private

A suffix for id_, used when logging messages.

Definition at line 324 of file types.hpp.

Referenced by fill_variations(), and log_id().

◆ default_variation_

std::string unit_type::default_variation_

private

Definition at line 355 of file types.hpp.

Referenced by build_help_index(), and default_variation().

◆ description_

t_string unit_type::description_

private

Definition at line 330 of file types.hpp.

Referenced by build_help_index(), and unit_description().

◆ do_not_list_

bool unit_type::do_not_list_

private

Definition at line 364 of file types.hpp.

Referenced by build_help_index(), and do_not_list().

◆ experience_needed_

int unit_type::experience_needed_

private

Definition at line 368 of file types.hpp.

Referenced by apply_scenario_fix(), build_created(), experience_needed(), and remove_scenario_fixes().

◆ flag_rgb_

std::string unit_type::flag_rgb_

private

Definition at line 348 of file types.hpp.

Referenced by build_help_index(), and flag_rgb().

◆ gender_types_

std::array<std::unique_ptr<unit_type>, 2> unit_type::gender_types_

private

Definition at line 352 of file types.hpp.

Referenced by apply_scenario_fix(), build_created(), build_full(), build_help_index(), fill_variations_and_gender(), get_gender_unit_type(), remove_scenario_fixes(), and unit_type().

◆ genders_

std::vector<unit_race::GENDER> unit_type::genders_

private

Definition at line 378 of file types.hpp.

Referenced by build_help_index(), genders(), and has_gender_variation().

◆ has_cfg_build_

bool unit_type::has_cfg_build_

mutableprivate

Definition at line 319 of file types.hpp.

◆ hide_help_

bool unit_type::hide_help_

private

Definition at line 364 of file types.hpp.

Referenced by build_help_index(), and hide_help().

◆ hitpoints_

int unit_type::hitpoints_

private

Definition at line 332 of file types.hpp.

Referenced by build_help_index(), and hitpoints().

◆ hp_bar_scaling_

double unit_type::hp_bar_scaling_

private

Definition at line 333 of file types.hpp.

Referenced by build_full(), and hp_bar_scaling().

◆ icon_

std::string unit_type::icon_

private

Definition at line 345 of file types.hpp.

Referenced by build_help_index(), and icon().

◆ id_

std::string unit_type::id_

private

Definition at line 322 of file types.hpp.

Referenced by advancement_tree(), advances_from(), hide_help(), id(), log_id(), and unit_type().

◆ image_

std::string unit_type::image_

private

Definition at line 344 of file types.hpp.

Referenced by build_created(), and image().

◆ jamming_

int unit_type::jamming_

private

Definition at line 338 of file types.hpp.

Referenced by build_help_index(), and jamming().

◆ level_

int unit_type::level_

private

Definition at line 334 of file types.hpp.

Referenced by build_full(), build_help_index(), and level().

◆ max_attacks_

int unit_type::max_attacks_

private

Definition at line 339 of file types.hpp.

Referenced by build_help_index(), and max_attacks().

◆ movement_

int unit_type::movement_

private

Definition at line 336 of file types.hpp.

Referenced by build_help_index(), and movement().

◆ movement_type_

movetype unit_type::movement_type_

private

Definition at line 374 of file types.hpp.

Referenced by build_help_index(), movement_type(), and resistance_against().

◆ movement_type_id_

std::string unit_type::movement_type_id_

private

Definition at line 373 of file types.hpp.

Referenced by build_help_index(), and movement_type_id().

◆ num_traits_

unsigned int unit_type::num_traits_

private

Definition at line 350 of file types.hpp.

Referenced by build_help_index(), and num_traits().

◆ parent_id_

std::string unit_type::parent_id_

private

The id of the top ancestor of this unit_type.

Definition at line 326 of file types.hpp.

Referenced by parent_id(), and unit_type().

◆ possible_traits_

config unit_type::possible_traits_

private

Definition at line 376 of file types.hpp.

Referenced by build_help_index(), and possible_traits().

◆ profile_

std::string unit_type::profile_

private

Definition at line 347 of file types.hpp.

Referenced by big_profile(), and build_help_index().

◆ race_

const unit_race* unit_type::race_

private

Never nullptr, but may point to the null race.

Definition at line 360 of file types.hpp.

Referenced by build_full(), build_help_index(), hide_help(), and race().

◆ recall_cost_

int unit_type::recall_cost_

private

Definition at line 335 of file types.hpp.

Referenced by build_help_index(), and recall_cost().

◆ small_profile_

std::string unit_type::small_profile_

private

Definition at line 346 of file types.hpp.

Referenced by build_help_index(), and small_profile().

◆ special_notes_

std::vector<t_string> unit_type::special_notes_

private

Definition at line 331 of file types.hpp.

Referenced by build_help_index(), direct_special_notes(), and special_notes().

◆ type_name_

t_string unit_type::type_name_

private

Definition at line 329 of file types.hpp.

Referenced by build_created(), build_help_index(), and type_name().

◆ undead_variation_

std::string unit_type::undead_variation_

private

Definition at line 342 of file types.hpp.

Referenced by build_full(), build_help_index(), and undead_variation().

◆ usage_

std::string unit_type::usage_

private

Definition at line 341 of file types.hpp.

Referenced by build_help_index(), and usage().

◆ variation_id_

std::string unit_type::variation_id_

private

Definition at line 356 of file types.hpp.

Referenced by variation_id().

◆ variation_name_

t_string unit_type::variation_name_

private

Definition at line 357 of file types.hpp.

Referenced by build_created(), and variation_name().

◆ variations_

variations_map unit_type::variations_

private

Definition at line 354 of file types.hpp.

Referenced by apply_scenario_fix(), build_created(), build_full(), build_help_index(), fill_variations(), get_variation(), has_variation(), remove_scenario_fixes(), show_variations_in_help(), variation_types(), and variations().

◆ vision_

int unit_type::vision_

private

Definition at line 337 of file types.hpp.

Referenced by build_help_index(), and vision().

◆ xp_bar_scaling_

double unit_type::xp_bar_scaling_

private

Definition at line 333 of file types.hpp.

Referenced by build_full(), and xp_bar_scaling().

◆ zoc_

bool unit_type::zoc_

private

Definition at line 364 of file types.hpp.

Referenced by build_full(), and has_zoc().

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

units/types.hpp
units/types.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ error

◆ variations_map

Member Enumeration Documentation

◆ BUILD_STATUS

Constructor & Destructor Documentation

◆ unit_type() [1/6]

◆ unit_type() [2/6]

◆ unit_type() [3/6]

◆ unit_type() [4/6]

◆ unit_type() [5/6]

◆ unit_type() [6/6]

◆ ~unit_type()

Member Function Documentation

◆ abilities_cfg()

◆ abilities_metadata()

◆ adv_abilities_metadata()

◆ advancement_tree()

◆ advancements()

◆ advances_from()

◆ advances_to()

◆ alignment()

◆ alignment_description()

◆ animations()

◆ apply_scenario_fix()

◆ attacks()

◆ big_profile()

◆ build() [1/2]

◆ build() [2/2]

◆ build_created()

◆ build_full()

◆ build_help_index()

◆ can_advance()

◆ check_id()

◆ cost()

◆ create_sub_type()

◆ default_variation()

◆ direct_special_notes()

◆ do_not_list()

◆ ellipse()

◆ events()

◆ experience_needed()

◆ fill_variations()

◆ fill_variations_and_gender()

◆ flag_rgb()

◆ genders()

◆ generate_name()

◆ get_ability_list()

◆ get_cfg()

◆ get_gender_unit_type() [1/2]

◆ get_gender_unit_type() [2/2]

◆ get_variation()

◆ halo()

◆ has_ability_by_id()

◆ has_gender_variation()

◆ has_random_traits()

◆ has_variation()

◆ has_zoc()

◆ hide_help()

◆ hitpoints()

◆ hp_bar_scaling()

◆ icon()

◆ id()

◆ image()

◆ jamming()

◆ level()

◆ log_id()

◆ max_attacks()

◆ modification_advancements()

◆ movement()

◆ movement_type()