Classes
class	help_manager

struct	max_recursion_reached
	Thrown when trying to create a sub-section deeper than the max allowed depth. More...

struct	parse_error
	Thrown when the help manager fails to parse something. More...

class	plain_text_topic_generator

class	section
	A help section. More...

struct	string_less

class	terrain_topic_generator

struct	topic
	A topic contains a title, an id and some text. More...

class	topic_text_generator
	Abstract topic generator base class. More...

class	unit_topic_generator

Typedefs
using	topic_list = std::list< topic >

using	trait_data = std::pair< std::string, std::string >

using	ter_data_cache = std::shared_ptr< terrain_type_data >

Enumerations
enum	UNIT_DESCRIPTION_TYPE { FULL_DESCRIPTION, NO_DESCRIPTION, NON_REVEALING_DESCRIPTION }

Functions
void	show_help (const std::string &show_topic="")
	Open the help browser, show topic with id show_topic. More...

void	reset ()
	Flags the help manager's contents for regeneration. More...

void	show_unit_description (const unit &u)

void	show_unit_description (const unit_type &t)

void	show_unit_help (const std::string &unit_id, bool has_variations=false, bool hidden=false)
	Open the help browser, show unit with id unit_id. More...

void	show_variation_help (const std::string &unit_id, const std::string &variation, bool hidden=false)
	Open the help browser, show the variation of the unit matching. More...

void	show_terrain_description (const terrain_type &t)

void	show_terrain_help (const std::string &unit_id, bool hidden=false)
	Open the help browser, show terrain with id terrain_id. More...

void	generate_races_sections (section &sec)

void	generate_terrain_sections (section &sec)

void	generate_era_sections (section &sec)

void	generate_unit_sections (section &sec, const std::string &race)

topic_list	generate_ability_topics (const bool sort_generated)

topic_list	generate_weapon_special_topics (const bool sort_generated)

topic_list	generate_time_of_day_topics (const bool)

topic_list	generate_trait_topics (const bool sort_generated)

topic_list	generate_unit_topics (const bool sort_generated, const std::string &race)

topic_list	generate_faction_topics (const bool sort_generated, const config &era)

topic_list	generate_era_topics (const bool sort_generated, const std::string &era_id)

std::string	hidden_symbol (bool hidden)

bool	is_visible_id (const std::string &id)
	An ID beginning with '. More...

bool	is_valid_id (const std::string &id)
	Return true if the id is valid for user defined topics and sections. More...

UNIT_DESCRIPTION_TYPE	description_type (const unit_type &type)

std::string	escape (const std::string &s)
	Prepend all chars with meaning inside attributes with a backslash. More...

ter_data_cache	load_terrain_types_data ()
	Load the appropriate terrain types data to use. More...

std::string	make_link (const std::string &text, const std::string &dst)

std::string	jump_to (const unsigned pos)

std::string	jump (const unsigned amount)

Variables
const unsigned	max_section_recursion_level = 15

const unsigned	max_history = 100

const std::string	default_topic = "..introduction"
	Topic to open by default when opening the help browser. More...

const std::string	unknown_unit_topic = ".unknown_unit"
	Topic to show when a unit hasn't been encountered in-game yet. More...

const std::string	ability_prefix = "ability_"

const std::string	era_prefix = "era_"

const std::string	faction_prefix = "faction_"

const std::string	race_prefix = "race_"

const std::string	terrain_prefix = "terrain_"

const std::string	tod_prefix = "time_of_day_"

const std::string	trait_prefix = "traits_"

const std::string	unit_prefix = "unit_"

const std::string	variation_prefix = "variation_"

const std::string	weapon_special_prefix = "weaponspecial_"

static help_manager	manager
	The help manager. More...

Typedef Documentation

◆ ter_data_cache

using help::ter_data_cache = typedef std::shared_ptr<terrain_type_data>

Definition at line 79 of file utils.hpp.

◆ topic_list

using help::topic_list = typedef std::list<topic>

Definition at line 78 of file topic.hpp.

◆ trait_data

using help::trait_data = typedef std::pair<std::string, std::string>

Definition at line 297 of file topic_text_generators.cpp.

Enumeration Type Documentation

◆ UNIT_DESCRIPTION_TYPE

