GUI for settings. More...

#include "stdafx.h"
#include "currency.h"
#include "error.h"
#include "settings_gui.h"
#include "textbuf_gui.h"
#include "command_func.h"
#include "network/network.h"
#include "network/network_content.h"
#include "town.h"
#include "settings_internal.h"
#include "strings_func.h"
#include "window_func.h"
#include "string_func.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "slider_func.h"
#include "highscore.h"
#include "base_media_base.h"
#include "base_media_graphics.h"
#include "base_media_music.h"
#include "base_media_sounds.h"
#include "company_base.h"
#include "company_func.h"
#include "viewport_func.h"
#include "core/geometry_func.hpp"
#include "ai/ai.hpp"
#include "blitter/factory.hpp"
#include "language.h"
#include "textfile_gui.h"
#include "stringfilter_type.h"
#include "querystring_gui.h"
#include "fontcache.h"
#include "zoom_func.h"
#include "rev.h"
#include "video/video_driver.hpp"
#include "music/music_driver.hpp"
#include "gui.h"
#include "mixer.h"
#include "newgrf_config.h"
#include "network/core/config.h"
#include "network/network_gui.h"
#include "network/network_survey.h"
#include "social_integration.h"
#include "sound_func.h"
#include "settingentry_gui.h"
#include "table/strings.h"
#include "dropdown_common_type.h"
#include "safeguards.h"

Data Structures
struct	BaseSetTextfileWindow
	Window for displaying the textfile of a BaseSet. More...

class	NWidgetSocialPlugins

struct	GameOptionsWindow

struct	GameSettingsWindow
	Window to edit settings of the game. More...

struct	CustomCurrencyWindow

Enumerations
enum	WarnHiddenResult : uint8_t { WHR_NONE , WHR_CATEGORY , WHR_TYPE , WHR_CATEGORY_TYPE }
	Warnings about hidden search results. More...

Functions
static uint	GetCurrentResolutionIndex ()
	Get index of the current screen resolution.

static void	ShowCustCurrency ()
	Open custom currency window.

template<class TBaseSet >
void	ShowBaseSetTextfileWindow (TextfileType file_type, const TBaseSet *baseset, StringID content_type)
	Open the BaseSet version of the textfile window.

template<typename TBaseSet >
static std::string	GetListLabel (const TBaseSet *baseset)
	Get string to use when listing this set in the settings window.

template<class T >
DropDownList	BuildSetDropDownList (int *selected_index)

static void	AddCustomRefreshRates ()
	Add the refresh rate from the config and the refresh rates from all the monitors to our list of refresh rates shown in the GUI.

static std::optional< std::string >	ScaleMarkFunc (int, int, int value)

static std::optional< std::string >	VolumeMarkFunc (int, int mark, int value)

std::unique_ptr< NWidgetBase >	MakeNWidgetSocialPlugins ()
	Construct nested container widget for managing the list of social plugins.

void	ShowGameOptions ()
	Open the game options window.

static void	ResetAllSettingsConfirmationCallback (Window *w, bool confirmed)
	Callback function for the reset all settings button.

void	ShowGameSettings ()
	Open advanced settings window.

void	DrawArrowButtons (int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
	Draw [<][>] boxes.

void	DrawDropDownButton (int x, int y, Colours button_colour, bool state, bool clickable)
	Draw a dropdown button.

void	DrawBoolButton (int x, int y, bool state, bool clickable)
	Draw a toggle button.

Variables
static const StringID	_autosave_dropdown []

static const uint32_t	_autosave_dropdown_to_minutes []
	Available settings for autosave intervals.

Dimension	_setting_circle_size
	Dimension of the circle +/- icon. This is here as not all users are within the class of the settings window.

std::set< int >	_refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 }

static const int	SCALE_NMARKS = (MAX_INTERFACE_SCALE - MIN_INTERFACE_SCALE) / 25 + 1

static const int	VOLUME_NMARKS = 9

static constexpr NWidgetPart	_nested_social_plugins_widgets []

static constexpr NWidgetPart	_nested_social_plugins_none_widgets []

static constexpr NWidgetPart	_nested_game_options_widgets []

static WindowDesc	_game_options_desc (WDP_CENTER, nullptr, 0, 0, WC_GAME_OPTIONS, WC_NONE, {}, _nested_game_options_widgets)

int	SETTING_HEIGHT = 11
	Height of a single setting in the tree view in pixels.

static const StringID	_game_settings_restrict_dropdown []

static constexpr NWidgetPart	_nested_settings_selection_widgets []

