#include <configure_engine.hpp>

Public Member Functions
	configure_engine (saved_game &state, const config *initial=nullptr)

void	set_default_values ()
	Set all parameters to their default values. More...

bool	force_lock_settings () const
	Checks force_lock_settings in config. More...

std::string	game_name () const

int	num_turns () const

int	village_gold () const

int	village_support () const

int	xp_modifier () const

int	mp_countdown_init_time () const

int	mp_countdown_reservoir_time () const

int	mp_countdown_turn_bonus () const

int	mp_countdown_action_bonus () const

bool	mp_countdown () const

bool	use_map_settings () const

bool	random_start_time () const

bool	fog_game () const

bool	shroud_game () const

bool	allow_observers () const

bool	shuffle_sides () const

random_faction_mode::type	mode () const

const config &	options () const

void	set_game_name (const std::string &name)

void	set_game_password (const std::string &name)

void	set_num_turns (int val)

void	set_village_gold (int val)

void	set_village_support (int val)

void	set_xp_modifier (int val)

void	set_mp_countdown_init_time (int val)

void	set_mp_countdown_reservoir_time (int val)

void	set_mp_countdown_turn_bonus (int val)

void	set_mp_countdown_action_bonus (int val)

void	set_mp_countdown (bool val)

void	set_use_map_settings (bool val)

void	set_random_start_time (bool val)

void	set_fog_game (bool val)

void	set_shroud_game (bool val)

void	set_allow_observers (bool val)

void	set_private_replay (bool val)

void	set_oos_debug (bool val)

void	set_shuffle_sides (bool val)

void	set_random_faction_mode (random_faction_mode::type val)

void	set_options (const config &cfg)

int	num_turns_default () const

int	village_gold_default () const

int	village_support_default () const

int	xp_modifier_default () const

int	mp_countdown_init_time_default () const

int	mp_countdown_reservoir_time_default () const

int	mp_countdown_turn_bonus_default () const

int	mp_countdown_action_bonus_default () const

bool	mp_countdown_default () const

bool	use_map_settings_default () const

bool	random_start_time_default () const

bool	fog_game_default () const

bool	shroud_game_default () const

bool	allow_observers_default () const

bool	shuffle_sides_default () const

random_faction_mode::type	random_faction_mode_default () const

const config &	options_default () const

const mp_game_settings &	get_parameters () const

void	write_parameters ()

void	update_initial_cfg (const config &cfg)

Static Public Member Functions
static std::string	game_name_default ()

Private Member Functions
const config &	side_cfg () const
	Village gold, village support, fog, and shroud are per player but always show the player 1's values. More...

const config &	initial_cfg () const

Private Attributes
saved_game &	state_

mp_game_settings &	parameters_

const config *	initial_
	Never nullptr. More...

Detailed Description

configure_engine

this class wraps the parameters relevant to mp_configure, as well as providing defaults for these parameters.

Definition at line 30 of file configure_engine.hpp.

Constructor & Destructor Documentation

◆ configure_engine()

ng::configure_engine::configure_engine	(	saved_game &	state,
		const config *	initial = `nullptr`
	)

Definition at line 29 of file configure_engine.cpp.

References set_use_map_settings(), and use_map_settings_default().

Member Function Documentation

◆ allow_observers()

bool ng::configure_engine::allow_observers ( ) const

inline

Definition at line 115 of file configure_engine.hpp.

References mp_game_settings::allow_observers, and parameters_.

◆ allow_observers_default()

bool ng::configure_engine::allow_observers_default ( ) const

Definition at line 142 of file configure_engine.cpp.

References preferences::allow_observers().

◆ fog_game()

bool ng::configure_engine::fog_game ( ) const

inline

Definition at line 105 of file configure_engine.hpp.

References mp_game_settings::fog_game, and parameters_.

◆ fog_game_default()

bool ng::configure_engine::fog_game_default ( ) const

Definition at line 130 of file configure_engine.cpp.

References saved_game::classification(), preferences::fog(), initial_cfg(), game_classification::is_normal_mp_game(), state_, and use_map_settings().

Referenced by set_default_values().

◆ force_lock_settings()

bool ng::configure_engine::force_lock_settings ( ) const

Checks force_lock_settings in config.

Definition at line 55 of file configure_engine.cpp.

References saved_game::classification(), initial_cfg(), game_classification::is_normal_mp_game(), and state_.