enum help::UNIT_DESCRIPTION_TYPE

Enumerator
FULL_DESCRIPTION
NO_DESCRIPTION
NON_REVEALING_DESCRIPTION

Definition at line 46 of file utils.hpp.

Function Documentation

◆ description_type()

UNIT_DESCRIPTION_TYPE help::description_type ( const unit_type & type )

Definition at line 80 of file utils.cpp.

References game_config::debug, preferences::encountered_units(), FULL_DESCRIPTION, unit_type::id(), hotkey::is_scope_active(), NO_DESCRIPTION, hotkey::SCOPE_EDITOR, and preferences::show_all_units_in_help().

Referenced by help::unit_topic_generator::generate(), generate_ability_topics(), generate_races_sections(), generate_trait_topics(), generate_unit_topics(), and generate_weapon_special_topics().

◆ escape()

std::string help::escape ( const std::string & s )

Prepend all chars with meaning inside attributes with a backslash.

Definition at line 94 of file utils.cpp.

References utils::escape().

Referenced by help::unit_topic_generator::generate(), and make_link().

◆ generate_ability_topics()

topic_list help::generate_ability_topics ( const bool sort_generated )

Definition at line 91 of file topic_generators.cpp.

References _(), a, unit_type::abilities_metadata(), ability_prefix, unit_type::adv_abilities_metadata(), description_type(), FULL_DESCRIPTION, unit_type::hide_help(), unit_type::id(), make_link(), unit_type::type_name(), unit_type_data::types(), font::unicode_bullet, unit_prefix, and unit_types.

Referenced by help::section::generate_topics().

◆ generate_era_sections()

void help::generate_era_sections ( section & sec )

Definition at line 139 of file section_generators.cpp.

References help::section::add_section(), DBG_HP, config::debug(), preferences::era(), era_prefix, and game_config_manager::get().

Referenced by help::section::generate_sections().

◆ generate_era_topics()

topic_list help::generate_era_topics	(	const bool	sort_generated,
		const std::string &	era_id
	)

Definition at line 492 of file topic_generators.cpp.

References _(), config_attribute_value::empty(), preferences::era(), era_prefix, config::find_child(), game_config_manager::game_config(), generate_faction_topics(), game_config_manager::get(), make_link(), sort(), t, config_attribute_value::t_str(), and font::unicode_bullet.

Referenced by help::section::generate_topics().

◆ generate_faction_topics()

topic_list help::generate_faction_topics	(	const bool	sort_generated,
		const config &	era
	)

Definition at line 417 of file topic_generators.cpp.

References _(), unit_type::alignment_description(), config::child_range(), DBG_HP, config_attribute_value::empty(), f, faction_prefix, unit_type_data::find(), unit_type_data::find_race(), unit_type::genders(), unit_type::HELP_INDEXED, id, utils::join(), make_link(), unit_type::race_id(), race_prefix, utils::split(), t, config_attribute_value::t_str(), font::unicode_bullet, and unit_types.

Referenced by generate_era_topics().

◆ generate_races_sections()

void help::generate_races_sections ( section & sec )

Definition at line 42 of file section_generators.cpp.

References _(), help::section::add_section(), description_type(), unit_type_data::find_race(), FULL_DESCRIPTION, hidden_symbol(), unit_type::hide_help(), i, unit_type::race_id(), race_prefix, unit_type_data::types(), and unit_types.

Referenced by help::section::generate_sections().

◆ generate_terrain_sections()

void help::generate_terrain_sections ( section & sec )

Definition at line 79 of file section_generators.cpp.

References help::section::add_section(), help::section::add_topic(), terrain_type::editor_name(), preferences::encountered_terrains(), hidden_symbol(), terrain_type::hide_help(), terrain_type::id(), lg::info(), terrain_type::is_combined(), terrain_type::is_nonnull(), terrain_type::is_overlay(), load_terrain_types_data(), s, t, terrain_prefix, and WRN_HP.

Referenced by help::section::generate_sections().

◆ generate_time_of_day_topics()

topic_list help::generate_time_of_day_topics ( const bool )

Definition at line 232 of file topic_generators.cpp.

References _(), id, jump(), jump_to(), make_link(), resources::tod_manager, and tod_prefix.

