The Battle for Wesnoth  1.19.0-dev
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
preferences Namespace Reference

Modify, read and display user preferences. More...

Namespaces

 editor
 

Classes

class  advanced_manager
 
struct  manager
 
class  acquaintance
 
class  prefs_event_handler
 
struct  base_manager
 

Typedefs

using advanced_pref_list = std::vector< advanced_manager::option >
 

Enumerations

enum  PREFERENCE_VIEW { VIEW_DEFAULT , VIEW_FRIENDS }
 
enum class  lobby_joins { show_none , show_friends , show_all }
 

Functions

void init_advanced_manager (const game_config_view &gc)
 Initializes the manager singleton. More...
 
const advanced_pref_listget_advanced_preferences ()
 Gets a list of the available advanced preferences. More...
 
std::string login ()
 
void set_login (const std::string &login)
 
bool remember_password ()
 
void set_remember_password (bool remember)
 
std::string password (const std::string &server, const std::string &login)
 
void set_password (const std::string &server, const std::string &login, const std::string &key)
 
void load_credentials ()
 
void save_credentials ()
 
void set_color_cursors (bool value)
 
bool show_standing_animations ()
 
void set_show_standing_animations (bool value)
 
bool show_theme_dialog ()
 
void show_wesnothd_server_search ()
 
void load_game_prefs ()
 
static void load_acquaintances ()
 
static void save_acquaintances ()
 
const std::map< std::string, acquaintance > & get_acquaintances ()
 
const std::string get_ignored_delim ()
 
std::map< std::string, std::string > get_acquaintances_nice (const std::string &filter)
 
std::pair< preferences::acquaintance *, bool > add_acquaintance (const std::string &nick, const std::string &mode, const std::string &notes)
 
bool remove_acquaintance (const std::string &nick)
 
bool is_friend (const std::string &nick)
 
bool is_ignored (const std::string &nick)
 
void add_completed_campaign (const std::string &campaign_id, const std::string &difficulty_level)
 
bool is_campaign_completed (const std::string &campaign_id)
 
bool is_campaign_completed (const std::string &campaign_id, const std::string &difficulty_level)
 
bool parse_should_show_lobby_join (const std::string &sender, const std::string &message)
 
lobby_joins get_lobby_joins ()
 
void _set_lobby_joins (lobby_joins show)
 
const std::vector< game_config::server_info > & builtin_servers_list ()
 
std::vector< game_config::server_infouser_servers_list ()
 
void set_user_servers_list (const std::vector< game_config::server_info > &value)
 
std::string network_host ()
 
void set_network_host (const std::string &host)
 
std::string campaign_server ()
 
void set_campaign_server (const std::string &host)
 
bool turn_dialog ()
 
void set_turn_dialog (bool ison)
 
bool enable_whiteboard_mode_on_start ()
 
void set_enable_whiteboard_mode_on_start (bool value)
 
bool hide_whiteboard ()
 
void set_hide_whiteboard (bool value)
 
bool show_combat ()
 
bool allow_observers ()
 
void set_allow_observers (bool value)
 
bool shuffle_sides ()
 
void set_shuffle_sides (bool value)
 
std::string random_faction_mode ()
 
void set_random_faction_mode (const std::string &value)
 
bool use_map_settings ()
 
void set_use_map_settings (bool value)
 
int mp_server_warning_disabled ()
 
void set_mp_server_warning_disabled (int value)
 
void set_mp_server_program_name (const std::string &path)
 
std::string get_mp_server_program_name ()
 
bool random_start_time ()
 
void set_random_start_time (bool value)
 
bool fog ()
 
void set_fog (bool value)
 
bool shroud ()
 
void set_shroud (bool value)
 
int turns ()
 
void set_turns (int value)
 
const configoptions ()
 
void set_options (const config &values)
 
bool skip_mp_replay ()
 
void set_skip_mp_replay (bool value)
 
bool blindfold_replay ()
 
void set_blindfold_replay (bool value)
 
bool countdown ()
 
void set_countdown (bool value)
 
int countdown_init_time ()
 
void set_countdown_init_time (int value)
 
int countdown_reservoir_time ()
 
void set_countdown_reservoir_time (int value)
 
int countdown_turn_bonus ()
 
void set_countdown_turn_bonus (int value)
 
int countdown_action_bonus ()
 
void set_countdown_action_bonus (int value)
 
int village_gold ()
 
void set_village_gold (int value)
 
int village_support ()
 
void set_village_support (int value)
 
int xp_modifier ()
 
void set_xp_modifier (int value)
 
std::string era ()
 
void set_era (const std::string &value)
 
std::string level ()
 
void set_level (const std::string &value)
 
int level_type ()
 
void set_level_type (int value)
 
const std::vector< std::string > & modifications (bool mp)
 
void set_modifications (const std::vector< std::string > &value, bool mp)
 
bool skip_ai_moves ()
 
void set_skip_ai_moves (bool value)
 
void set_show_side_colors (bool value)
 
bool show_side_colors ()
 
void set_save_replays (bool value)
 
bool save_replays ()
 
void set_delete_saves (bool value)
 
bool delete_saves ()
 
void set_ask_delete_saves (bool value)
 
bool ask_delete_saves ()
 
void set_interrupt_when_ally_sighted (bool value)
 
bool interrupt_when_ally_sighted ()
 
int autosavemax ()
 
void set_autosavemax (int value)
 
std::string theme ()
 
void set_theme (const std::string &theme)
 
bool show_floating_labels ()
 
void set_show_floating_labels (bool value)
 
bool message_private ()
 
void set_message_private (bool value)
 
compression::format save_compression_format ()
 
std::string get_chat_timestamp (const std::time_t &t)
 
bool chat_timestamping ()
 
void set_chat_timestamping (bool value)
 
int chat_lines ()
 
void set_chat_lines (int lines)
 
void set_chat_message_aging (const int aging)
 
int chat_message_aging ()
 
bool show_all_units_in_help ()
 
void set_show_all_units_in_help (bool value)
 
std::set< std::string > & encountered_units ()
 
std::set< t_translation::terrain_code > & encountered_terrains ()
 
std::string custom_command ()
 
void set_custom_command (const std::string &command)
 
std::vector< std::string > * get_history (const std::string &id)
 Returns a pointer to the history vector associated with given id making a new one if it doesn't exist. More...
 
bool green_confirm ()
 
bool yellow_confirm ()
 
bool confirm_no_moves ()
 
void encounter_recruitable_units (const std::vector< team > &teams)
 
void encounter_start_units (const unit_map &units)
 
static void encounter_recallable_units (const std::vector< team > &teams)
 
void encounter_map_terrain (const gamemap &map)
 
void encounter_all_content (const game_board &gameboard_)
 
void encounter_recallable_units (std::vector< team > &teams)
 
void write_preferences ()
 
void set (const std::string &key, bool value)
 
void set (const std::string &key, int value)
 
void set (const std::string &key, char const *value)
 
void set (const std::string &key, const std::string &value)
 
void set (const std::string &key, const config::attribute_value &value)
 
void clear (const std::string &key)
 
void set_child (const std::string &key, const config &val)
 
optional_const_config get_child (const std::string &key)
 
void erase (const std::string &key)
 
bool have_setting (const std::string &key)
 
std::string get (const std::string &key)
 
std::string get (const std::string &key, const std::string &def)
 
bool get (const std::string &key, bool def)
 
config::attribute_value get_as_attribute (const std::string &key)
 
void disable_preferences_save ()
 
configget_prefs ()
 
void load_base_prefs ()
 
bool show_ally_orb ()
 
void set_show_ally_orb (bool show_orb)
 
bool show_status_on_ally_orb ()
 
void set_show_status_on_ally_orb (bool show_orb)
 
bool show_enemy_orb ()
 
void set_show_enemy_orb (bool show_orb)
 
bool show_moved_orb ()
 
void set_show_moved_orb (bool show_orb)
 
bool show_unmoved_orb ()
 
void set_show_unmoved_orb (bool show_orb)
 
bool show_partial_orb ()
 
void set_show_partial_orb (bool show_orb)
 
bool show_disengaged_orb ()
 
void set_show_disengaged_orb (bool show_orb)
 