Referenced by use_map_settings_default().

◆ game_name()

std::string ng::configure_engine::game_name ( ) const

inline

Definition at line 45 of file configure_engine.hpp.

References mp_game_settings::name, and parameters_.

◆ game_name_default()

std::string ng::configure_engine::game_name_default ( )

static

Definition at line 60 of file configure_engine.cpp.

References preferences::login(), and VGETTEXT.

Referenced by gui2::dialogs::mp_create_game::post_show(), gui2::dialogs::mp_create_game::pre_show(), and set_default_values().

◆ get_parameters()

const mp_game_settings& ng::configure_engine::get_parameters ( ) const

inline

Definition at line 264 of file configure_engine.hpp.

References parameters_.

◆ initial_cfg()

const config& ng::configure_engine::initial_cfg ( ) const

inlineprivate

Definition at line 301 of file configure_engine.hpp.

References initial_.

Referenced by fog_game_default(), force_lock_settings(), num_turns_default(), random_start_time_default(), shroud_game_default(), village_gold_default(), village_support_default(), and xp_modifier_default().

◆ mode()

random_faction_mode::type ng::configure_engine::mode ( ) const

inline

Definition at line 125 of file configure_engine.hpp.

References mp_game_settings::mode, and parameters_.

◆ mp_countdown()

bool ng::configure_engine::mp_countdown ( ) const

inline

Definition at line 90 of file configure_engine.hpp.

References mp_game_settings::mp_countdown, and parameters_.

◆ mp_countdown_action_bonus()

int ng::configure_engine::mp_countdown_action_bonus ( ) const

inline

Definition at line 85 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_action_bonus, and parameters_.

◆ mp_countdown_action_bonus_default()

int ng::configure_engine::mp_countdown_action_bonus_default ( ) const

Definition at line 108 of file configure_engine.cpp.

References preferences::countdown_action_bonus().

Referenced by set_default_values().

◆ mp_countdown_default()

bool ng::configure_engine::mp_countdown_default ( ) const

Definition at line 113 of file configure_engine.cpp.

References preferences::countdown().

Referenced by set_default_values().

◆ mp_countdown_init_time()

int ng::configure_engine::mp_countdown_init_time ( ) const

inline

Definition at line 70 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_init_time, and parameters_.

◆ mp_countdown_init_time_default()

int ng::configure_engine::mp_countdown_init_time_default ( ) const

Definition at line 93 of file configure_engine.cpp.

References preferences::countdown_init_time().

Referenced by set_default_values().

◆ mp_countdown_reservoir_time()

int ng::configure_engine::mp_countdown_reservoir_time ( ) const

inline

Definition at line 75 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_reservoir_time, and parameters_.

◆ mp_countdown_reservoir_time_default()

int ng::configure_engine::mp_countdown_reservoir_time_default ( ) const

Definition at line 98 of file configure_engine.cpp.

References preferences::countdown_reservoir_time().

Referenced by set_default_values().

◆ mp_countdown_turn_bonus()

int ng::configure_engine::mp_countdown_turn_bonus ( ) const

inline

Definition at line 80 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_turn_bonus, and parameters_.

◆ mp_countdown_turn_bonus_default()

int ng::configure_engine::mp_countdown_turn_bonus_default ( ) const

Definition at line 103 of file configure_engine.cpp.

References preferences::countdown_turn_bonus().

◆ num_turns()

int ng::configure_engine::num_turns ( ) const

inline

Definition at line 50 of file configure_engine.hpp.

References mp_game_settings::num_turns, and parameters_.

◆ num_turns_default()

int ng::configure_engine::num_turns_default ( ) const

Definition at line 67 of file configure_engine.cpp.

References settings::get_turns(), initial_cfg(), preferences::turns(), and use_map_settings().

Referenced by set_default_values().

◆ options()

const config& ng::configure_engine::options ( ) const

inline

Definition at line 130 of file configure_engine.hpp.

References mp_game_settings::options, and parameters_.

◆ options_default()

const config & ng::configure_engine::options_default ( ) const

Definition at line 163 of file configure_engine.cpp.

References preferences::options().

◆ random_faction_mode_default()

random_faction_mode::type ng::configure_engine::random_faction_mode_default ( ) const

Definition at line 152 of file configure_engine.cpp.

References string_enums::enum_base< Definition >::get_enum(), and preferences::random_faction_mode().

Referenced by set_default_values().