Referenced by help::section::generate_topics().

◆ generate_trait_topics()

topic_list help::generate_trait_topics ( const bool sort_generated )

Definition at line 263 of file topic_generators.cpp.

References _(), a, description_type(), unit_type_data::find_race(), FULL_DESCRIPTION, i, name, unit_type::possible_traits(), unit_type::race_id(), trait_prefix, unit_type_data::traits(), unit_type_data::types(), and unit_types.

Referenced by help::section::generate_topics().

◆ generate_unit_sections()

void help::generate_unit_sections	(	section &	sec,
		const std::string &	race
	)

Definition at line 160 of file section_generators.cpp.

References help::section::add_section(), help::section::add_topic(), unit_type::get_variation(), hidden_symbol(), unit_type::hide_help(), i, unit_type::id(), unit_type::race_id(), unit_type::show_variations_in_help(), unit_type::type_name(), unit_type_data::types(), unit_prefix, unit_types, unit_type::variation_name(), variation_prefix, and unit_type::variations().

Referenced by help::section::generate_sections().

◆ generate_unit_topics()

topic_list help::generate_unit_topics	(	const bool	sort_generated,
		const std::string &	race
	)

Definition at line 335 of file topic_generators.cpp.

References _(), unit_type::alignment_description(), description_type(), unit_type_data::find_race(), FULL_DESCRIPTION, unit_type::genders(), hidden_symbol(), unit_type::hide_help(), i, unit_type::id(), utils::join(), make_link(), unit_type::race_id(), race_prefix, unit_type::show_variations_in_help(), unit_type::type_name(), unit_type_data::types(), font::unicode_bullet, unit_prefix, and unit_types.

Referenced by help::section::generate_topics().

◆ generate_weapon_special_topics()

topic_list help::generate_weapon_special_topics ( const bool sort_generated )

Definition at line 154 of file topic_generators.cpp.

References _(), unit_type::attacks(), config::child_range(), description_type(), FULL_DESCRIPTION, unit_type::hide_help(), unit_type::id(), make_link(), unit_type::modification_advancements(), s, unit_type::show_variations_in_help(), unit_type::type_name(), unit_type_data::types(), font::unicode_bullet, unit_prefix, unit_types, and weapon_special_prefix.

Referenced by help::section::generate_topics().

◆ hidden_symbol()

std::string help::hidden_symbol ( bool hidden )

Definition at line 44 of file utils.cpp.

Referenced by generate_races_sections(), generate_terrain_sections(), generate_unit_sections(), generate_unit_topics(), is_valid_id(), show_terrain_help(), show_unit_help(), and show_variation_help().

◆ is_valid_id()

bool help::is_valid_id ( const std::string & id )

Return true if the id is valid for user defined topics and sections.

Some IDs are special, such as toplevel and may not be be defined in the config.

Definition at line 54 of file utils.cpp.

References ability_prefix, translation::compare(), hidden_symbol(), unit_prefix, and weapon_special_prefix.

Referenced by help::section::initialize().

◆ is_visible_id()

bool help::is_visible_id ( const std::string & id )

An ID beginning with '.

' denotes a hidden section or topic.

Definition at line 49 of file utils.cpp.

Referenced by gui2::dialogs::help_browser::add_topics_for_section(), help::section::print_table_of_contents(), and help::section::print_table_of_contents_for().

◆ jump()

std::string help::jump ( const unsigned amount )

inline

Definition at line 74 of file utils.hpp.

Referenced by help::unit_topic_generator::generate(), and generate_time_of_day_topics().

◆ jump_to()

std::string help::jump_to ( const unsigned pos )

inline

Definition at line 69 of file utils.hpp.

Referenced by generate_time_of_day_topics().

◆ load_terrain_types_data()

ter_data_cache help::load_terrain_types_data ( )

Load the appropriate terrain types data to use.

Definition at line 99 of file utils.cpp.

References d, g, game_config_manager::get(), and display::get_singleton().

Referenced by help::terrain_topic_generator::generate(), help::unit_topic_generator::generate(), generate_terrain_sections(), and gui2::get_mp_tooltip().

◆ make_link()

std::string help::make_link	(	const std::string &	text,
		const std::string &	dst
	)