static std::string fix_orb_color_name (const std::string &color)
 
std::string allied_color ()
 
void set_allied_color (const std::string &color_id)
 
std::string core_id ()
 
void set_core_id (const std::string &core_id)
 
std::string enemy_color ()
 
void set_enemy_color (const std::string &color_id)
 
std::string moved_color ()
 
void set_moved_color (const std::string &color_id)
 
std::string unmoved_color ()
 
void set_unmoved_color (const std::string &color_id)
 
std::string partial_color ()
 
void set_partial_color (const std::string &color_id)
 
bool scroll_to_action ()
 
void set_scroll_to_action (bool ison)
 
point resolution ()
 
int pixel_scale ()
 
void set_pixel_scale (const int scale)
 
bool auto_pixel_scale ()
 
void set_auto_pixel_scale (bool choice)
 
bool maximized ()
 
bool fullscreen ()
 
bool vsync ()
 
void _set_resolution (const point &res)
 
void _set_maximized (bool ison)
 
void _set_fullscreen (bool ison)
 
void set_vsync (bool ison)
 
bool turbo ()
 
void set_turbo (bool ison)
 
double turbo_speed ()
 
void set_turbo_speed (const double speed)
 
int font_scaling ()
 
void set_font_scaling (int scale)
 
int font_scaled (int size)
 
int keepalive_timeout ()
 
void keepalive_timeout (int seconds)
 
bool idle_anim ()
 
void set_idle_anim (const bool ison)
 
int idle_anim_rate ()
 
void set_idle_anim_rate (int rate)
 
std::string language ()
 
void set_language (const std::string &s)
 
std::string gui_theme ()
 
void set_gui_theme (const std::string &s)
 
bool ellipses ()
 
void set_ellipses (bool ison)
 
bool grid ()
 
void set_grid (bool ison)
 
std::size_t sound_buffer_size ()
 
void save_sound_buffer_size (const std::size_t size)
 
int music_volume ()
 
void set_music_volume (int vol)
 
int sound_volume ()
 
void set_sound_volume (int vol)
 
int bell_volume ()
 
void set_bell_volume (int vol)
 
int UI_volume ()
 
void set_UI_volume (int vol)
 
unsigned int tile_size ()
 
void set_tile_size (const unsigned int size)
 
bool turn_bell ()
 
bool set_turn_bell (bool ison)
 
bool UI_sound_on ()
 
bool set_UI_sound (bool ison)
 
bool message_bell ()
 
bool sound_on ()
 
bool set_sound (bool ison)
 
bool music_on ()
 
bool set_music (bool ison)
 
bool stop_music_in_background ()
 
void set_stop_music_in_background (bool ison)
 
int scroll_speed ()
 
void set_scroll_speed (const int new_speed)
 
bool middle_click_scrolls ()
 
bool mouse_scroll_enabled ()
 
void enable_mouse_scroll (bool value)
 
int mouse_scroll_threshold ()
 Gets the threshold for when to scroll. More...
 
bool animate_map ()
 
bool animate_water ()
 
bool minimap_movement_coding ()
 
void toggle_minimap_movement_coding ()
 
bool minimap_terrain_coding ()
 
void toggle_minimap_terrain_coding ()
 
bool minimap_draw_units ()
 
void toggle_minimap_draw_units ()
 
bool minimap_draw_villages ()
 
void toggle_minimap_draw_villages ()
 
bool minimap_draw_terrain ()
 
void toggle_minimap_draw_terrain ()
 
void set_animate_map (bool value)
 
void set_animate_water (bool value)
 
bool show_fps ()
 
void set_show_fps (bool value)
 
int draw_delay ()
 
void set_draw_delay (int value)
 
bool use_color_cursors ()
 
void _set_color_cursors (bool value)
 
void load_hotkeys ()
 
void save_hotkeys ()
 
void clear_hotkeys ()
 
void add_alias (const std::string &alias, const std::string &command)
 
optional_const_config get_alias ()
 
unsigned int sample_rate ()
 
void save_sample_rate (const unsigned int rate)
 
bool confirm_load_save_from_different_version ()
 
bool use_twelve_hour_clock_format ()
 
bool disable_auto_moves ()
 
void set_disable_auto_moves (bool value)
 
bool damage_prediction_allow_monte_carlo_simulation ()
 
void set_damage_prediction_allow_monte_carlo_simulation (bool value)
 
std::string addon_manager_saved_order_name ()
 
void set_addon_manager_saved_order_name (const std::string &value)
 
sort_order::type addon_manager_saved_order_direction ()
 
void set_addon_manager_saved_order_direction (sort_order::type value)
 
std::string selected_achievement_group ()
 
void set_selected_achievement_group (const std::string &content_for)
 
bool achievement (const std::string &content_for, const std::string &id)
 
void set_achievement (const std::string &content_for, const std::string &id)
 Marks the specified achievement as completed. More...
 
int progress_achievement (const std::string &content_for, const std::string &id, int limit=999999, int max_progress=999999, int amount=0)
 Increments the achievement's current progress by amount if it hasn't already been completed. More...
 
bool sub_achievement (const std::string &content_for, const std::string &id, const std::string &sub_id)
 
void set_sub_achievement (const std::string &content_for, const std::string &id, const std::string &sub_id)
 Marks the specified sub-achievement as completed. More...
 
void set_editor_chosen_addon (const std::string &addon_id)
 
std::string editor_chosen_addon ()
 
void set_use_twelve_hour_clock_format (bool value)
 
bool whisper_friends_only ()
 
void set_whisper_friends_only (bool v)
 
bool auto_open_whisper_windows ()
 
bool fi_invert ()
 
void set_fi_invert (bool value)
 
bool fi_vacant_slots ()
 
void set_fi_vacant_slots (bool value)
 
bool fi_friends_in_game ()
 
void set_fi_friends_in_game (bool value)
 
bool fi_blocked_in_game ()
 
void set_fi_blocked_in_game (bool value)
 
void set_auto_open_whisper_windows (bool v)
 

Variables

static std::map< PREFERENCE_VIEW, std::pair< int, int > > pef_view_map
 Map containing page mappings that can be used to set the initially displayed page of the dialog. More...
 
static std::unique_ptr< preferences::advanced_managersingleton = nullptr
 
const int INFINITE_AUTO_SAVES = 61
 
const int min_window_width = 800
 
const int min_window_height = 540
 
const int def_window_width = 1280
 
const int def_window_height = 720
 
const int max_window_width = 1920
 
const int max_window_height = 1080
 
const int min_font_scaling = 80
 
const int max_font_scaling = 150
 
const int min_pixel_scale = 1
 
const int max_pixel_scale = 4
 
prefs_event_handler event_handler_
 

Detailed Description

Modify, read and display user preferences.

This module contain GUI code to display dialogs regarding user preferences, and functions which read and modify the preferences.

Typedef Documentation

◆ advanced_pref_list

Definition at line 68 of file advanced.hpp.

Enumeration Type Documentation

◆ lobby_joins

Enumerator
show_none 
show_friends 
show_all 

Definition at line 78 of file game.hpp.

◆ PREFERENCE_VIEW

Enumerator
VIEW_DEFAULT 
VIEW_FRIENDS 

Definition at line 31 of file preferences_dialog.hpp.

Function Documentation

◆ _set_color_cursors()

void preferences::_set_color_cursors ( bool  value)

Definition at line 912 of file general.cpp.

References set().

Referenced by set_color_cursors().

◆ _set_fullscreen()

void preferences::_set_fullscreen ( bool  ison)

Definition at line 455 of file general.cpp.

Referenced by video::set_fullscreen().

◆ _set_lobby_joins()

void preferences::_set_lobby_joins ( lobby_joins  show)

◆ _set_maximized()

void preferences::_set_maximized ( bool  ison)

◆ _set_resolution()

void preferences::_set_resolution ( const point res)

◆ achievement()

bool preferences::achievement ( const std::string &  content_for,
const std::string &  id 
)
Parameters
content_forThe achievement group the achievement is part of.
idThe ID of the achievement within the achievement group.
Returns
True if the achievement exists and is completed, false otherwise.

Definition at line 1021 of file general.cpp.