◆ random_start_time()

bool ng::configure_engine::random_start_time ( ) const

inline

Definition at line 100 of file configure_engine.hpp.

References parameters_, and mp_game_settings::random_start_time.

◆ random_start_time_default()

bool ng::configure_engine::random_start_time_default ( ) const

Definition at line 123 of file configure_engine.cpp.

References initial_cfg(), preferences::random_start_time(), and use_map_settings().

Referenced by set_default_values().

◆ set_allow_observers()

void ng::configure_engine::set_allow_observers ( bool val )

inline

Definition at line 214 of file configure_engine.hpp.

References mp_game_settings::allow_observers, and parameters_.

◆ set_default_values()

void ng::configure_engine::set_default_values ( )

◆ set_fog_game()

void ng::configure_engine::set_fog_game ( bool val )

inline

Definition at line 204 of file configure_engine.hpp.

References mp_game_settings::fog_game, and parameters_.

Referenced by set_default_values().

◆ set_game_name()

void ng::configure_engine::set_game_name ( const std::string & name )

inline

Definition at line 139 of file configure_engine.hpp.

References mp_game_settings::name, and parameters_.

Referenced by set_default_values().

◆ set_game_password()

void ng::configure_engine::set_game_password ( const std::string & name )

inline

Definition at line 144 of file configure_engine.hpp.

References parameters_, and mp_game_settings::password.

◆ set_mp_countdown()

void ng::configure_engine::set_mp_countdown ( bool val )

inline

Definition at line 189 of file configure_engine.hpp.

References mp_game_settings::mp_countdown, and parameters_.

Referenced by set_default_values().

◆ set_mp_countdown_action_bonus()

void ng::configure_engine::set_mp_countdown_action_bonus ( int val )

inline

Definition at line 184 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_action_bonus, and parameters_.

Referenced by set_default_values().

◆ set_mp_countdown_init_time()

void ng::configure_engine::set_mp_countdown_init_time ( int val )

inline

Definition at line 169 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_init_time, and parameters_.

Referenced by set_default_values().

◆ set_mp_countdown_reservoir_time()

void ng::configure_engine::set_mp_countdown_reservoir_time ( int val )

inline

Definition at line 174 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_reservoir_time, and parameters_.

Referenced by set_default_values().

◆ set_mp_countdown_turn_bonus()

void ng::configure_engine::set_mp_countdown_turn_bonus ( int val )

inline

Definition at line 179 of file configure_engine.hpp.

References mp_game_settings::mp_countdown_turn_bonus, and parameters_.

◆ set_num_turns()

void ng::configure_engine::set_num_turns ( int val )

inline

Definition at line 149 of file configure_engine.hpp.

References mp_game_settings::num_turns, and parameters_.

Referenced by set_default_values().

◆ set_oos_debug()

void ng::configure_engine::set_oos_debug ( bool val )

inline

Definition at line 224 of file configure_engine.hpp.

References saved_game::classification(), game_classification::oos_debug, and state_.

◆ set_options()

void ng::configure_engine::set_options ( const config & cfg )

Definition at line 157 of file configure_engine.cpp.

References mp_game_settings::options, parameters_, and preferences::set_options().

Referenced by gui2::dialogs::sp_options_configure::post_show().

◆ set_private_replay()

void ng::configure_engine::set_private_replay ( bool val )

inline

Definition at line 219 of file configure_engine.hpp.

References parameters_, and mp_game_settings::private_replay.

◆ set_random_faction_mode()

void ng::configure_engine::set_random_faction_mode ( random_faction_mode::type val )

inline

Definition at line 234 of file configure_engine.hpp.

References mp_game_settings::mode, and parameters_.

Referenced by set_default_values().

◆ set_random_start_time()

void ng::configure_engine::set_random_start_time ( bool val )

inline

Definition at line 199 of file configure_engine.hpp.

References parameters_, and mp_game_settings::random_start_time.

Referenced by set_default_values().

◆ set_shroud_game()

void ng::configure_engine::set_shroud_game ( bool val )

inline

Definition at line 209 of file configure_engine.hpp.

References parameters_, and mp_game_settings::shroud_game.

Referenced by set_default_values().

◆ set_shuffle_sides()

void ng::configure_engine::set_shuffle_sides ( bool val )

inline

Definition at line 229 of file configure_engine.hpp.

References parameters_, and mp_game_settings::shuffle_sides.