inline

Definition at line 63 of file utils.hpp.

References escape().

Referenced by help::terrain_topic_generator::generate(), help::unit_topic_generator::generate(), generate_ability_topics(), generate_era_topics(), generate_faction_topics(), generate_time_of_day_topics(), generate_unit_topics(), generate_weapon_special_topics(), help::section::print_table_of_contents(), and help::section::print_table_of_contents_for().

◆ reset()

void help::reset ( )

Flags the help manager's contents for regeneration.

Definition at line 41 of file help.cpp.

References help::help_manager::reset_contents().

Referenced by combatant::average_hp(), filesystem::file_tree_checksum::operator!=(), terrain_builder::tilemap::reload(), team::shroud_map::shroud_map(), terrain_builder::tilemap::tilemap(), editor::editor_controller::~editor_controller(), and play_controller::~play_controller().

◆ show_help()

void help::show_help ( const std::string & show_topic = "" )

Open the help browser, show topic with id show_topic.

If show_topic is the empty string, the default topic will be shown.

Definition at line 36 of file help.cpp.

References help::help_manager::open_help_browser_to().

Referenced by tooltips::click(), gui2::dialogs::addon_connect::help_button_callback(), game_lua_kernel::intf_open_help(), gui2::dialogs::title_screen::pre_show(), editor::editor_controller::save_map(), events::menu_handler::set_gui(), gui2::dialogs::unit_advance::show_help(), gui2::dialogs::unit_recruit::show_help(), gui2::dialogs::unit_recall::show_help(), events::menu_handler::show_help(), editor::editor_controller::show_help(), gui2::dialogs::addon_manager::show_help(), show_terrain_help(), show_unit_help(), show_variation_help(), and editor::editor_controller::unit_description().

◆ show_terrain_description()

void help::show_terrain_description ( const terrain_type & t )

Definition at line 89 of file help.cpp.

References terrain_type::hide_in_editor(), terrain_type::id(), terrain_type::is_combined(), and show_terrain_help().

Referenced by events::menu_handler::terrain_description(), and editor::editor_controller::terrain_description().

◆ show_terrain_help()

void help::show_terrain_help	(	const std::string &	unit_id,
		bool	hidden = `false`
	)

Open the help browser, show terrain with id terrain_id.

If show_topic is the empty string, the default topic will be shown.

Definition at line 94 of file help.cpp.

References hidden_symbol(), show_help(), and terrain_prefix.

Referenced by show_terrain_description().

◆ show_unit_description() [1/2]

void help::show_unit_description ( const unit & u )

Definition at line 46 of file help.cpp.

References unit::type().

Referenced by gui2::unit_preview_pane::profile_button_callback(), gui2::dialogs::faction_select::profile_button_callback(), and events::menu_handler::unit_description().

◆ show_unit_description() [2/2]

void help::show_unit_description ( const unit_type & t )

Definition at line 51 of file help.cpp.

References unit_type_data::find(), unit_type::get_cfg(), unit_type::hide_help(), unit_type::id(), show_unit_help(), show_variation_help(), unit_type::show_variations_in_help(), and unit_types.

◆ show_unit_help()

void help::show_unit_help	(	const std::string &	unit_id,
		bool	has_variations = `false`,
		bool	hidden = `false`
	)

Open the help browser, show unit with id unit_id.

If show_topic is the empty string, the default topic will be shown.

Definition at line 79 of file help.cpp.

References hidden_symbol(), show_help(), and unit_prefix.

Referenced by show_unit_description(), and editor::editor_controller::unit_description().

◆ show_variation_help()

void help::show_variation_help	(	const std::string &	unit,
		const std::string &	variation,
		bool	hidden
	)

Open the help browser, show the variation of the unit matching.

Definition at line 84 of file help.cpp.

References hidden_symbol(), show_help(), and variation_prefix.

Referenced by show_unit_description().

Variable Documentation

◆ ability_prefix

const std::string help::ability_prefix = "ability_"

Definition at line 25 of file constants.cpp.

Referenced by help::unit_topic_generator::generate(), generate_ability_topics(), and is_valid_id().

◆ default_topic

const std::string help::default_topic = "..introduction"

Topic to open by default when opening the help browser.