References utils::split().

Referenced by achievement_group::achievement_group(), game_lua_kernel::intf_has_achievement(), progress_achievement(), set_sub_achievement(), and sub_achievement().

◆ add_acquaintance()

std::pair< preferences::acquaintance *, bool > preferences::add_acquaintance ( const std::string &  nick,
const std::string &  mode,
const std::string &  notes 
)

◆ add_alias()

void preferences::add_alias ( const std::string &  alias,
const std::string &  command 
)

Definition at line 933 of file general.cpp.

Referenced by events::console_handler::do_set_alias().

◆ add_completed_campaign()

void preferences::add_completed_campaign ( const std::string &  campaign_id,
const std::string &  difficulty_level 
)

Definition at line 285 of file game.cpp.

Referenced by campaign_controller::play_game().

◆ addon_manager_saved_order_direction()

sort_order::type preferences::addon_manager_saved_order_direction ( )

◆ addon_manager_saved_order_name()

std::string preferences::addon_manager_saved_order_name ( )

Definition at line 991 of file general.cpp.

References get().

Referenced by gui2::dialogs::addon_manager::pre_show().

◆ allied_color()

std::string preferences::allied_color ( )

◆ allow_observers()

bool preferences::allow_observers ( )

Definition at line 448 of file game.cpp.

References get().

Referenced by ng::configure_engine::allow_observers_default().

◆ animate_map()

bool preferences::animate_map ( )

◆ animate_water()

bool preferences::animate_water ( )

◆ ask_delete_saves()

bool preferences::ask_delete_saves ( )

◆ auto_open_whisper_windows()

bool preferences::auto_open_whisper_windows ( )

Definition at line 31 of file lobby.cpp.

References get().

Referenced by gui2::chatbox::add_whisper_received(), and gui2::chatbox::add_whisper_sent().

◆ auto_pixel_scale()

bool preferences::auto_pixel_scale ( )

◆ autosavemax()

int preferences::autosavemax ( )

◆ bell_volume()

int preferences::bell_volume ( )

Definition at line 635 of file general.cpp.

Referenced by sound::init_sound(), and set_bell_volume().

◆ blindfold_replay()

bool preferences::blindfold_replay ( )

Definition at line 588 of file game.cpp.

References get().

Referenced by gui2::dialogs::mp_lobby::pre_show().

◆ builtin_servers_list()

const std::vector< game_config::server_info > & preferences::builtin_servers_list ( )

◆ campaign_server()

std::string preferences::campaign_server ( )

◆ chat_lines()

int preferences::chat_lines ( )

◆ chat_message_aging()

int preferences::chat_message_aging ( )

Definition at line 898 of file game.cpp.

References get().

Referenced by display_chat_manager::prune_chat_messages().

◆ chat_timestamping()

bool preferences::chat_timestamping ( )

Definition at line 873 of file game.cpp.

References get().

Referenced by get_chat_timestamp(), and gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ clear()

void preferences::clear ( const std::string &  key)

Definition at line 190 of file general.cpp.

Referenced by set_mp_server_program_name().

◆ clear_hotkeys()

void preferences::clear_hotkeys ( )

Definition at line 927 of file general.cpp.

References hotkey::reset_default_hotkeys().

◆ confirm_load_save_from_different_version()

bool preferences::confirm_load_save_from_different_version ( )

Definition at line 961 of file general.cpp.

References get().

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

◆ confirm_no_moves()

bool preferences::confirm_no_moves ( )

Definition at line 955 of file game.cpp.

References get().

Referenced by events::menu_handler::end_turn().

◆ core_id()

std::string preferences::core_id ( )

◆ countdown()

bool preferences::countdown ( )

◆ countdown_action_bonus()

int preferences::countdown_action_bonus ( )

◆ countdown_init_time()

int preferences::countdown_init_time ( )

◆ countdown_reservoir_time()

int preferences::countdown_reservoir_time ( )

◆ countdown_turn_bonus()

int preferences::countdown_turn_bonus ( )

◆ custom_command()

std::string preferences::custom_command ( )

Definition at line 923 of file game.cpp.

References get().

Referenced by events::menu_handler::custom_command().

◆ damage_prediction_allow_monte_carlo_simulation()

bool preferences::damage_prediction_allow_monte_carlo_simulation ( )

Definition at line 981 of file general.cpp.

References get().

Referenced by combatant::fight().

◆ delete_saves()

bool preferences::delete_saves ( )

◆ disable_auto_moves()

bool preferences::disable_auto_moves ( )

◆ disable_preferences_save()

void preferences::disable_preferences_save ( )

Definition at line 231 of file general.cpp.

Referenced by game_launcher::game_launcher().

◆ draw_delay()

int preferences::draw_delay ( )

◆ editor_chosen_addon()

std::string preferences::editor_chosen_addon ( )
Returns
The most recently selected add-on id from the editor. May be an empty string.

Definition at line 1210 of file general.cpp.

Referenced by gui2::dialogs::editor_choose_addon::populate_list().

◆ ellipses()

bool preferences::ellipses ( )

Definition at line 555 of file general.cpp.

References get().

Referenced by events::menu_handler::toggle_ellipses().

◆ enable_mouse_scroll()

void preferences::enable_mouse_scroll ( bool  value)

Definition at line 807 of file general.cpp.

References set().

Referenced by hotkey::command_executor::execute_command_wrap().

◆ enable_whiteboard_mode_on_start()

bool preferences::enable_whiteboard_mode_on_start ( )

◆ encounter_all_content()

void preferences::encounter_all_content ( const game_board gameboard_)

◆ encounter_map_terrain()

void preferences::encounter_map_terrain ( const gamemap map)

◆ encounter_recallable_units() [1/2]

static void preferences::encounter_recallable_units ( const std::vector< team > &  teams)
static

Definition at line 977 of file game.cpp.

References t.

Referenced by encounter_all_content().

◆ encounter_recallable_units() [2/2]

void preferences::encounter_recallable_units ( std::vector< team > &  teams)

◆ encounter_recruitable_units()

void preferences::encounter_recruitable_units ( const std::vector< team > &  teams)

Definition at line 962 of file game.cpp.

Referenced by encounter_all_content().

◆ encounter_start_units()

void preferences::encounter_start_units ( const unit_map units)

Definition at line 970 of file game.cpp.

Referenced by encounter_all_content().

◆ encountered_terrains()

std::set< t_translation::terrain_code > & preferences::encountered_terrains ( )

◆ encountered_units()

std::set< std::string > & preferences::encountered_units ( )

◆ enemy_color()

std::string preferences::enemy_color ( )

◆ era()

std::string preferences::era ( )

◆ erase()

void preferences::erase ( const std::string &  key)

◆ fi_blocked_in_game()

bool preferences::fi_blocked_in_game ( )

Definition at line 66 of file lobby.cpp.

References get().

◆ fi_friends_in_game()

bool preferences::fi_friends_in_game ( )

Definition at line 56 of file lobby.cpp.

References get().

◆ fi_invert()

bool preferences::fi_invert ( )

Definition at line 36 of file lobby.cpp.

References get().

◆ fi_vacant_slots()

bool preferences::fi_vacant_slots ( )

Definition at line 46 of file lobby.cpp.

References get().

◆ fix_orb_color_name()

static std::string preferences::fix_orb_color_name ( const std::string &  color)
static

Definition at line 311 of file general.cpp.

Referenced by allied_color(), enemy_color(), moved_color(), partial_color(), and unmoved_color().

◆ fog()

bool preferences::fog ( )

◆ font_scaled()

int preferences::font_scaled ( int  size)

◆ font_scaling()

int preferences::font_scaling ( )

Definition at line 489 of file general.cpp.

References max_font_scaling, and min_font_scaling.

Referenced by font_scaled().

◆ fullscreen()

bool preferences::fullscreen ( )

◆ get() [1/3]

std::string preferences::get ( const std::string &  key)

Definition at line 213 of file general.cpp.