◆ set_use_map_settings()

void ng::configure_engine::set_use_map_settings ( bool val )

inline

Definition at line 194 of file configure_engine.hpp.

References parameters_, and mp_game_settings::use_map_settings.

Referenced by configure_engine(), and set_default_values().

◆ set_village_gold()

void ng::configure_engine::set_village_gold ( int val )

inline

Definition at line 154 of file configure_engine.hpp.

References parameters_, and mp_game_settings::village_gold.

Referenced by set_default_values().

◆ set_village_support()

void ng::configure_engine::set_village_support ( int val )

inline

Definition at line 159 of file configure_engine.hpp.

References parameters_, and mp_game_settings::village_support.

Referenced by set_default_values().

◆ set_xp_modifier()

void ng::configure_engine::set_xp_modifier ( int val )

inline

Definition at line 164 of file configure_engine.hpp.

References parameters_, and mp_game_settings::xp_modifier.

Referenced by set_default_values().

◆ shroud_game()

bool ng::configure_engine::shroud_game ( ) const

inline

Definition at line 110 of file configure_engine.hpp.

References parameters_, and mp_game_settings::shroud_game.

◆ shroud_game_default()

bool ng::configure_engine::shroud_game_default ( ) const

Definition at line 137 of file configure_engine.cpp.

References initial_cfg(), preferences::shroud(), and use_map_settings().

Referenced by set_default_values().

◆ shuffle_sides()

bool ng::configure_engine::shuffle_sides ( ) const

inline

Definition at line 120 of file configure_engine.hpp.

References parameters_, and mp_game_settings::shuffle_sides.

◆ shuffle_sides_default()

bool ng::configure_engine::shuffle_sides_default ( ) const

Definition at line 147 of file configure_engine.cpp.

References preferences::shuffle_sides().

◆ side_cfg()

const config& ng::configure_engine::side_cfg ( ) const

inlineprivate

Village gold, village support, fog, and shroud are per player but always show the player 1's values.

Todo:: This might not be 100% correct, but at the moment it is not possible to show fog and shroud per player. This might change in the future.

Todo:: : Is the above even still true? – vultraz, 2017-10-05

NOTE when 'load game' is selected there are no sides.

Definition at line 296 of file configure_engine.hpp.

References config::child_or_empty(), and initial_.

◆ update_initial_cfg()

void ng::configure_engine::update_initial_cfg ( const config & cfg )

inline

Definition at line 271 of file configure_engine.hpp.

References initial_.

Referenced by sp::configure_campaign().

◆ use_map_settings()

bool ng::configure_engine::use_map_settings ( ) const

inline

Definition at line 95 of file configure_engine.hpp.

References parameters_, and mp_game_settings::use_map_settings.

Referenced by fog_game_default(), num_turns_default(), random_start_time_default(), shroud_game_default(), village_gold_default(), village_support_default(), and xp_modifier_default().

◆ use_map_settings_default()

bool ng::configure_engine::use_map_settings_default ( ) const

Definition at line 118 of file configure_engine.cpp.

References force_lock_settings(), and preferences::use_map_settings().

Referenced by configure_engine(), and set_default_values().

◆ village_gold()

int ng::configure_engine::village_gold ( ) const

inline

Definition at line 55 of file configure_engine.hpp.

References parameters_, and mp_game_settings::village_gold.

◆ village_gold_default()

int ng::configure_engine::village_gold_default ( ) const

Definition at line 72 of file configure_engine.cpp.

References saved_game::classification(), settings::get_village_gold(), initial_cfg(), state_, use_map_settings(), and preferences::village_gold().

Referenced by set_default_values().

◆ village_support()

int ng::configure_engine::village_support ( ) const

inline

Definition at line 60 of file configure_engine.hpp.

References parameters_, and mp_game_settings::village_support.

◆ village_support_default()

int ng::configure_engine::village_support_default ( ) const

Definition at line 79 of file configure_engine.cpp.

References settings::get_village_support(), initial_cfg(), use_map_settings(), and preferences::village_support().

Referenced by set_default_values().

◆ write_parameters()

void ng::configure_engine::write_parameters ( )

Definition at line 168 of file configure_engine.cpp.

