Get and set user-preferences. More...

#include "preferences/general.hpp"
#include "config.hpp"
#include "credentials.hpp"
#include "filesystem.hpp"
#include "game_config.hpp"
#include "hotkey/hotkey_item.hpp"
#include "lexical_cast.hpp"
#include "log.hpp"
#include "sdl/point.hpp"
#include "serialization/parser.hpp"
#include "sound.hpp"
#include "video.hpp"
#include "game_config_view.hpp"
#include <sys/stat.h>
#include <unistd.h>

Include dependency graph for general.cpp:

Classes
class	preferences::prefs_event_handler

Namespaces
	preferences
	Modify, read and display user preferences.

Macros
#define	GETTEXT_DOMAIN "wesnoth-lib"

#define	ERR_CFG LOG_STREAM(err , log_config)

#define	ERR_FS LOG_STREAM(err, log_filesystem)

Functions
void	preferences::write_preferences ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	preferences::disable_preferences_save ()

config *	preferences::get_prefs ()

void	preferences::load_base_prefs ()

bool	preferences::show_ally_orb ()

void	preferences::set_show_ally_orb (bool show_orb)

bool	preferences::show_status_on_ally_orb ()

void	preferences::set_show_status_on_ally_orb (bool show_orb)

bool	preferences::show_enemy_orb ()

void	preferences::set_show_enemy_orb (bool show_orb)

bool	preferences::show_moved_orb ()

void	preferences::set_show_moved_orb (bool show_orb)

bool	preferences::show_unmoved_orb ()

void	preferences::set_show_unmoved_orb (bool show_orb)

bool	preferences::show_partial_orb ()

void	preferences::set_show_partial_orb (bool show_orb)

bool	preferences::show_disengaged_orb ()

void	preferences::set_show_disengaged_orb (bool show_orb)

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

std::string	preferences::allied_color ()

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

std::string	preferences::core_id ()

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

std::string	preferences::enemy_color ()

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

std::string	preferences::moved_color ()

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

std::string	preferences::unmoved_color ()

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

std::string	preferences::partial_color ()

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

bool	preferences::scroll_to_action ()

void	preferences::set_scroll_to_action (bool ison)

point	preferences::resolution ()

int	preferences::pixel_scale ()

void	preferences::set_pixel_scale (const int scale)

bool	preferences::auto_pixel_scale ()

void	preferences::set_auto_pixel_scale (bool choice)

bool	preferences::maximized ()

bool	preferences::fullscreen ()

bool	preferences::vsync ()

void	preferences::_set_resolution (const point &res)

void	preferences::_set_maximized (bool ison)

void	preferences::_set_fullscreen (bool ison)

void	preferences::set_vsync (bool ison)

bool	preferences::turbo ()

void	preferences::set_turbo (bool ison)

double	preferences::turbo_speed ()

void	preferences::set_turbo_speed (const double speed)

int	preferences::font_scaling ()

void	preferences::set_font_scaling (int scale)

int	preferences::font_scaled (int size)

int	preferences::keepalive_timeout ()

void	preferences::keepalive_timeout (int seconds)

bool	preferences::idle_anim ()

void	preferences::set_idle_anim (const bool ison)

int	preferences::idle_anim_rate ()

void	preferences::set_idle_anim_rate (int rate)

std::string	preferences::language ()

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

std::string	preferences::gui_theme ()

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

bool	preferences::ellipses ()

void	preferences::set_ellipses (bool ison)

bool	preferences::grid ()

void	preferences::set_grid (bool ison)

std::size_t	preferences::sound_buffer_size ()

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

int	preferences::music_volume ()

void	preferences::set_music_volume (int vol)

int	preferences::sound_volume ()

void	preferences::set_sound_volume (int vol)

int	preferences::bell_volume ()

void	preferences::set_bell_volume (int vol)

int	preferences::UI_volume ()

void	preferences::set_UI_volume (int vol)

unsigned int	preferences::tile_size ()

void	preferences::set_tile_size (const unsigned int size)

bool	preferences::turn_bell ()

bool	preferences::set_turn_bell (bool ison)

bool	preferences::UI_sound_on ()

bool	preferences::set_UI_sound (bool ison)

bool	preferences::message_bell ()