Referenced by addon_manager_saved_order_direction(), addon_manager_saved_order_name(), allied_color(), allow_observers(), animate_map(), animate_water(), ask_delete_saves(), auto_open_whisper_windows(), auto_pixel_scale(), preferences::editor::auto_update_transitions(), autosavemax(), blindfold_replay(), campaign_server(), chat_lines(), chat_message_aging(), chat_timestamping(), confirm_load_save_from_different_version(), confirm_no_moves(), core_id(), countdown(), countdown_action_bonus(), countdown_init_time(), countdown_reservoir_time(), countdown_turn_bonus(), custom_command(), damage_prediction_allow_monte_carlo_simulation(), preferences::editor::default_dir(), delete_saves(), deprecated_message(), disable_auto_moves(), preferences::editor::draw_hex_coordinates(), preferences::editor::draw_num_of_bitmaps(), preferences::editor::draw_terrain_codes(), ellipses(), enable_whiteboard_mode_on_start(), enemy_color(), era(), fi_blocked_in_game(), fi_friends_in_game(), fi_invert(), fi_vacant_slots(), fog(), fullscreen(), game_config_manager::game_config_manager(), get_lobby_joins(), get_mp_server_program_name(), green_confirm(), grid(), controller_base::handle_scroll(), hide_whiteboard(), idle_anim(), interrupt_when_ally_sighted(), level(), level_type(), load_game_prefs(), login(), maximized(), message_bell(), middle_click_scrolls(), minimap_draw_terrain(), minimap_draw_units(), minimap_draw_villages(), minimap_movement_coding(), minimap_terrain_coding(), mouse_scroll_enabled(), moved_color(), mp_server_warning_disabled(), music_on(), network_host(), partial_color(), random_faction_mode(), random_start_time(), remember_password(), save_compression_format(), save_replays(), save_sound_buffer_size(), scroll_speed(), scroll_to_action(), selected_achievement_group(), gui2::dialogs::setup_pref_toggle_button(), show_all_units_in_help(), show_ally_orb(), show_combat(), show_disengaged_orb(), show_enemy_orb(), show_floating_labels(), show_moved_orb(), show_partial_orb(), show_side_colors(), show_standing_animations(), show_status_on_ally_orb(), show_unmoved_orb(), shroud(), shuffle_sides(), skip_ai_moves(), skip_mp_replay(), sound_on(), stop_music_in_background(), theme(), turbo(), turn_bell(), turn_dialog(), turns(), UI_sound_on(), unmoved_color(), use_color_cursors(), use_map_settings(), use_twelve_hour_clock_format(), village_gold(), village_support(), vsync(), whisper_friends_only(), xp_modifier(), and yellow_confirm().

◆ get() [2/3]

bool preferences::get ( const std::string &  key,
bool  def 
)

Definition at line 221 of file general.cpp.

◆ get() [3/3]

std::string preferences::get ( const std::string &  key,
const std::string &  def 
)

Definition at line 217 of file general.cpp.

◆ get_acquaintances()

const std::map< std::string, acquaintance > & preferences::get_acquaintances ( )

◆ get_acquaintances_nice()

std::map< std::string, std::string > preferences::get_acquaintances_nice ( const std::string &  filter)

Definition at line 210 of file game.cpp.

References a, and load_acquaintances().

Referenced by play_controller::tab().

◆ get_advanced_preferences()

const advanced_pref_list & preferences::get_advanced_preferences ( )

Gets a list of the available advanced preferences.

Definition at line 87 of file advanced.cpp.

References singleton.

Referenced by impl_preferences_dir().

◆ get_alias()

optional_const_config preferences::get_alias ( )

Definition at line 940 of file general.cpp.

References get_child().

Referenced by events::console_handler::init_map().

◆ get_as_attribute()

config::attribute_value preferences::get_as_attribute ( const std::string &  key)

Definition at line 226 of file general.cpp.

Referenced by impl_preferences_get().

◆ get_chat_timestamp()

std::string preferences::get_chat_timestamp ( const std::time_t &  t)

◆ get_child()

optional_const_config preferences::get_child ( const std::string &  key)

◆ get_history()

std::vector< std::string > * preferences::get_history ( const std::string &  id)

Returns a pointer to the history vector associated with given id making a new one if it doesn't exist.

Todo:
FIXME only used for gui2. Could be used for the above histories.

Definition at line 939 of file game.cpp.

References id.

Referenced by gui2::text_history::get_history().

◆ get_ignored_delim()

const std::string preferences::get_ignored_delim ( )

Definition at line 195 of file game.cpp.

References utils::join(), and load_acquaintances().

Referenced by ng::connect_engine::send_level_data().

◆ get_lobby_joins()

lobby_joins preferences::get_lobby_joins ( )

◆ get_mp_server_program_name()

std::string preferences::get_mp_server_program_name ( )

Definition at line 507 of file game.cpp.

References get().

Referenced by show_wesnothd_server_search(), and game_launcher::start_wesnothd().

◆ get_prefs()

config * preferences::get_prefs ( )

◆ green_confirm()

bool preferences::green_confirm ( )

Definition at line 944 of file game.cpp.

References get().

Referenced by events::menu_handler::end_turn().

◆ grid()

bool preferences::grid ( )

◆ gui_theme()

std::string preferences::gui_theme ( )

Definition at line 545 of file general.cpp.

Referenced by gui2::init().

◆ have_setting()

bool preferences::have_setting ( const std::string &  key)

Definition at line 209 of file general.cpp.

◆ hide_whiteboard()

bool preferences::hide_whiteboard ( )

Definition at line 433 of file game.cpp.

References get().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks(), and wb::manager::manager().

◆ idle_anim()

bool preferences::idle_anim ( )

Definition at line 515 of file general.cpp.

References get().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ idle_anim_rate()

int preferences::idle_anim_rate ( )

◆ init_advanced_manager()

void preferences::init_advanced_manager ( const game_config_view gc)

Initializes the manager singleton.

Definition at line 82 of file advanced.cpp.

References singleton.

Referenced by game_config_manager::init_game_config().

◆ interrupt_when_ally_sighted()

bool preferences::interrupt_when_ally_sighted ( )

◆ is_campaign_completed() [1/2]

bool preferences::is_campaign_completed ( const std::string &  campaign_id)

◆ is_campaign_completed() [2/2]

bool preferences::is_campaign_completed ( const std::string &  campaign_id,
const std::string &  difficulty_level 
)

Definition at line 295 of file game.cpp.

◆ is_friend()

bool preferences::is_friend ( const std::string &  nick)

◆ is_ignored()

bool preferences::is_ignored ( const std::string &  nick)

◆ keepalive_timeout() [1/2]

int preferences::keepalive_timeout ( )

Definition at line 505 of file general.cpp.

Referenced by wesnothd_connection::handshake().

◆ keepalive_timeout() [2/2]

void preferences::keepalive_timeout ( int  seconds)

Definition at line 510 of file general.cpp.

◆ language()

std::string preferences::language ( )

◆ level()

std::string preferences::level ( )

Definition at line 688 of file game.cpp.

References get().

Referenced by gui2::dialogs::mp_create_game::pre_show().

◆ level_type()

int preferences::level_type ( )

Definition at line 698 of file game.cpp.

References get().

◆ load_acquaintances()

static void preferences::load_acquaintances ( )
static

◆ load_base_prefs()

void preferences::load_base_prefs ( )

◆ load_credentials()

void preferences::load_credentials ( )

◆ load_game_prefs()

void preferences::load_game_prefs ( )

◆ load_hotkeys()

void preferences::load_hotkeys ( )

◆ login()

std::string preferences::login ( )

◆ maximized()

bool preferences::maximized ( )

Definition at line 429 of file general.cpp.

References fullscreen(), and get().

Referenced by video::init_window(), and video::set_fullscreen().

◆ message_bell()

bool preferences::message_bell ( )

Definition at line 723 of file general.cpp.

References get().

Referenced by do_replay_handle(), and playmp_controller::process_network_data_impl().

◆ message_private()

bool preferences::message_private ( )

Definition at line 830 of file game.cpp.

Referenced by events::menu_handler::speak().

◆ middle_click_scrolls()

bool preferences::middle_click_scrolls ( )

Definition at line 797 of file general.cpp.

References get().

Referenced by controller_base::handle_scroll(), and events::mouse_handler_base::mouse_press().

◆ minimap_draw_terrain()