References mp_game_settings::fog_game, saved_game::get_starting_point(), tod_manager::is_start_ToD(), saved_game::mp_settings(), mp_game_settings::num_turns, mp_game_settings::random_start_time, mp_game_settings::shroud_game, state_, mp_game_settings::use_map_settings, mp_game_settings::village_gold, mp_game_settings::village_support, and mp_game_settings::xp_modifier.

◆ xp_modifier()

int ng::configure_engine::xp_modifier ( ) const

inline

Definition at line 65 of file configure_engine.hpp.

References parameters_, and mp_game_settings::xp_modifier.

◆ xp_modifier_default()

int ng::configure_engine::xp_modifier_default ( ) const

Definition at line 86 of file configure_engine.cpp.

References settings::get_xp_modifier(), initial_cfg(), use_map_settings(), and preferences::xp_modifier().

Referenced by set_default_values().

Member Data Documentation

◆ initial_

const config* ng::configure_engine::initial_

private

Never nullptr.

Definition at line 282 of file configure_engine.hpp.

Referenced by initial_cfg(), side_cfg(), and update_initial_cfg().

◆ parameters_

mp_game_settings& ng::configure_engine::parameters_

private

Definition at line 279 of file configure_engine.hpp.

Referenced by allow_observers(), fog_game(), game_name(), get_parameters(), mode(), mp_countdown(), mp_countdown_action_bonus(), mp_countdown_init_time(), mp_countdown_reservoir_time(), mp_countdown_turn_bonus(), num_turns(), options(), random_start_time(), set_allow_observers(), set_fog_game(), set_game_name(), set_game_password(), set_mp_countdown(), set_mp_countdown_action_bonus(), set_mp_countdown_init_time(), set_mp_countdown_reservoir_time(), set_mp_countdown_turn_bonus(), set_num_turns(), set_options(), set_private_replay(), set_random_faction_mode(), set_random_start_time(), set_shroud_game(), set_shuffle_sides(), set_use_map_settings(), set_village_gold(), set_village_support(), set_xp_modifier(), shroud_game(), shuffle_sides(), use_map_settings(), village_gold(), village_support(), and xp_modifier().

◆ state_

saved_game& ng::configure_engine::state_

private

Definition at line 277 of file configure_engine.hpp.

Referenced by fog_game_default(), force_lock_settings(), set_oos_debug(), village_gold_default(), and write_parameters().

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

game_initialization/configure_engine.hpp
game_initialization/configure_engine.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ configure_engine()

Member Function Documentation

◆ allow_observers()

◆ allow_observers_default()

◆ fog_game()

◆ fog_game_default()

◆ force_lock_settings()

◆ game_name()

◆ game_name_default()

◆ get_parameters()

◆ initial_cfg()

◆ mode()

◆ mp_countdown()

◆ mp_countdown_action_bonus()

◆ mp_countdown_action_bonus_default()

◆ mp_countdown_default()

◆ mp_countdown_init_time()

◆ mp_countdown_init_time_default()

◆ mp_countdown_reservoir_time()

◆ mp_countdown_reservoir_time_default()

◆ mp_countdown_turn_bonus()

◆ mp_countdown_turn_bonus_default()

◆ num_turns()

◆ num_turns_default()

◆ options()

◆ options_default()

◆ random_faction_mode_default()

◆ random_start_time()

◆ random_start_time_default()

◆ set_allow_observers()

◆ set_default_values()

◆ set_fog_game()

◆ set_game_name()

◆ set_game_password()

◆ set_mp_countdown()

◆ set_mp_countdown_action_bonus()

◆ set_mp_countdown_init_time()

◆ set_mp_countdown_reservoir_time()

◆ set_mp_countdown_turn_bonus()

◆ set_num_turns()

◆ set_oos_debug()

◆ set_options()

◆ set_private_replay()

◆ set_random_faction_mode()

◆ set_random_start_time()

◆ set_shroud_game()

◆ set_shuffle_sides()

◆ set_use_map_settings()

◆ set_village_gold()

◆ set_village_support()

◆ set_xp_modifier()

◆ shroud_game()

◆ shroud_game_default()

◆ shuffle_sides()

◆ shuffle_sides_default()

◆ side_cfg()

◆ update_initial_cfg()

◆ use_map_settings()

◆ use_map_settings_default()

◆ village_gold()

◆ village_gold_default()

◆ village_support()

◆ village_support_default()

◆ write_parameters()

◆ xp_modifier()

◆ xp_modifier_default()

Member Data Documentation

◆ initial_

◆ parameters_

◆ state_