The Battle for Wesnoth  1.17.0-dev
Classes | Typedefs | Functions
about Namespace Reference

Display credits about all contributors. More...

Classes

struct  credits_group
 

Typedefs

using credits_data = std::vector< credits_group >
 

Functions

const credits_dataget_credits_data ()
 Gets all credits data. More...
 
std::optional< credits_data::const_iterator > get_campaign_credits (const std::string &campaign)
 Gets credits for a given campaign. More...
 
std::vector< std::string > get_background_images (const std::string &campaign)
 Gets credit background images for a given campaaign. More...
 
void set_about (const game_config_view &cfg)
 Regenerates the credits data. More...
 

Detailed Description

Display credits about all contributors.

Typedef Documentation

◆ credits_data

using about::credits_data = typedef std::vector<credits_group>

Definition at line 56 of file about.hpp.

Function Documentation

◆ get_background_images()

std::vector< std::string > about::get_background_images ( const std::string &  campaign)

Gets credit background images for a given campaaign.

Definition at line 107 of file about.cpp.

Referenced by gui2::dialogs::end_credits::pre_show().

◆ get_campaign_credits()

std::optional< credits_data::const_iterator > about::get_campaign_credits ( const std::string &  campaign)

Gets credits for a given campaign.

Returns a null optional if that campaign has no credits.

Definition at line 100 of file about.cpp.

Referenced by gui2::dialogs::outro::outro().

◆ get_credits_data()

const credits_data & about::get_credits_data ( )

Gets all credits data.

Definition at line 95 of file about.cpp.

Referenced by gui2::dialogs::end_credits::pre_show().

◆ set_about()

void about::set_about ( const game_config_view cfg)

Regenerates the credits data.

Definition at line 116 of file about.cpp.

References config::add_child(), game_config_view::child_range(), and config::empty().

Referenced by game_config_manager::init_game_config().