bool preferences::minimap_draw_terrain ( )

◆ minimap_draw_units()

bool preferences::minimap_draw_units ( )

◆ minimap_draw_villages()

bool preferences::minimap_draw_villages ( )

◆ minimap_movement_coding()

bool preferences::minimap_movement_coding ( )

◆ minimap_terrain_coding()

bool preferences::minimap_terrain_coding ( )

◆ modifications()

const std::vector< std::string > & preferences::modifications ( bool  mp)

◆ mouse_scroll_enabled()

bool preferences::mouse_scroll_enabled ( )

Definition at line 802 of file general.cpp.

References get().

Referenced by hotkey::command_executor::execute_command_wrap(), and controller_base::handle_scroll().

◆ mouse_scroll_threshold()

int preferences::mouse_scroll_threshold ( )

Gets the threshold for when to scroll.

This scrolling happens when the mouse is in the application and near the border.

Definition at line 812 of file general.cpp.

Referenced by controller_base::handle_scroll(), and preferences::base_manager::~base_manager().

◆ moved_color()

std::string preferences::moved_color ( )

◆ mp_server_warning_disabled()

int preferences::mp_server_warning_disabled ( )

◆ music_on()

bool preferences::music_on ( )

◆ music_volume()

int preferences::music_volume ( )

◆ network_host()

std::string preferences::network_host ( )

Definition at line 384 of file game.cpp.

References builtin_servers_list(), and get().

Referenced by game_launcher::game_launcher(), and game_launcher::play_multiplayer().

◆ options()

const config & preferences::options ( )

◆ parse_should_show_lobby_join()

bool preferences::parse_should_show_lobby_join ( const std::string &  sender,
const std::string &  message 
)

◆ partial_color()

std::string preferences::partial_color ( )

◆ password()

std::string preferences::password ( const std::string &  server,
const std::string &  login 
)

◆ pixel_scale()

int preferences::pixel_scale ( )

◆ progress_achievement()

int preferences::progress_achievement ( const std::string &  content_for,
const std::string &  id,
int  limit = 999999,
int  max_progress = 999999,
int  amount = 0 
)

Increments the achievement's current progress by amount if it hasn't already been completed.

If you only want to check the achievement's current progress, then omit the last three arguments. amount defaults to 0, which will result in the current progress value being returned without being changed (x + 0 == x).

Note that this uses the same [in_progress] as is used for set_sub_achievement().

Parameters
content_forThe id of the achievement group this achievement is in.
idThe id for the specific achievement in the achievement group.
limitThe maximum value that a specific call to this function can increase the achievement progress value.
max_progressThe value when the achievement is considered completed.
amountThe amount to progress the achievement.
Returns
The achievement's current progress, or -1 if it has already been completed.

Definition at line 1063 of file general.cpp.

References achievement(), config::add_child(), config::child_range(), and id.

Referenced by achievement_group::achievement_group(), and game_lua_kernel::intf_progress_achievement().

◆ random_faction_mode()

std::string preferences::random_faction_mode ( )

Definition at line 468 of file game.cpp.

References get().

Referenced by ng::configure_engine::random_faction_mode_default().

◆ random_start_time()

bool preferences::random_start_time ( )

◆ remember_password()

bool preferences::remember_password ( )

◆ remove_acquaintance()

bool preferences::remove_acquaintance ( const std::string &  nick)

◆ resolution()

point preferences::resolution ( )

◆ sample_rate()

unsigned int preferences::sample_rate ( )

Definition at line 945 of file general.cpp.

Referenced by sound::init_sound(), and save_sample_rate().

◆ save_acquaintances()

static void preferences::save_acquaintances ( )
static

Definition at line 178 of file game.cpp.

References a, config::add_child(), config::clear_children(), and get_prefs().

Referenced by add_acquaintance(), and remove_acquaintance().

◆ save_compression_format()

compression::format preferences::save_compression_format ( )

◆ save_credentials()

void preferences::save_credentials ( )

◆ save_hotkeys()

void preferences::save_hotkeys ( )

Definition at line 922 of file general.cpp.

References hotkey::save_hotkeys().

◆ save_replays()

bool preferences::save_replays ( )

◆ save_sample_rate()

void preferences::save_sample_rate ( const unsigned int  rate)

Definition at line 950 of file general.cpp.

References sound::reset_sound(), and sample_rate().

◆ save_sound_buffer_size()

void preferences::save_sound_buffer_size ( const std::size_t  size)

Definition at line 588 of file general.cpp.

References get(), sound::reset_sound(), set(), and utf8::size().

◆ scroll_speed()

int preferences::scroll_speed ( )

◆ scroll_to_action()

bool preferences::scroll_to_action ( )

Definition at line 382 of file general.cpp.

References get().

Referenced by display::scroll_to_xy().

◆ selected_achievement_group()

std::string preferences::selected_achievement_group ( )

Definition at line 1011 of file general.cpp.

References get().

◆ set() [1/5]

void preferences::set ( const std::string &  key,
bool  value 
)

Definition at line 165 of file general.cpp.

Referenced by _set_color_cursors(), _set_lobby_joins(), _set_resolution(), enable_mouse_scroll(), game_config_manager::game_config_manager(), impl_preferences_set(), save_sound_buffer_size(), set_addon_manager_saved_order_direction(), set_addon_manager_saved_order_name(), set_allow_observers(), set_animate_map(), set_animate_water(), set_ask_delete_saves(), preferences::editor::set_auto_update_transitions(), set_autosavemax(), set_blindfold_replay(), set_campaign_server(), set_chat_lines(), set_chat_message_aging(), set_chat_timestamping(), set_countdown(), set_countdown_action_bonus(), set_countdown_init_time(), set_countdown_reservoir_time(), set_countdown_turn_bonus(), set_custom_command(), set_damage_prediction_allow_monte_carlo_simulation(), set_delete_saves(), set_disable_auto_moves(), preferences::editor::set_draw_hex_coordinates(), preferences::editor::set_draw_num_of_bitmaps(), preferences::editor::set_draw_terrain_codes(), set_ellipses(), set_enable_whiteboard_mode_on_start(), set_era(), set_fi_blocked_in_game(), set_fi_friends_in_game(), set_fi_invert(), set_fi_vacant_slots(), set_fog(), set_grid(), set_gui_theme(), set_hide_whiteboard(), set_interrupt_when_ally_sighted(), set_language(), set_level(), set_level_type(), set_login(), set_modifications(), set_mp_server_program_name(), set_mp_server_warning_disabled(), set_music(), set_network_host(), gui2::dialogs::set_pref_and_button(), set_random_faction_mode(), set_random_start_time(), set_remember_password(), set_save_replays(), set_selected_achievement_group(), set_show_all_units_in_help(), set_show_floating_labels(), set_show_side_colors(), set_show_standing_animations(), set_shroud(), set_shuffle_sides(), set_skip_ai_moves(), set_skip_mp_replay(), set_sound(), set_stop_music_in_background(), set_theme(), set_turn_bell(), set_turn_dialog(), set_turns(), set_UI_sound(), set_use_map_settings(), set_village_gold(), set_village_support(), set_whisper_friends_only(), set_xp_modifier(), gui2::dialogs::setup_item(), gui2::dialogs::setup_pref_toggle_button(), toggle_minimap_draw_terrain(), toggle_minimap_draw_units(), toggle_minimap_draw_villages(), toggle_minimap_movement_coding(), toggle_minimap_terrain_coding(), and preferences::manager::~manager().

◆ set() [2/5]

void preferences::set ( const std::string &  key,
char const *  value 
)

Definition at line 175 of file general.cpp.

◆ set() [3/5]

void preferences::set ( const std::string &  key,
const config::attribute_value value 
)

Definition at line 185 of file general.cpp.

◆ set() [4/5]

void preferences::set ( const std::string &  key,
const std::string &  value 
)

Definition at line 180 of file general.cpp.

◆ set() [5/5]

void preferences::set ( const std::string &  key,
int  value 
)

Definition at line 170 of file general.cpp.

◆ set_achievement()

void preferences::set_achievement ( const std::string &  content_for,
const std::string &  id 
)

Marks the specified achievement as completed.

