end_level_data Struct Reference

Additional information on the game outcome which can be provided by WML. More...

#include <game_end_exceptions.hpp>

Collaboration diagram for end_level_data:

List of all members.

Public Member Functions
	end_level_data ()
void	write (config &cfg) const
void	read (const config &cfg)
Public Attributes
bool	carryover_report
	Should a summary of the scenario outcome be displayed?
bool	prescenario_save
	Should a prescenario be created the next game?
bool	replay_save
	Should a replay save be made?
bool	linger_mode
	Should linger mode be invoked?
bool	gold_bonus
	Should early-finish bonus be applied?
int	carryover_percentage
	How much gold is carried over to next scenario.
bool	carryover_add
	Add or replace next scenario's minimum starting gold.
std::string	custom_endlevel_music
	Custom short music played at the end.
bool	reveal_map
	Should we reveal map when game is ended? (Multiplayer only).
bool	disabled
	Limits execution of tag [endlevel] to a single time >

---

Detailed Description

Additional information on the game outcome which can be provided by WML.

Definition at line 87 of file game_end_exceptions.hpp.

---

Constructor & Destructor Documentation

end_level_data::end_level_data

(

)

Definition at line 22 of file game_end_exceptions.cpp.

---

Member Function Documentation

void end_level_data::read

(

const config &

cfg

)

Definition at line 45 of file game_end_exceptions.cpp.

References carryover_add, carryover_percentage, gold_bonus, game_config::gold_carryover_percentage, prescenario_save, and replay_save.

Referenced by playsingle_controller::play_scenario().

Here is the caller graph for this function:

void end_level_data::write

(

config &

cfg

)

const

Definition at line 36 of file game_end_exceptions.cpp.

References carryover_add, carryover_percentage, gold_bonus, prescenario_save, and replay_save.

Referenced by play_controller::to_config().

Here is the caller graph for this function:

---

Member Data Documentation

bool end_level_data::carryover_add

Add or replace next scenario's minimum starting gold.

Definition at line 97 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), playsingle_controller::play_scenario(), read(), playsingle_controller::report_victory(), playsingle_controller::store_gold(), WML_HANDLER_FUNCTION(), and write().

int end_level_data::carryover_percentage

How much gold is carried over to next scenario.

Definition at line 96 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), playsingle_controller::play_scenario(), read(), playsingle_controller::report_victory(), playsingle_controller::store_gold(), WML_HANDLER_FUNCTION(), and write().

bool end_level_data::carryover_report

Should a summary of the scenario outcome be displayed?

Definition at line 91 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), playsingle_controller::play_scenario(), playsingle_controller::store_gold(), and WML_HANDLER_FUNCTION().

std::string end_level_data::custom_endlevel_music

Custom short music played at the end.

Definition at line 98 of file game_end_exceptions.hpp.

Referenced by playsingle_controller::play_scenario(), and WML_HANDLER_FUNCTION().

bool end_level_data::disabled

Limits execution of tag [endlevel] to a single time >

Definition at line 100 of file game_end_exceptions.hpp.

Referenced by playsingle_controller::play_scenario(), and WML_HANDLER_FUNCTION().

bool end_level_data::gold_bonus

Should early-finish bonus be applied?

Definition at line 95 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), read(), playsingle_controller::report_victory(), playsingle_controller::store_gold(), WML_HANDLER_FUNCTION(), and write().

bool end_level_data::linger_mode

Should linger mode be invoked?

Definition at line 94 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), play_controller::init(), playsingle_controller::play_scenario(), playmp_scenario(), playsingle_scenario(), and WML_HANDLER_FUNCTION().

bool end_level_data::prescenario_save

Should a prescenario be created the next game?

Definition at line 92 of file game_end_exceptions.hpp.

Referenced by events::console_handler::do_choose_level(), events::console_handler::do_next_level(), play_game(), read(), WML_HANDLER_FUNCTION(), and write().

bool end_level_data::replay_save

Should a replay save be made?

Definition at line 93 of file game_end_exceptions.hpp.

Referenced by play_game(), read(), WML_HANDLER_FUNCTION(), and write().

bool end_level_data::reveal_map

Should we reveal map when game is ended? (Multiplayer only).

Definition at line 99 of file game_end_exceptions.hpp.

Referenced by WML_HANDLER_FUNCTION().

---

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

• game_end_exceptions.hpp
• game_end_exceptions.cpp