#include <race.hpp>

Public Types
enum	GENDER { MALE , FEMALE , NUM_GENDERS }

Public Member Functions
	unit_race (const config &cfg)

const config &	get_cfg () const

const std::string &	id () const

const std::string &	editor_icon () const

const t_string &	name (GENDER gender=MALE) const

const t_string &	plural_name () const

const t_string &	description () const

std::string	generate_name (GENDER gender) const

const name_generator &	generator (GENDER gender) const

bool	uses_global_traits () const

const config::const_child_itors &	additional_traits () const

const config::const_child_itors &	additional_topics () const

unsigned int	num_traits () const

const std::string &	undead_variation () const

std::string	get_icon_path_stem () const
	Gets this race's icon path without state/size suffix and extension. More...

const std::string &	help_taxonomy () const

Static Public Attributes
static const std::string	s_female
	Standard string id (not translatable) for FEMALE. More...

static const std::string	s_male
	Standard string id (not translatable) for MALE. More...

static const unit_race	null_race
	Dummy race used when a race is not yet known. More...

Private Member Functions
	unit_race ()
	Only used to construct null_race. More...

Private Attributes
const config	cfg_

std::string	id_

std::string	icon_

std::array< t_string, NUM_GENDERS >	name_

t_string	plural_name_

t_string	description_

unsigned int	ntraits_

std::array< std::shared_ptr< name_generator >, NUM_GENDERS >	name_generator_

config::const_child_itors	traits_

config::const_child_itors	topics_

bool	global_traits_

std::string	undead_variation_

std::string	help_taxonomy_

Detailed Description

Definition at line 25 of file race.hpp.

Member Enumeration Documentation

◆ GENDER

enum unit_race::GENDER

Enumerator
MALE
FEMALE
NUM_GENDERS

Definition at line 28 of file race.hpp.

Constructor & Destructor Documentation

◆ unit_race() [1/2]

unit_race::unit_race ( const config & cfg )

explicit

Definition at line 67 of file race.cpp.

References t_string::empty(), ERR_WML, FEMALE, gender_string(), name_generator_factory::get_name_generator(), i, id_, lg::log_to_chat(), MALE, n, name_, name_generator_, NUM_GENDERS, and plural_name_.

◆ unit_race() [2/2]

unit_race::unit_race ( )

private

Only used to construct null_race.

Definition at line 49 of file race.cpp.

References generator(), and name_generator_.

Member Function Documentation

◆ additional_topics()

const config::const_child_itors & unit_race::additional_topics ( ) const

Definition at line 131 of file race.cpp.

References topics_.

◆ additional_traits()

const config::const_child_itors & unit_race::additional_traits ( ) const

Definition at line 126 of file race.cpp.

References traits_.

Referenced by unit_type::build_help_index(), and impl_race_get().

◆ description()

const t_string& unit_race::description ( ) const

inline

Definition at line 40 of file race.hpp.

References description_.

Referenced by impl_race_get().

◆ editor_icon()

const std::string& unit_race::editor_icon ( ) const

inline

Definition at line 37 of file race.hpp.

References icon_.

◆ generate_name()

std::string unit_race::generate_name ( unit_race::GENDER gender ) const

Definition at line 111 of file race.cpp.

References name_generator_.

Referenced by unit::generate_name().

◆ generator()

const name_generator & unit_race::generator ( unit_race::GENDER gender ) const

Definition at line 116 of file race.cpp.

References name_generator_.

Referenced by impl_race_get(), and unit_race().

◆ get_cfg()

const config& unit_race::get_cfg ( ) const

inline

Definition at line 35 of file race.hpp.

References cfg_.

Referenced by impl_race_get().

◆ get_icon_path_stem()

std::string unit_race::get_icon_path_stem ( ) const

Gets this race's icon path without state/size suffix and extension.

This doesn't return the full path. Its output looks something like this: icons/unit-groups/race_elf

This is because this output is used in the editor for a GUI1 button's icon, and GUI1 automatically appends the state extension, such as "_30-pressed.png"

If a custom icon has been provided, that is used. Else, it checks if an appropriate icon exists in icons/unit-groups/. If not, a generic custom race icon will be used.

Definition at line 165 of file race.cpp.

References filesystem::get_binary_file_location(), icon_, id_, and game_config::path.

Referenced by gui2::unit_preview_pane::set_displayed_unit().