Parameters
content_forThe achievement group the achievement is part of.
idThe ID of the achievement within the achievement group.

Definition at line 1034 of file general.cpp.

References id, and utils::split().

Referenced by game_lua_kernel::intf_set_achievement().

◆ set_addon_manager_saved_order_direction()

void preferences::set_addon_manager_saved_order_direction ( sort_order::type  value)

◆ set_addon_manager_saved_order_name()

void preferences::set_addon_manager_saved_order_name ( const std::string &  value)

◆ set_allied_color()

void preferences::set_allied_color ( const std::string &  color_id)

Definition at line 328 of file general.cpp.

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

◆ set_allow_observers()

void preferences::set_allow_observers ( bool  value)

Definition at line 453 of file game.cpp.

References set().

◆ set_animate_map()

void preferences::set_animate_map ( bool  value)

◆ set_animate_water()

void preferences::set_animate_water ( bool  value)

Definition at line 882 of file general.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_ask_delete_saves()

void preferences::set_ask_delete_saves ( bool  value)

Definition at line 768 of file game.cpp.

References set().

Referenced by gui2::dialogs::set_dont_ask_again().

◆ set_auto_open_whisper_windows()

void preferences::set_auto_open_whisper_windows ( bool  v)

◆ set_auto_pixel_scale()

void preferences::set_auto_pixel_scale ( bool  choice)

◆ set_autosavemax()

void preferences::set_autosavemax ( int  value)

Definition at line 793 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_bell_volume()

void preferences::set_bell_volume ( int  vol)

Definition at line 640 of file general.cpp.

References bell_volume(), and sound::set_bell_volume().

◆ set_blindfold_replay()

void preferences::set_blindfold_replay ( bool  value)

Definition at line 593 of file game.cpp.

References set().

Referenced by gui2::dialogs::mp_lobby::skip_replay_changed_callback().

◆ set_campaign_server()

void preferences::set_campaign_server ( const std::string &  host)

Definition at line 408 of file game.cpp.

References set().

◆ set_chat_lines()

void preferences::set_chat_lines ( int  lines)

Definition at line 888 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_chat_message_aging()

void preferences::set_chat_message_aging ( const int  aging)

Definition at line 893 of file game.cpp.

References set().

◆ set_chat_timestamping()

void preferences::set_chat_timestamping ( bool  value)

Definition at line 878 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_child()

void preferences::set_child ( const std::string &  key,
const config val 
)

Definition at line 195 of file general.cpp.

Referenced by set_options(), and preferences::manager::~manager().

◆ set_color_cursors()

void preferences::set_color_cursors ( bool  value)

Definition at line 40 of file display.cpp.

References _set_color_cursors(), and cursor::set().

◆ set_core_id()

void preferences::set_core_id ( const std::string &  core_id)

◆ set_countdown()

void preferences::set_countdown ( bool  value)

Definition at line 603 of file game.cpp.

References set().

◆ set_countdown_action_bonus()

void preferences::set_countdown_action_bonus ( int  value)

Definition at line 643 of file game.cpp.

References set().

◆ set_countdown_init_time()

void preferences::set_countdown_init_time ( int  value)

Definition at line 613 of file game.cpp.

References set().

◆ set_countdown_reservoir_time()

void preferences::set_countdown_reservoir_time ( int  value)

Definition at line 623 of file game.cpp.

References set().

◆ set_countdown_turn_bonus()

void preferences::set_countdown_turn_bonus ( int  value)

Definition at line 633 of file game.cpp.

References set().

◆ set_custom_command()

void preferences::set_custom_command ( const std::string &  command)

Definition at line 928 of file game.cpp.

References set().

Referenced by events::console_handler::do_custom().

◆ set_damage_prediction_allow_monte_carlo_simulation()

void preferences::set_damage_prediction_allow_monte_carlo_simulation ( bool  value)

Definition at line 986 of file general.cpp.

References set().

◆ set_delete_saves()

void preferences::set_delete_saves ( bool  value)

Definition at line 758 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_disable_auto_moves()

void preferences::set_disable_auto_moves ( bool  value)

Definition at line 976 of file general.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_draw_delay()

void preferences::set_draw_delay ( int  value)

◆ set_editor_chosen_addon()

void preferences::set_editor_chosen_addon ( const std::string &  addon_id)
Parameters
addon_idThe chosen addon id from the editor to store in the preferences.

Definition at line 1205 of file general.cpp.

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

◆ set_ellipses()

void preferences::set_ellipses ( bool  ison)

Definition at line 560 of file general.cpp.

References set().

Referenced by events::menu_handler::toggle_ellipses().

◆ set_enable_whiteboard_mode_on_start()

void preferences::set_enable_whiteboard_mode_on_start ( bool  value)

Definition at line 428 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_enemy_color()

void preferences::set_enemy_color ( const std::string &  color_id)

Definition at line 348 of file general.cpp.

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

◆ set_era()

void preferences::set_era ( const std::string &  value)

Definition at line 683 of file game.cpp.

References set().

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

◆ set_fi_blocked_in_game()

void preferences::set_fi_blocked_in_game ( bool  value)

Definition at line 71 of file lobby.cpp.

References set().

◆ set_fi_friends_in_game()

void preferences::set_fi_friends_in_game ( bool  value)

Definition at line 61 of file lobby.cpp.

References set().

◆ set_fi_invert()

void preferences::set_fi_invert ( bool  value)

Definition at line 41 of file lobby.cpp.

References set().

◆ set_fi_vacant_slots()

void preferences::set_fi_vacant_slots ( bool  value)

Definition at line 51 of file lobby.cpp.

References set().

◆ set_fog()

void preferences::set_fog ( bool  value)

Definition at line 527 of file game.cpp.

References set().

◆ set_font_scaling()

void preferences::set_font_scaling ( int  scale)

Definition at line 495 of file general.cpp.

References max_font_scaling, min_font_scaling, and xbrz::scale().

◆ set_grid()

void preferences::set_grid ( bool  ison)

◆ set_gui_theme()

void preferences::set_gui_theme ( const std::string &  s)

Definition at line 550 of file general.cpp.

References s, and set().

◆ set_hide_whiteboard()

void preferences::set_hide_whiteboard ( bool  value)

Definition at line 438 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_idle_anim()

void preferences::set_idle_anim ( const bool  ison)

◆ set_idle_anim_rate()

void preferences::set_idle_anim_rate ( int  rate)

◆ set_interrupt_when_ally_sighted()

void preferences::set_interrupt_when_ally_sighted ( bool  value)

Definition at line 778 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_language()

void preferences::set_language ( const std::string &  s)

Definition at line 540 of file general.cpp.

References s, and set().

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

◆ set_level()

void preferences::set_level ( const std::string &  value)

◆ set_level_type()

void preferences::set_level_type ( int  value)

Definition at line 703 of file game.cpp.

References set().

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

◆ set_login()

void preferences::set_login ( const std::string &  login)

◆ set_message_private()

void preferences::set_message_private ( bool  value)

◆ set_modifications()

void preferences::set_modifications ( const std::vector< std::string > &  value,
bool  mp 
)

◆ set_moved_color()

void preferences::set_moved_color ( const std::string &  color_id)

Definition at line 358 of file general.cpp.

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

◆ set_mp_server_program_name()

void preferences::set_mp_server_program_name ( const std::string &  path)

Definition at line 498 of file game.cpp.

References clear(), game_config::path, and set().

Referenced by show_wesnothd_server_search(), and game_launcher::start_wesnothd().

◆ set_mp_server_warning_disabled()

void preferences::set_mp_server_warning_disabled ( int  value)

Definition at line 493 of file game.cpp.

References set().

Referenced by gui2::dialogs::set_do_not_show_again().

◆ set_music()

bool preferences::set_music ( bool  ison)

◆ set_music_volume()

void preferences::set_music_volume ( int  vol)

Definition at line 610 of file general.cpp.

References music_volume(), and sound::set_music_volume().

Referenced by load_game_prefs().

◆ set_network_host()

void preferences::set_network_host ( const std::string &  host)

Definition at line 394 of file game.cpp.

References set().

Referenced by game_launcher::play_multiplayer().