Definition at line 22 of file constants.cpp.

Referenced by help::help_manager::open_help_browser_to().

◆ era_prefix

const std::string help::era_prefix = "era_"

Definition at line 26 of file constants.cpp.

Referenced by generate_era_sections(), and generate_era_topics().

◆ faction_prefix

const std::string help::faction_prefix = "faction_"

Definition at line 27 of file constants.cpp.

Referenced by generate_faction_topics().

◆ manager

help_manager help::manager

static

The help manager.

What else would it be?

Definition at line 34 of file help.cpp.

Referenced by gui2::implementation::builder_window::build(), ng::create_engine::create_engine(), editor::editor_controller::custom_tods_dialog(), wfl::formula_expression::evaluate(), ng::depcheck::MAKE_ENUM(), fake_unit_ptr::place_on_fake_unit_manager(), and tod_manager::~tod_manager().

◆ max_history

const unsigned help::max_history = 100

Definition at line 20 of file constants.cpp.

◆ max_section_recursion_level

const unsigned help::max_section_recursion_level = 15

Definition at line 19 of file constants.cpp.

Referenced by help::section::initialize().

◆ race_prefix

const std::string help::race_prefix = "race_"

Definition at line 28 of file constants.cpp.

Referenced by generate_faction_topics(), generate_races_sections(), and generate_unit_topics().

◆ terrain_prefix

const std::string help::terrain_prefix = "terrain_"

Definition at line 29 of file constants.cpp.

Referenced by help::terrain_topic_generator::generate(), generate_terrain_sections(), and show_terrain_help().

◆ tod_prefix

const std::string help::tod_prefix = "time_of_day_"

Definition at line 30 of file constants.cpp.

Referenced by generate_time_of_day_topics().

◆ trait_prefix

const std::string help::trait_prefix = "traits_"

Definition at line 31 of file constants.cpp.

Referenced by generate_trait_topics().

◆ unit_prefix

const std::string help::unit_prefix = "unit_"

Definition at line 32 of file constants.cpp.

Referenced by help::unit_topic_generator::generate(), generate_ability_topics(), generate_unit_sections(), generate_unit_topics(), generate_weapon_special_topics(), is_valid_id(), and show_unit_help().

◆ unknown_unit_topic

const std::string help::unknown_unit_topic = ".unknown_unit"

Topic to show when a unit hasn't been encountered in-game yet.

Definition at line 23 of file constants.cpp.

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

◆ variation_prefix

const std::string help::variation_prefix = "variation_"

Definition at line 33 of file constants.cpp.

Referenced by help::unit_topic_generator::generate(), generate_unit_sections(), and show_variation_help().

◆ weapon_special_prefix

const std::string help::weapon_special_prefix = "weaponspecial_"

Definition at line 34 of file constants.cpp.

Referenced by generate_weapon_special_topics(), and is_valid_id().

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ ter_data_cache

◆ topic_list

◆ trait_data

Enumeration Type Documentation

◆ UNIT_DESCRIPTION_TYPE

Function Documentation

◆ description_type()

◆ escape()

◆ generate_ability_topics()

◆ generate_era_sections()

◆ generate_era_topics()

◆ generate_faction_topics()

◆ generate_races_sections()

◆ generate_terrain_sections()

◆ generate_time_of_day_topics()

◆ generate_trait_topics()

◆ generate_unit_sections()

◆ generate_unit_topics()

◆ generate_weapon_special_topics()

◆ hidden_symbol()

◆ is_valid_id()

◆ is_visible_id()

◆ jump()

◆ jump_to()

◆ load_terrain_types_data()

◆ make_link()

◆ reset()

◆ show_help()

◆ show_terrain_description()

◆ show_terrain_help()

◆ show_unit_description() [1/2]

◆ show_unit_description() [2/2]

◆ show_unit_help()

◆ show_variation_help()

Variable Documentation

◆ ability_prefix

◆ default_topic

◆ era_prefix

◆ faction_prefix

◆ manager

◆ max_history

◆ max_section_recursion_level

◆ race_prefix

◆ terrain_prefix

◆ tod_prefix

◆ trait_prefix

◆ unit_prefix

◆ unknown_unit_topic

◆ variation_prefix

◆ weapon_special_prefix