The Battle for Wesnoth  1.19.8+dev
Functions | Variables
settings Namespace Reference

Contains the general settings which have a default. More...

Functions

int get_turns (const std::string &value)
 Gets the number of turns. More...
 
int get_village_gold (const std::string &value, const game_classification *classification=nullptr)
 Gets the village gold. More...
 
int get_village_support (const std::string &value)
 Gets the village unit level support. More...
 
int get_xp_modifier (const std::string &value)
 Gets the xp modifier. More...
 
void set_default_values (ng::create_engine &create)
 
bool force_lock_settings (ng::create_engine &create)
 
std::string game_name_default ()
 
int num_turns_default (ng::create_engine &create)
 
int village_gold_default (ng::create_engine &create)
 
int village_support_default (ng::create_engine &create)
 
int xp_modifier_default (ng::create_engine &create)
 
std::chrono::seconds mp_countdown_init_time_default ()
 
std::chrono::seconds mp_countdown_reservoir_time_default ()
 
std::chrono::seconds mp_countdown_turn_bonus_default ()
 
std::chrono::seconds mp_countdown_action_bonus_default ()
 
bool mp_countdown_default ()
 
bool use_map_settings_default (ng::create_engine &create)
 
bool random_start_time_default (ng::create_engine &create)
 
bool fog_game_default (ng::create_engine &create)
 
bool shroud_game_default (ng::create_engine &create)
 
bool allow_observers_default ()
 
bool shuffle_sides_default ()
 
random_faction_mode::type random_faction_mode_default ()
 

Variables

const int turns_min = 1
 minimum number of turns More...
 
const int turns_max = 100
 maximum number of turns More...
 
const int turns_default = 100
 default number of turns More...
 
const int turns_step = 1
 slider step size for turns More...
 

Detailed Description

Contains the general settings which have a default.

These values can be used to initialize the preferences, but also to set map values if these aren't defined.

Function Documentation

◆ allow_observers_default()

bool settings::allow_observers_default ( )

Definition at line 167 of file map_settings.cpp.

References prefs::get().

◆ fog_game_default()

bool settings::fog_game_default ( ng::create_engine create)

◆ force_lock_settings()

bool settings::force_lock_settings ( ng::create_engine create)

◆ game_name_default()

std::string settings::game_name_default ( )

◆ get_turns()

int settings::get_turns ( const std::string &  value)

Gets the number of turns.

If no valid value supplied, it will return a default. The value is also range checked. When out of bounds, it will be set to the nearest bound.

Parameters
valuestring containing the number of turns
Returns
the number of turns

Definition at line 31 of file map_settings.cpp.

References turns_default, turns_max, and turns_min.

Referenced by num_turns_default(), and mp::start_local_game_commandline().

◆ get_village_gold()

int settings::get_village_gold ( const std::string &  value,
const game_classification classification = nullptr 
)

Gets the village gold.

If no valid value supplied, it will return a default. The default is 1 for singleplayer, and 2 for multiplayer.

Parameters
valuestring containing the village gold
classification
Returns
the village gold

Definition at line 43 of file map_settings.cpp.

References resources::classification, and game_classification::is_normal_mp_game().

Referenced by mp::start_local_game_commandline(), prefs::village_gold(), and village_gold_default().

◆ get_village_support()

int settings::get_village_support ( const std::string &  value)

Gets the village unit level support.

If no valid value supplied, it will return a default.

Parameters
valuestring containing the village support
Returns
the village support

Definition at line 48 of file map_settings.cpp.

Referenced by mp::start_local_game_commandline(), prefs::village_support(), and village_support_default().

◆ get_xp_modifier()

int settings::get_xp_modifier ( const std::string &  value)

Gets the xp modifier.

If no valid value supplied, it will return a default.

Parameters
valuestring containing the xp modifier
Returns
the xp modifier

Definition at line 53 of file map_settings.cpp.

Referenced by mp::start_local_game_commandline(), prefs::xp_modifier(), and xp_modifier_default().

◆ mp_countdown_action_bonus_default()

std::chrono::seconds settings::mp_countdown_action_bonus_default ( )

Definition at line 131 of file map_settings.cpp.

References prefs::countdown_action_bonus(), and prefs::get().

Referenced by set_default_values().

◆ mp_countdown_default()

bool settings::mp_countdown_default ( )

Definition at line 136 of file map_settings.cpp.

References prefs::get().

Referenced by set_default_values().

◆ mp_countdown_init_time_default()

std::chrono::seconds settings::mp_countdown_init_time_default ( )

Definition at line 116 of file map_settings.cpp.

References prefs::countdown_init_time(), and prefs::get().

Referenced by set_default_values().

◆ mp_countdown_reservoir_time_default()

std::chrono::seconds settings::mp_countdown_reservoir_time_default ( )

Definition at line 121 of file map_settings.cpp.

References prefs::countdown_reservoir_time(), and prefs::get().

Referenced by set_default_values().

◆ mp_countdown_turn_bonus_default()

std::chrono::seconds settings::mp_countdown_turn_bonus_default ( )

Definition at line 126 of file map_settings.cpp.

References prefs::countdown_turn_bonus(), and prefs::get().

◆ num_turns_default()

int settings::num_turns_default ( ng::create_engine create)

◆ random_faction_mode_default()

random_faction_mode::type settings::random_faction_mode_default ( )

◆ random_start_time_default()

bool settings::random_start_time_default ( ng::create_engine create)

◆ set_default_values()

void settings::set_default_values ( ng::create_engine create)

◆ shroud_game_default()

bool settings::shroud_game_default ( ng::create_engine create)

◆ shuffle_sides_default()

bool settings::shuffle_sides_default ( )

Definition at line 172 of file map_settings.cpp.

References prefs::get().

◆ use_map_settings_default()

bool settings::use_map_settings_default ( ng::create_engine create)

Definition at line 141 of file map_settings.cpp.

References force_lock_settings(), and prefs::get().

Referenced by set_default_values().

◆ village_gold_default()

int settings::village_gold_default ( ng::create_engine create)

◆ village_support_default()

int settings::village_support_default ( ng::create_engine create)

◆ xp_modifier_default()

int settings::xp_modifier_default ( ng::create_engine create)

Variable Documentation

◆ turns_default

const int settings::turns_default = 100

default number of turns

Definition at line 50 of file map_settings.hpp.

Referenced by get_turns().

◆ turns_max

const int settings::turns_max = 100

maximum number of turns

Definition at line 49 of file map_settings.hpp.

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

◆ turns_min

const int settings::turns_min = 1

minimum number of turns

Definition at line 48 of file map_settings.hpp.

Referenced by get_turns().

◆ turns_step

const int settings::turns_step = 1

slider step size for turns

Definition at line 51 of file map_settings.hpp.