◆ set_options()

void preferences::set_options ( const config values)

Definition at line 572 of file game.cpp.

References set_child().

Referenced by ng::configure_engine::set_options().

◆ set_partial_color()

void preferences::set_partial_color ( const std::string &  color_id)

Definition at line 378 of file general.cpp.

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

◆ set_password()

void preferences::set_password ( const std::string &  server,
const std::string &  login,
const std::string &  key 
)

◆ set_pixel_scale()

void preferences::set_pixel_scale ( const int  scale)

◆ set_random_faction_mode()

void preferences::set_random_faction_mode ( const std::string &  value)

Definition at line 473 of file game.cpp.

References set().

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

◆ set_random_start_time()

void preferences::set_random_start_time ( bool  value)

Definition at line 517 of file game.cpp.

References set().

◆ set_remember_password()

void preferences::set_remember_password ( bool  remember)

◆ set_save_replays()

void preferences::set_save_replays ( bool  value)

Definition at line 748 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_scroll_speed()

void preferences::set_scroll_speed ( const int  new_speed)

◆ set_scroll_to_action()

void preferences::set_scroll_to_action ( bool  ison)

Definition at line 387 of file general.cpp.

◆ set_selected_achievement_group()

void preferences::set_selected_achievement_group ( const std::string &  content_for)

Definition at line 1016 of file general.cpp.

References set().

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

◆ set_show_all_units_in_help()

void preferences::set_show_all_units_in_help ( bool  value)

Definition at line 908 of file game.cpp.

References set().

◆ set_show_ally_orb()

void preferences::set_show_ally_orb ( bool  show_orb)

Definition at line 265 of file general.cpp.

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

◆ set_show_disengaged_orb()

void preferences::set_show_disengaged_orb ( bool  show_orb)

Definition at line 307 of file general.cpp.

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

◆ set_show_enemy_orb()

void preferences::set_show_enemy_orb ( bool  show_orb)

Definition at line 279 of file general.cpp.

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

◆ set_show_floating_labels()

void preferences::set_show_floating_labels ( bool  value)

Definition at line 825 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_show_fps()

void preferences::set_show_fps ( bool  value)

Definition at line 892 of file general.cpp.

Referenced by events::console_handler::do_fps(), and game_launcher::game_launcher().

◆ set_show_moved_orb()

void preferences::set_show_moved_orb ( bool  show_orb)

Definition at line 286 of file general.cpp.

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

◆ set_show_partial_orb()

void preferences::set_show_partial_orb ( bool  show_orb)

Definition at line 300 of file general.cpp.

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

◆ set_show_side_colors()

void preferences::set_show_side_colors ( bool  value)

Definition at line 738 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_show_standing_animations()

void preferences::set_show_standing_animations ( bool  value)

Definition at line 52 of file display.cpp.

References d, display::get_singleton(), and set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_show_status_on_ally_orb()

void preferences::set_show_status_on_ally_orb ( bool  show_orb)

Definition at line 272 of file general.cpp.

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

◆ set_show_unmoved_orb()

void preferences::set_show_unmoved_orb ( bool  show_orb)

Definition at line 293 of file general.cpp.

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

◆ set_shroud()

void preferences::set_shroud ( bool  value)

Definition at line 537 of file game.cpp.

References set().

◆ set_shuffle_sides()

void preferences::set_shuffle_sides ( bool  value)

Definition at line 463 of file game.cpp.

References set().

◆ set_skip_ai_moves()

void preferences::set_skip_ai_moves ( bool  value)

Definition at line 733 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_skip_mp_replay()

void preferences::set_skip_mp_replay ( bool  value)

Definition at line 583 of file game.cpp.

References set().

Referenced by gui2::dialogs::mp_lobby::skip_replay_changed_callback().

◆ set_sound()

bool preferences::set_sound ( bool  ison)

◆ set_sound_volume()

void preferences::set_sound_volume ( int  vol)

Definition at line 625 of file general.cpp.

References sound::set_sound_volume(), and sound_volume().

Referenced by load_game_prefs().

◆ set_stop_music_in_background()

void preferences::set_stop_music_in_background ( bool  ison)

Definition at line 782 of file general.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_sub_achievement()

void preferences::set_sub_achievement ( const std::string &  content_for,
const std::string &  id,
const std::string &  sub_id 
)

Marks the specified sub-achievement as completed.

Note that this uses the same [in_progress] as is used for progress_achievement().

Parameters
content_forThe achievement group the achievement is part of.
idThe ID of the achievement within the achievement group.
sub_idThe ID of the sub-achievement within the achievement.

Definition at line 1150 of file general.cpp.

References achievement(), config::add_child(), config::child_range(), id, and utils::split().

Referenced by game_lua_kernel::intf_set_sub_achievement().

◆ set_theme()

void preferences::set_theme ( const std::string &  theme)

◆ set_tile_size()

void preferences::set_tile_size ( const unsigned int  size)

Definition at line 670 of file general.cpp.

References utf8::size().

Referenced by display::display(), and display::set_zoom().

◆ set_turbo()

void preferences::set_turbo ( bool  ison)

◆ set_turbo_speed()

void preferences::set_turbo_speed ( const double  speed)

◆ set_turn_bell()

bool preferences::set_turn_bell ( bool  ison)

◆ set_turn_dialog()

void preferences::set_turn_dialog ( bool  ison)

Definition at line 418 of file game.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_turns()

void preferences::set_turns ( int  value)

Definition at line 547 of file game.cpp.

References set().

◆ set_UI_sound()

bool preferences::set_UI_sound ( bool  ison)

◆ set_UI_volume()

void preferences::set_UI_volume ( int  vol)

Definition at line 655 of file general.cpp.

References sound::set_UI_volume(), and UI_volume().

◆ set_unmoved_color()

void preferences::set_unmoved_color ( const std::string &  color_id)

Definition at line 368 of file general.cpp.

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

◆ set_use_map_settings()

void preferences::set_use_map_settings ( bool  value)

Definition at line 483 of file game.cpp.

References set().

◆ set_use_twelve_hour_clock_format()

void preferences::set_use_twelve_hour_clock_format ( bool  value)

◆ set_user_servers_list()

void preferences::set_user_servers_list ( const std::vector< game_config::server_info > &  value)

◆ set_village_gold()

void preferences::set_village_gold ( int  value)

Definition at line 653 of file game.cpp.

References set().

◆ set_village_support()

void preferences::set_village_support ( int  value)

Definition at line 663 of file game.cpp.

References set().

◆ set_vsync()

void preferences::set_vsync ( bool  ison)

◆ set_whisper_friends_only()

void preferences::set_whisper_friends_only ( bool  v)

Definition at line 26 of file lobby.cpp.

References set().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ set_xp_modifier()

void preferences::set_xp_modifier ( int  value)

Definition at line 673 of file game.cpp.

References set().

◆ show_all_units_in_help()

bool preferences::show_all_units_in_help ( )

Definition at line 903 of file game.cpp.

References get().

Referenced by help::description_type().

◆ show_ally_orb()

bool preferences::show_ally_orb ( )

Definition at line 262 of file general.cpp.

References get(), and game_config::show_ally_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_combat()

bool preferences::show_combat ( )

◆ show_disengaged_orb()

bool preferences::show_disengaged_orb ( )

Definition at line 304 of file general.cpp.

References get(), and game_config::show_disengaged_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_enemy_orb()

bool preferences::show_enemy_orb ( )

Definition at line 276 of file general.cpp.

References get(), and game_config::show_enemy_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_floating_labels()

bool preferences::show_floating_labels ( )

◆ show_fps()

bool preferences::show_fps ( )

Definition at line 887 of file general.cpp.

Referenced by events::console_handler::do_fps(), and display::draw().

◆ show_moved_orb()

bool preferences::show_moved_orb ( )

Definition at line 283 of file general.cpp.

References get(), and game_config::show_moved_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_partial_orb()

bool preferences::show_partial_orb ( )

Definition at line 297 of file general.cpp.

References get(), and game_config::show_partial_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_side_colors()

bool preferences::show_side_colors ( )

Definition at line 743 of file game.cpp.

References get().

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks(), and unit_drawer::redraw_unit().

