game_classification Class Reference

#include <game_classification.hpp>

Public Member Functions
	game_classification ()
	game_classification (const config &cfg)
	game_classification (const game_classification &gc)
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 campaign being played More...
std::string	abbrev
	the campaign abbreviation More...
bool	end_credits
	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
	The difficulty level the game is being played on. More...
std::string	random_mode
bool	oos_debug

Detailed Description

Definition at line 28 of file game_classification.hpp.

Constructor & Destructor Documentation

game_classification::game_classification

(

)

Definition at line 32 of file game_classification.cpp.

game_classification::game_classification ( const config &  cfg )

explicit

Definition at line 51 of file game_classification.cpp.

game_classification::game_classification

(

const game_classification &

gc

)

Definition at line 70 of file game_classification.cpp.

Member Function Documentation

std::string game_classification::get_tagname

(

)

const

Definition at line 113 of file game_classification.cpp.

References campaign.

Referenced by ng::configure_engine::configure_engine(), and saved_game::set_defaults().

bool game_classification::is_normal_mp_game

(

)

const

Definition at line 123 of file game_classification.cpp.

References campaign.

Referenced by ng::connect_engine::connect_engine(), ng::configure_engine::fog_game_default(), ng::configure_engine::force_lock_settings(), settings::get_village_gold(), mp::wait::join_game(), game_launcher::launch_game(), and campaign_controller::play_game().

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

config game_classification::to_config

(

)

const

Definition at line 90 of file game_classification.cpp.

References abbrev, campaign, campaign_define, campaign_xtra_defines, difficulty, end_credits, end_text, end_text_duration, era_define, utils::join(), label, mod_defines, oos_debug, random_mode, scenario_define, and game_config::version.

Referenced by saved_game::to_config(), and saved_game::write_general_info().

Member Data Documentation

std::string game_classification::abbrev

the campaign abbreviation

Definition at line 56 of file game_classification.hpp.

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

std::string game_classification::campaign

the campaign being played

Definition at line 54 of file game_classification.hpp.

Referenced by mp::add_multiplayer_classification(), mp::configure::configure(), saved_game::expand_mp_events(), get_tagname(), is_normal_mp_game(), game_launcher::launch_game(), game_config_manager::load_game_config(), ng::create_engine::prepare_for_campaign(), and to_config().

std::string game_classification::campaign_define

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

Definition at line 48 of file game_classification.hpp.

Referenced by game_config_manager::load_game_config_for_game(), game_launcher::play_test(), ng::create_engine::prepare_for_campaign(), game_launcher::set_tutorial(), to_config(), and game_launcher::unit_test().

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

more customization of 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_campaign(), and to_config().

std::string game_classification::difficulty

The difficulty level the game is being played on.

Definition at line 60 of file game_classification.hpp.

Referenced by mp::add_multiplayer_classification(), game_launcher::launch_game(), game_config_manager::load_game_config_for_game(), ng::create_engine::prepare_for_campaign(), and to_config().

bool game_classification::end_credits

whether to show the standard credits at the end

Definition at line 57 of file game_classification.hpp.

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

std::string game_classification::end_text

end-of-campaign text

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().

unsigned int game_classification::end_text_duration

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

Definition at line 59 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().

std::string game_classification::era_define

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

Definition at line 51 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().

std::string game_classification::label

Name of the game (e.g.

name of save file).

Definition at line 39 of file game_classification.hpp.

Referenced by savegame::autosave_savegame::create_filename(), play_controller::hotkey_handler::expand_autosaves(), campaign_controller::play_game(), savegame::scenariostart_savegame::scenariostart_savegame(), to_config(), game_launcher::unit_test(), and saved_game::update_label().

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

If there are defines the modifications use to customize data.

Definition at line 52 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().

bool game_classification::oos_debug

Definition at line 62 of file game_classification.hpp.

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

std::string game_classification::random_mode

Definition at line 61 of file game_classification.hpp.

Referenced by sp::enter_create_mode(), synced_context::get_rng_for_action(), playsingle_controller::play_scenario_init(), and to_config().

std::string game_classification::scenario_define

If there is a define the scenario uses 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_scenario(), mp::start_local_game_commandline(), and to_config().

std::string game_classification::version

Version game was created with.

Definition at line 40 of file game_classification.hpp.

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

---

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

• game_classification.hpp
• game_classification.cpp