static WindowDesc	_settings_selection_desc (WDP_CENTER, "settings", 510, 450, WC_GAME_OPTIONS, WC_NONE, {}, _nested_settings_selection_widgets)

static constexpr NWidgetPart	_nested_cust_currency_widgets []

static WindowDesc	_cust_currency_desc (WDP_CENTER, nullptr, 0, 0, WC_CUSTOM_CURRENCY, WC_NONE, {}, _nested_cust_currency_widgets)

Detailed Description

GUI for settings.

Definition in file settings_gui.cpp.

Macro Definition Documentation

◆ HAS_TRUETYPE_FONT

#define HAS_TRUETYPE_FONT

Definition at line 65 of file settings_gui.cpp.

Enumeration Type Documentation

◆ WarnHiddenResult

enum WarnHiddenResult : uint8_t

Warnings about hidden search results.

Enumerator
WHR_NONE	Nothing was filtering matches away.
WHR_CATEGORY	Category setting filtered matches away.
WHR_TYPE	Type setting filtered matches away.
WHR_CATEGORY_TYPE	Both category and type settings filtered matches away.

Definition at line 1208 of file settings_gui.cpp.

Function Documentation

◆ AddCustomRefreshRates()

static void AddCustomRefreshRates ( )

static

Add the refresh rate from the config and the refresh rates from all the monitors to our list of refresh rates shown in the GUI.

Definition at line 165 of file settings_gui.cpp.

References _settings_client, VideoDriver::GetInstance(), VideoDriver::GetListOfMonitorRefreshRates(), ClientSettings::gui, and GUISettings::refresh_rate.

◆ BuildSetDropDownList()

template<class T >

DropDownList BuildSetDropDownList ( int * selected_index )

Definition at line 148 of file settings_gui.cpp.

◆ DrawArrowButtons()

void DrawArrowButtons	(	int	x,
		int	y,
		Colours	button_colour,
		uint8_t	state,
		bool	clickable_left,
		bool	clickable_right
	)

Draw [<][>] boxes.

Parameters

x	the x position to draw
y	the y position to draw
button_colour	the colour of the button
state	0 = none clicked, 1 = first clicked, 2 = second clicked
clickable_left	is the left button clickable?
clickable_right	is the right button clickable?

Definition at line 1824 of file settings_gui.cpp.

References _current_text_dir, WidgetDimensions::bevel, DrawFrameRect(), FILLRECT_CHECKER, GetColourGradient(), GfxFillRect(), Lowered, SA_CENTER, WidgetDimensions::scaled, Rect::Shrink(), and TD_RTL.

Referenced by IndustryViewWindow::DrawInfo(), SettingEntry::DrawSetting(), GSConfigWindow::DrawWidget(), NewGRFParametersWindow::DrawWidget(), and ScriptSettingsWindow::DrawWidget().

◆ DrawBoolButton()

void DrawBoolButton	(	int	x,
		int	y,
		bool	state,
		bool	clickable
	)

Draw a toggle button.

Parameters

x	the x position to draw
y	the y position to draw
state	true = lowered
clickable	is the button clickable?

Definition at line 1876 of file settings_gui.cpp.

References DrawFrameRect(), Lowered, SETTING_BUTTON_HEIGHT, and SETTING_BUTTON_WIDTH.

Referenced by SettingEntry::DrawSetting(), GSConfigWindow::DrawWidget(), NewGRFParametersWindow::DrawWidget(), and ScriptSettingsWindow::DrawWidget().

◆ DrawDropDownButton()

void DrawDropDownButton	(	int	x,
		int	y,
		Colours	button_colour,
		bool	state,
		bool	clickable
	)

Draw a dropdown button.

Parameters

x	the x position to draw
y	the y position to draw
button_colour	the colour of the button
state	true = lowered
clickable	is the button clickable?

Definition at line 1855 of file settings_gui.cpp.

References WidgetDimensions::bevel, DrawFrameRect(), FILLRECT_CHECKER, GetColourGradient(), GfxFillRect(), Lowered, SA_CENTER, WidgetDimensions::scaled, SETTING_BUTTON_HEIGHT, SETTING_BUTTON_WIDTH, and Rect::Shrink().

Referenced by SettingEntry::DrawSetting(), GSConfigWindow::DrawWidget(), NewGRFParametersWindow::DrawWidget(), and ScriptSettingsWindow::DrawWidget().

◆ GetCurrentResolutionIndex()

static uint GetCurrentResolutionIndex ( )

static

Get index of the current screen resolution.