◆ show_standing_animations()

bool preferences::show_standing_animations ( )

◆ show_status_on_ally_orb()

bool preferences::show_status_on_ally_orb ( )

Definition at line 269 of file general.cpp.

References get(), and game_config::show_status_on_ally_orb.

◆ show_theme_dialog()

bool preferences::show_theme_dialog ( )

◆ show_unmoved_orb()

bool preferences::show_unmoved_orb ( )

Definition at line 290 of file general.cpp.

References get(), and game_config::show_unmoved_orb.

Referenced by orb_status_helper::prefs_show_orb().

◆ show_wesnothd_server_search()

void preferences::show_wesnothd_server_search ( )

◆ shroud()

bool preferences::shroud ( )

◆ shuffle_sides()

bool preferences::shuffle_sides ( )

◆ skip_ai_moves()

bool preferences::skip_ai_moves ( )

◆ skip_mp_replay()

bool preferences::skip_mp_replay ( )

Definition at line 578 of file game.cpp.

References get().

Referenced by gui2::dialogs::mp_lobby::pre_show().

◆ sound_buffer_size()

std::size_t preferences::sound_buffer_size ( )

Definition at line 575 of file general.cpp.

Referenced by sound::init_sound(), and sound::driver_status::query().

◆ sound_on()

bool preferences::sound_on ( )

◆ sound_volume()

int preferences::sound_volume ( )

◆ stop_music_in_background()

bool preferences::stop_music_in_background ( )

◆ sub_achievement()

bool preferences::sub_achievement ( const std::string &  content_for,
const std::string &  id,
const std::string &  sub_id 
)
Parameters
content_forThe achievement group the achievement is part of.
idThe ID of the achievement within the achievement group.
sub_idThe ID of the sub-achievement within the achievement.
Returns
True if the sub-achievement exists and is completed, false otherwise.

Definition at line 1124 of file general.cpp.

References achievement(), and utils::split().

Referenced by achievement::achievement(), and game_lua_kernel::intf_has_sub_achievement().

◆ theme()

std::string preferences::theme ( )

Definition at line 798 of file game.cpp.

References get(), and video::headless().

Referenced by gui2::dialogs::preferences_dialog::set_theme_list(), and show_theme_dialog().

◆ tile_size()

unsigned int preferences::tile_size ( )

Definition at line 665 of file general.cpp.

Referenced by display::display().

◆ toggle_minimap_draw_terrain()

void preferences::toggle_minimap_draw_terrain ( )

Definition at line 872 of file general.cpp.

References minimap_draw_terrain(), and set().

Referenced by hotkey::command_executor::do_execute_command().

◆ toggle_minimap_draw_units()

void preferences::toggle_minimap_draw_units ( )

Definition at line 852 of file general.cpp.

References minimap_draw_units(), and set().

Referenced by hotkey::command_executor::do_execute_command().

◆ toggle_minimap_draw_villages()

void preferences::toggle_minimap_draw_villages ( )

Definition at line 862 of file general.cpp.

References minimap_draw_villages(), and set().

Referenced by hotkey::command_executor::do_execute_command().

◆ toggle_minimap_movement_coding()

void preferences::toggle_minimap_movement_coding ( )

Definition at line 832 of file general.cpp.

References minimap_movement_coding(), and set().

Referenced by hotkey::command_executor::do_execute_command().

◆ toggle_minimap_terrain_coding()

void preferences::toggle_minimap_terrain_coding ( )

Definition at line 842 of file general.cpp.

References minimap_terrain_coding(), and set().

Referenced by hotkey::command_executor::do_execute_command().

◆ turbo()

bool preferences::turbo ( )

◆ turbo_speed()

double preferences::turbo_speed ( )

◆ turn_bell()

bool preferences::turn_bell ( )

◆ turn_dialog()

bool preferences::turn_dialog ( )

◆ turns()

int preferences::turns ( )

◆ UI_sound_on()

bool preferences::UI_sound_on ( )

◆ UI_volume()

int preferences::UI_volume ( )

Definition at line 650 of file general.cpp.

Referenced by sound::init_sound(), and set_UI_volume().

◆ unmoved_color()

std::string preferences::unmoved_color ( )

◆ use_color_cursors()

bool preferences::use_color_cursors ( )

Definition at line 907 of file general.cpp.

References get().

◆ use_map_settings()

bool preferences::use_map_settings ( )

◆ use_twelve_hour_clock_format()

bool preferences::use_twelve_hour_clock_format ( )

◆ user_servers_list()

std::vector< game_config::server_info > preferences::user_servers_list ( )

Definition at line 359 of file game.cpp.

References get_prefs().

◆ village_gold()

int preferences::village_gold ( )

Definition at line 648 of file game.cpp.

References get(), and settings::get_village_gold().

Referenced by ng::configure_engine::village_gold_default().

◆ village_support()

int preferences::village_support ( )

Definition at line 658 of file game.cpp.

References get(), and settings::get_village_support().

Referenced by ng::configure_engine::village_support_default().

◆ vsync()

bool preferences::vsync ( )

Definition at line 439 of file general.cpp.

References get().

Referenced by video::init_window(), and gui2::dialogs::preferences_dialog::initialize_callbacks().

◆ whisper_friends_only()

bool preferences::whisper_friends_only ( )

◆ write_preferences()

void preferences::write_preferences ( )

◆ xp_modifier()

int preferences::xp_modifier ( )

Definition at line 668 of file game.cpp.

References get(), and settings::get_xp_modifier().

Referenced by ng::configure_engine::xp_modifier_default().

◆ yellow_confirm()

bool preferences::yellow_confirm ( )

Definition at line 950 of file game.cpp.

References get().

Referenced by events::menu_handler::end_turn().

Variable Documentation

◆ def_window_height

const int preferences::def_window_height = 720

Definition at line 70 of file general.cpp.

Referenced by resolution(), and video::update_framebuffer().

◆ def_window_width

const int preferences::def_window_width = 1280

Definition at line 69 of file general.cpp.

Referenced by resolution(), and video::update_framebuffer().

◆ event_handler_

prefs_event_handler preferences::event_handler_

◆ INFINITE_AUTO_SAVES

const int preferences::INFINITE_AUTO_SAVES = 61

◆ max_font_scaling

const int preferences::max_font_scaling = 150

Definition at line 76 of file general.cpp.

Referenced by font_scaling(), and set_font_scaling().

◆ max_pixel_scale

const int preferences::max_pixel_scale = 4

Definition at line 79 of file general.cpp.

Referenced by pixel_scale(), set_pixel_scale(), and video::update_framebuffer().

◆ max_window_height

const int preferences::max_window_height = 1080

Definition at line 73 of file general.cpp.

Referenced by video::update_framebuffer().

◆ max_window_width

const int preferences::max_window_width = 1920

Definition at line 72 of file general.cpp.

Referenced by video::update_framebuffer().

◆ min_font_scaling

const int preferences::min_font_scaling = 80

Definition at line 75 of file general.cpp.

Referenced by font_scaling(), and set_font_scaling().

◆ min_pixel_scale

const int preferences::min_pixel_scale = 1

Definition at line 78 of file general.cpp.

Referenced by pixel_scale(), and set_pixel_scale().

◆ min_window_height

const int preferences::min_window_height = 540

◆ min_window_width

const int preferences::min_window_width = 800

◆ pef_view_map

std::map<PREFERENCE_VIEW, std::pair<int,int> > preferences::pef_view_map
static
Initial value:

Map containing page mappings that can be used to set the initially displayed page of the dialog.

The pair is in an 0-indexed toplevel stack/substack format, where the first is the list of main Preference categories (such as General and Display) and the second is any sub-stack found on that page.

TODO: this isn't the most optimal solution, since if the order or number of pages in either stack changes, this map needs to be updated. Optimally the stacked_widget widget would allow specifying page by string id, but that would require changes to generator. It's something to look into, however.

Definition at line 47 of file preferences_dialog.hpp.

◆ singleton

std::unique_ptr<preferences::advanced_manager> preferences::singleton = nullptr
static

Definition at line 24 of file advanced.cpp.

Referenced by get_advanced_preferences(), and init_advanced_manager().