bool	preferences::sound_on ()

bool	preferences::set_sound (bool ison)

bool	preferences::music_on ()

bool	preferences::set_music (bool ison)

bool	preferences::stop_music_in_background ()

void	preferences::set_stop_music_in_background (bool ison)

int	preferences::scroll_speed ()

void	preferences::set_scroll_speed (const int new_speed)

bool	preferences::middle_click_scrolls ()

bool	preferences::mouse_scroll_enabled ()

void	preferences::enable_mouse_scroll (bool value)

int	preferences::mouse_scroll_threshold ()
	Gets the threshold for when to scroll. More...

bool	preferences::animate_map ()

bool	preferences::animate_water ()

bool	preferences::minimap_movement_coding ()

void	preferences::toggle_minimap_movement_coding ()

bool	preferences::minimap_terrain_coding ()

void	preferences::toggle_minimap_terrain_coding ()

bool	preferences::minimap_draw_units ()

void	preferences::toggle_minimap_draw_units ()

bool	preferences::minimap_draw_villages ()

void	preferences::toggle_minimap_draw_villages ()

bool	preferences::minimap_draw_terrain ()

void	preferences::toggle_minimap_draw_terrain ()

void	preferences::set_animate_map (bool value)

void	preferences::set_animate_water (bool value)

bool	preferences::show_fps ()

void	preferences::set_show_fps (bool value)

int	preferences::draw_delay ()

void	preferences::set_draw_delay (int value)

bool	preferences::use_color_cursors ()

void	preferences::_set_color_cursors (bool value)

void	preferences::load_hotkeys ()

void	preferences::save_hotkeys ()

void	preferences::clear_hotkeys ()

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

optional_const_config	preferences::get_alias ()

unsigned int	preferences::sample_rate ()

void	preferences::save_sample_rate (const unsigned int rate)

bool	preferences::confirm_load_save_from_different_version ()

bool	preferences::use_twelve_hour_clock_format ()

bool	preferences::disable_auto_moves ()

void	preferences::set_disable_auto_moves (bool value)

bool	preferences::damage_prediction_allow_monte_carlo_simulation ()

void	preferences::set_damage_prediction_allow_monte_carlo_simulation (bool value)

std::string	preferences::addon_manager_saved_order_name ()

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

sort_order::type	preferences::addon_manager_saved_order_direction ()

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

std::string	preferences::selected_achievement_group ()

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

bool	preferences::achievement (const std::string &content_for, const std::string &id)

void	preferences::set_achievement (const std::string &content_for, const std::string &id)
	Marks the specified achievement as completed. More...

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. More...

bool	preferences::sub_achievement (const std::string &content_for, const std::string &id, const std::string &sub_id)

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. More...

void	preferences::set_editor_chosen_addon (const std::string &addon_id)

std::string	preferences::editor_chosen_addon ()

Variables
static lg::log_domain	log_config ("config")

static lg::log_domain	log_filesystem ("filesystem")

const int	preferences::min_window_width = 800

const int	preferences::min_window_height = 540

const int	preferences::def_window_width = 1280

const int	preferences::def_window_height = 720

const int	preferences::max_window_width = 1920

const int	preferences::max_window_height = 1080

const int	preferences::min_font_scaling = 80

const int	preferences::max_font_scaling = 150

const int	preferences::min_pixel_scale = 1

const int	preferences::max_pixel_scale = 4

prefs_event_handler	preferences::event_handler_

Detailed Description

Get and set user-preferences.

Definition in file general.cpp.

Macro Definition Documentation

◆ ERR_CFG

#define ERR_CFG LOG_STREAM(err , log_config)

Definition at line 44 of file general.cpp.

◆ ERR_FS

#define ERR_FS LOG_STREAM(err, log_filesystem)

Definition at line 47 of file general.cpp.

◆ GETTEXT_DOMAIN

#define GETTEXT_DOMAIN "wesnoth-lib"

Definition at line 21 of file general.cpp.

Variable Documentation

◆ log_config

lg::log_domain log_config("config") ( "config" )

static

◆ log_filesystem

lg::log_domain log_filesystem("filesystem") ( "filesystem" )

static

Classes

Namespaces

Macros

Functions

Variables