Returns: Index of the current screen resolution if it is a known resolution, _resolutions.size() otherwise.

Definition at line 92 of file settings_gui.cpp.

References _resolutions.

Referenced by GameOptionsWindow::BuildDropDownList(), and GameOptionsWindow::GetWidgetString().

◆ GetListLabel()

template<typename TBaseSet >

static std::string GetListLabel ( const TBaseSet * baseset )

static

Get string to use when listing this set in the settings window.

If there are no invalid files, then this is just the set name, otherwise a string is formatted including the number of invalid files.

Returns: the string to display.

Definition at line 141 of file settings_gui.cpp.

References GetString().

Referenced by GameOptionsWindow::GetWidgetString().

◆ MakeNWidgetSocialPlugins()

std::unique_ptr< NWidgetBase > MakeNWidgetSocialPlugins ( )

Construct nested container widget for managing the list of social plugins.

Definition at line 355 of file settings_gui.cpp.

◆ ResetAllSettingsConfirmationCallback()

static void ResetAllSettingsConfirmationCallback	(	Window *	w,
		bool	confirmed
	)

static

Callback function for the reset all settings button.

Parameters

w	Window which is calling this callback
confirmed	boolean value, true when yes was clicked, false otherwise

Definition at line 1220 of file settings_gui.cpp.

References SettingsContainer::FoldAll(), GetSettingsTree(), Window::InvalidateData(), and SettingsContainer::ResetAll().

Referenced by GameSettingsWindow::OnClick().

◆ ScaleMarkFunc()

static std::optional< std::string > ScaleMarkFunc	(	int	,
		int	,
		int	value
	)

static

Definition at line 178 of file settings_gui.cpp.

◆ ShowBaseSetTextfileWindow()

template<class TBaseSet >

void ShowBaseSetTextfileWindow	(	TextfileType	file_type,
		const TBaseSet *	baseset,
		StringID	content_type
	)

Open the BaseSet version of the textfile window.

Parameters

file_type	The type of textfile to display.
baseset	The BaseSet to use.
content_type	STR_CONTENT_TYPE_xxx for title.

Definition at line 128 of file settings_gui.cpp.

References CloseWindowById(), and WC_TEXTFILE.

Referenced by GameOptionsWindow::OnClick().

◆ ShowCustCurrency()

static void ShowCustCurrency ( )

static

Open custom currency window.

Definition at line 2109 of file settings_gui.cpp.

References CloseWindowById(), and WC_CUSTOM_CURRENCY.

Referenced by GameOptionsWindow::OnDropdownSelect().

◆ ShowGameOptions()

void ShowGameOptions ( )

Open the game options window.

Definition at line 1190 of file settings_gui.cpp.

References CloseWindowByClass(), and WC_GAME_OPTIONS.

Referenced by MenuClickSettings(), SelectGameWindow::OnClick(), MainToolbarWindow::OnHotkey(), and ScenarioEditorToolbarWindow::OnHotkey().

◆ ShowGameSettings()

void ShowGameSettings ( )

Open advanced settings window.

Definition at line 1808 of file settings_gui.cpp.

References CloseWindowByClass(), and WC_GAME_OPTIONS.

Referenced by MenuClickSettings(), and SelectGameWindow::OnClick().

◆ VolumeMarkFunc()

static std::optional< std::string > VolumeMarkFunc	(	int	,
		int	mark,
		int	value
	)

static

Definition at line 186 of file settings_gui.cpp.

Variable Documentation

◆ _autosave_dropdown

const StringID _autosave_dropdown[]

static

Initial value:

= {
  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_10_MINUTES,
  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_30_MINUTES,
  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_60_MINUTES,
  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_120_MINUTES,
  INVALID_STRING_ID,
}

Definition at line 68 of file settings_gui.cpp.

◆ _autosave_dropdown_to_minutes

const uint32_t _autosave_dropdown_to_minutes[]

static

Initial value:

= {
  0, 
  10,
  30,
  60,
  120,
}

Available settings for autosave intervals.

Definition at line 78 of file settings_gui.cpp.

Referenced by GameOptionsWindow::BuildDropDownList(), GameOptionsWindow::GetWidgetString(), and GameOptionsWindow::OnDropdownSelect().

◆ _game_settings_restrict_dropdown

const StringID _game_settings_restrict_dropdown[]

static

Initial value:

= {
  STR_CONFIG_SETTING_RESTRICT_BASIC,                            
  STR_CONFIG_SETTING_RESTRICT_ADVANCED,                         
  STR_CONFIG_SETTING_RESTRICT_ALL,                              
  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,          
  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,              
}

Definition at line 1198 of file settings_gui.cpp.

◆ _nested_cust_currency_widgets

constexpr NWidgetPart _nested_cust_currency_widgets[]

staticconstexpr

Definition at line 2060 of file settings_gui.cpp.

◆ _nested_game_options_widgets

constexpr NWidgetPart _nested_game_options_widgets[]

staticconstexpr

Definition at line 1000 of file settings_gui.cpp.

◆ _nested_settings_selection_widgets

constexpr NWidgetPart _nested_settings_selection_widgets[]

staticconstexpr

Definition at line 1760 of file settings_gui.cpp.

◆ _nested_social_plugins_none_widgets

constexpr NWidgetPart _nested_social_plugins_none_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_TEXT, INVALID_COLOUR), SetMinimalSize(0, 12), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGINS_NONE),
  EndContainer(),
}

Definition at line 210 of file settings_gui.cpp.

◆ _nested_social_plugins_widgets

constexpr NWidgetPart _nested_social_plugins_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_FRAME, COLOUR_GREY, WID_GO_SOCIAL_PLUGIN_TITLE),
      NWidget(NWID_HORIZONTAL), SetPIP(0, WidgetDimensions::unscaled.hsep_normal, 0),
        NWidget(WWT_TEXT, INVALID_COLOUR), SetMinimalSize(0, 12), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_PLATFORM),
        NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_SOCIAL_PLUGIN_PLATFORM), SetMinimalSize(100, 12), SetAlignment(SA_RIGHT),
      EndContainer(),
      NWidget(NWID_HORIZONTAL), SetPIP(0, WidgetDimensions::unscaled.hsep_normal, 0),
        NWidget(WWT_TEXT, INVALID_COLOUR), SetMinimalSize(0, 12), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE),
        NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_SOCIAL_PLUGIN_STATE), SetMinimalSize(100, 12), SetAlignment(SA_RIGHT),
      EndContainer(),
    EndContainer(),
  EndContainer(),
}

Definition at line 195 of file settings_gui.cpp.

◆ _refresh_rates

std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 }

Definition at line 159 of file settings_gui.cpp.

◆ _setting_circle_size

Dimension _setting_circle_size

Dimension of the circle +/- icon. This is here as not all users are within the class of the settings window.

Definition at line 86 of file settings_gui.cpp.

Referenced by BaseSettingEntry::Draw(), SettingsPage::DrawSetting(), and GameSettingsWindow::UpdateWidgetSize().

◆ SCALE_NMARKS

const int SCALE_NMARKS = (MAX_INTERFACE_SCALE - MIN_INTERFACE_SCALE) / 25 + 1

static

Definition at line 175 of file settings_gui.cpp.

◆ SETTING_HEIGHT

int SETTING_HEIGHT = 11

Height of a single setting in the tree view in pixels.

Definition at line 1196 of file settings_gui.cpp.

Referenced by BaseSettingEntry::Draw(), SettingEntry::DrawSetting(), SettingsPage::DrawSetting(), GameSettingsWindow::DrawWidget(), GameSettingsWindow::OnClick(), and GameSettingsWindow::UpdateWidgetSize().

◆ VOLUME_NMARKS

const int VOLUME_NMARKS = 9

static

Definition at line 176 of file settings_gui.cpp.

Data Structures

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ HAS_TRUETYPE_FONT

Enumeration Type Documentation

◆ WarnHiddenResult

Function Documentation

◆ AddCustomRefreshRates()

◆ BuildSetDropDownList()

◆ DrawArrowButtons()

◆ DrawBoolButton()

◆ DrawDropDownButton()

◆ GetCurrentResolutionIndex()

◆ GetListLabel()

◆ MakeNWidgetSocialPlugins()

◆ ResetAllSettingsConfirmationCallback()

◆ ScaleMarkFunc()

◆ ShowBaseSetTextfileWindow()

◆ ShowCustCurrency()

◆ ShowGameOptions()

◆ ShowGameSettings()

◆ VolumeMarkFunc()

Variable Documentation

◆ _autosave_dropdown

◆ _autosave_dropdown_to_minutes

◆ _game_settings_restrict_dropdown

◆ _nested_cust_currency_widgets

◆ _nested_game_options_widgets

◆ _nested_settings_selection_widgets

◆ _nested_social_plugins_none_widgets

◆ _nested_social_plugins_widgets

◆ _refresh_rates

◆ _setting_circle_size

◆ SCALE_NMARKS

◆ SETTING_HEIGHT

◆ VOLUME_NMARKS