Public Member Functions | Public Attributes

game_classification Class Reference

#include <gamestatus.hpp>

Inheritance diagram for game_classification:
Inheritance graph
[legend]
Collaboration diagram for game_classification:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 game_classification ()
 game_classification (const config &cfg)
 game_classification (const game_classification &gc)
config to_config () const

Public Attributes

std::string label
 Name of the game (e.g.
std::string parent
 Parent of the game (for save-threading purposes).
std::string version
 Version game was created with.
std::string campaign_type
 Type of the game - campaign, multiplayer etc.
std::string campaign_define
 If there is a define the campaign uses to customize data.
std::vector< std::string > campaign_xtra_defines
 more customization of data
std::string campaign
 the campaign being played
std::string history
 ancestral IDs
std::string abbrev
 the campaign abbreviation
std::string scenario
 the scenario being played
std::string next_scenario
 the scenario coming next (for campaigns)
std::string completion
 running.
bool end_credits
 whether to show the standard credits at the end
std::string end_text
 end-of-campaign text
unsigned int end_text_duration
 for how long the end-of-campaign text is shown
std::string difficulty
 The difficulty level the game is being played on.

Detailed Description

Definition at line 40 of file gamestatus.hpp.


Constructor & Destructor Documentation

game_classification::game_classification (  ) 

Definition at line 63 of file gamestatus.cpp.

game_classification::game_classification ( const config cfg  ) 

Definition at line 83 of file gamestatus.cpp.

game_classification::game_classification ( const game_classification gc  ) 

Definition at line 103 of file gamestatus.cpp.


Member Function Documentation

config game_classification::to_config (  )  const [virtual]

Implements savegame::savegame_config.

Definition at line 124 of file gamestatus.cpp.

References abbrev, campaign, campaign_define, campaign_type, campaign_xtra_defines, completion, difficulty, end_credits, end_text, end_text_duration, history, utils::join(), label, next_scenario, parent, scenario, str_cast(), and game_config::version.

Referenced by game_state::write_config().

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

the campaign abbreviation

Definition at line 58 of file gamestatus.hpp.

Referenced by game_controller::new_campaign(), play_game(), to_config(), and game_state::write_snapshot().

the campaign being played

Definition at line 56 of file gamestatus.hpp.

Referenced by game_controller::launch_game(), game_controller::new_campaign(), to_config(), and game_state::write_snapshot().

whether to show the standard credits at the end

Definition at line 62 of file gamestatus.hpp.

Referenced by game_controller::launch_game(), to_config(), WML_HANDLER_FUNCTION(), and game_state::write_snapshot().

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

Definition at line 64 of file gamestatus.hpp.

Referenced by game_controller::launch_game(), game_controller::new_campaign(), to_config(), WML_HANDLER_FUNCTION(), and game_state::write_snapshot().

ancestral IDs

Definition at line 57 of file gamestatus.hpp.

Referenced by to_config(), and game_state::write_snapshot().

Parent of the game (for save-threading purposes).

Definition at line 50 of file gamestatus.hpp.

Referenced by savegame::savegame::save_game(), and to_config().

Version game was created with.

Definition at line 51 of file gamestatus.hpp.

Referenced by savegame::loadgame::check_version_compatibility(), and savegame::loadgame::load_game().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by doxygen 1.7.1 on Thu May 24 2012 01:13:50 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs