The Battle for Wesnoth  1.15.0+dev
Public Member Functions | Public Attributes | List of all members
game_classification Class Reference

#include <game_classification.hpp>

Public Member Functions

 game_classification ()=default
 
 game_classification (const config &cfg)
 
config to_config () const
 
std::string get_tagname () const
 
bool is_normal_mp_game () const
 
 MAKE_ENUM (CAMPAIGN_TYPE,(SCENARIO, "scenario")(MULTIPLAYER, "multiplayer")(TEST, "test")(TUTORIAL, "tutorial")) CAMPAIGN_TYPE campaign_type
 

Public Attributes

std::string label
 Name of the game (e.g. More...
 
std::string version
 Version game was created with. More...
 
std::string campaign_define
 If there is a define the campaign uses to customize data. More...
 
std::vector< std::string > campaign_xtra_defines
 more customization of data More...
 
std::string scenario_define
 If there is a define the scenario uses to customize data. More...
 
std::string era_define
 If there is a define the era uses to customize data. More...
 
std::vector< std::string > mod_defines
 If there are defines the modifications use to customize data. More...
 
std::string campaign
 The id of the campaign being played. More...
 
std::string campaign_name
 The name of the campaign being played. More...
 
std::string abbrev
 the campaign abbreviation More...
 
bool end_credits = true
 whether to show the standard credits at the end More...
 
std::string end_text
 end-of-campaign text More...
 
unsigned int end_text_duration
 for how long the end-of-campaign text is shown More...
 
std::string difficulty = DEFAULT_DIFFICULTY
 The difficulty level the game is being played on. More...
 
std::string random_mode = ""
 
bool oos_debug = false
 

Detailed Description

Definition at line 27 of file game_classification.hpp.

Constructor & Destructor Documentation

◆ game_classification() [1/2]

game_classification::game_classification ( )
default

◆ game_classification() [2/2]

game_classification::game_classification ( const config cfg)
explicit

Definition at line 31 of file game_classification.cpp.

Member Function Documentation

◆ get_tagname()

std::string game_classification::get_tagname ( ) const

◆ is_normal_mp_game()

bool game_classification::is_normal_mp_game ( ) const

◆ MAKE_ENUM()

game_classification::MAKE_ENUM ( CAMPAIGN_TYPE  ,
(SCENARIO, "scenario")(MULTIPLAYER, "multiplayer")(TEST, "test")(TUTORIAL, "tutorial")   
)

◆ to_config()

config game_classification::to_config ( ) const

Member Data Documentation

◆ abbrev

std::string game_classification::abbrev

the campaign abbreviation

Definition at line 55 of file game_classification.hpp.

Referenced by ng::create_engine::prepare_for_campaign(), to_config(), and saved_game::update_label().

◆ campaign

std::string game_classification::campaign

◆ campaign_define

std::string game_classification::campaign_define

◆ campaign_name

std::string game_classification::campaign_name

The name of the campaign being played.

Definition at line 53 of file game_classification.hpp.

Referenced by mp::add_multiplayer_classification(), ng::create_engine::prepare_for_campaign(), and to_config().

◆ campaign_xtra_defines

std::vector<std::string> game_classification::campaign_xtra_defines

◆ difficulty

std::string game_classification::difficulty = DEFAULT_DIFFICULTY

◆ end_credits

bool game_classification::end_credits = true

whether to show the standard credits at the end

Definition at line 56 of file game_classification.hpp.

Referenced by game_lua_kernel::intf_set_end_campaign_credits(), game_launcher::launch_game(), and to_config().

◆ end_text

std::string game_classification::end_text

◆ end_text_duration

unsigned int game_classification::end_text_duration

for how long the end-of-campaign text is shown

Definition at line 58 of file game_classification.hpp.

Referenced by game_lua_kernel::intf_set_end_campaign_text(), game_launcher::launch_game(), ng::create_engine::prepare_for_campaign(), and to_config().

◆ era_define

std::string game_classification::era_define

If there is a define the era uses to customize data.

Definition at line 49 of file game_classification.hpp.

Referenced by game_config_manager::load_game_config_for_game(), ng::create_engine::prepare_for_era_and_mods(), mp::start_local_game_commandline(), and to_config().

◆ label

std::string game_classification::label

◆ mod_defines

std::vector<std::string> game_classification::mod_defines

If there are defines the modifications use to customize data.

Definition at line 50 of file game_classification.hpp.

Referenced by game_config_manager::load_game_config_for_game(), ng::create_engine::prepare_for_era_and_mods(), and to_config().

◆ oos_debug

bool game_classification::oos_debug = false

Definition at line 61 of file game_classification.hpp.

Referenced by ng::configure_engine::set_oos_debug(), and to_config().

◆ random_mode

std::string game_classification::random_mode = ""

◆ scenario_define

std::string game_classification::scenario_define

If there is a define the scenario uses to customize data.

Definition at line 48 of file game_classification.hpp.

Referenced by game_config_manager::load_game_config_for_game(), ng::create_engine::prepare_for_scenario(), mp::start_local_game_commandline(), and to_config().

◆ version

std::string game_classification::version

Version game was created with.

Definition at line 38 of file game_classification.hpp.

Referenced by savegame::loadgame::check_version_compatibility().


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