25#include "slider_func.h"
57#include "table/strings.h"
64#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
65# define HAS_TRUETYPE_FONT
68static const StringID _autosave_dropdown[] = {
69 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
70 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_10_MINUTES,
71 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_30_MINUTES,
72 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_60_MINUTES,
73 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_120_MINUTES,
107 this->ConstructWindow();
114 return GetString(stringid, this->content_type, this->name);
127template <
class TBaseSet>
140template <
typename TBaseSet>
143 if (baseset->GetNumInvalid() == 0)
return GetString(STR_JUST_RAW_STRING, baseset->name);
144 return GetString(STR_BASESET_STATUS, baseset->name, baseset->GetNumInvalid());
150 int n = T::GetNumSets();
151 *selected_index = T::GetIndexOfUsedSet();
153 for (
int i = 0; i < n; i++) {
154 list.push_back(MakeDropDownListStringItem(
GetListLabel(T::GetSet(i)), i));
159std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 };
172 std::copy(monitorRates.begin(), monitorRates.end(), std::inserter(_refresh_rates, _refresh_rates.end()));
175static const int SCALE_NMARKS = (MAX_INTERFACE_SCALE - MIN_INTERFACE_SCALE) / 25 + 1;
176static const int VOLUME_NMARKS = 9;
178static std::optional<std::string> ScaleMarkFunc(
int,
int,
int value)
181 if (value % 100 != 0)
return std::string{};
183 return GetString(STR_GAME_OPTIONS_GUI_SCALE_MARK, value / 100, 0);
186static std::optional<std::string> VolumeMarkFunc(
int,
int mark,
int value)
189 if (mark % 2 != 0)
return std::string{};
192 return GetString(STR_GAME_OPTIONS_VOLUME_MARK, value / 31 * 25);
195static constexpr NWidgetPart _nested_social_plugins_widgets[] = {
210static constexpr NWidgetPart _nested_social_plugins_none_widgets[] = {
222 if (this->plugins.empty()) {
223 auto widget =
MakeNWidgets(_nested_social_plugins_none_widgets,
nullptr);
224 this->
Add(std::move(widget));
226 for (
size_t i = 0; i < this->plugins.size(); i++) {
227 auto widget =
MakeNWidgets(_nested_social_plugins_widgets,
nullptr);
228 this->
Add(std::move(widget));
243 this->current_index = -1;
253 template <
typename T>
256 std::string *longest = &(this->plugins[0]->*member);
257 int longest_length = 0;
259 for (
auto *plugin : this->plugins) {
261 if (length > longest_length) {
262 longest_length = length;
263 longest = &(plugin->*member);
275 if (this->current_index < 0) {
279 if (this->plugins[this->current_index]->name.empty()) {
280 return this->plugins[this->current_index]->basepath;
283 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_TITLE, this->plugins[this->current_index]->name, this->plugins[this->current_index]->version);
287 if (this->current_index < 0) {
291 return this->plugins[this->current_index]->social_platform;
294 static const std::pair<SocialIntegrationPlugin::State, StringID> state_to_string[] = {
305 if (this->current_index < 0) {
310 int longest_length = 0;
311 for (
const auto &[state,
string] : state_to_string) {
313 if (length > longest_length) {
314 longest_length = length;
319 return GetString(longest, longest_plugin);
322 const auto plugin = this->plugins[this->current_index];
325 for (
const auto &[state,
string] : state_to_string) {
326 if (plugin->state == state) {
327 return GetString(
string, plugin->social_platform);
332 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_FAILED, plugin->social_platform);
335 default: NOT_REACHED();
341 this->current_index = 0;
345 this->current_index++;
350 int current_index = -1;
351 std::vector<SocialIntegrationPlugin *> plugins{};
357 return std::make_unique<NWidgetSocialPlugins>();
375 this->SetTab(GameOptionsWindow::active_tab);
406 if (currency.code.empty()) {
407 list.push_back(MakeDropDownListStringItem(currency.name, i,
HasBit(disabled, i)));
415 list.push_back(MakeDropDownListDividerItem());
428 const StringID *items = _autosave_dropdown;
430 list.push_back(MakeDropDownListStringItem(*items, i));
436 for (uint i = 0; i <
_languages.size(); i++) {
453 list.push_back(MakeDropDownListStringItem(name, i));
473 for (
auto it = _refresh_rates.begin(); it != _refresh_rates.end(); it++) {
474 auto i = std::distance(_refresh_rates.begin(), it);
511 return GetString(_autosave_dropdown[index - 1]);
532 assert(plugin !=
nullptr);
534 return plugin->GetWidgetString(widget, stringid);
558 DrawSliderWidget(r, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, SCALE_NMARKS, this->gui_scale, ScaleMarkFunc);
579 GameOptionsWindow::active_tab = widget;
587 default: NOT_REACHED();
636 d.width += padding.width;
637 d.height += padding.height;
682 this->SetTab(widget);
706 ShowSurveyResultTextfileWindow();
711 if (!ToggleFullScreen(!_fullscreen)) {
753#ifdef HAS_TRUETYPE_FONT
805 if (used_set ==
nullptr || !used_set->IsConfigurable())
break;
806 GRFConfig &extra_cfg = used_set->GetOrCreateExtraConfig();
808 OpenGRFParameterWindow(
true, extra_cfg, _game_mode == GM_MENU);
809 if (_game_mode == GM_MENU) this->reload =
true;
820 SetEffectVolume(
vol);
914 ClearAllCachedNames();
937 if (_game_mode == GM_MENU) {
976#ifdef HAS_TRUETYPE_FONT
1000static constexpr NWidgetPart _nested_game_options_widgets[] = {
1047 NWidget(
WWT_EMPTY, INVALID_COLOUR,
WID_GO_GUI_SCALE),
SetMinimalSize(67, 0),
SetMinimalTextLines(1, 12 +
WidgetDimensions::unscaled.vsep_normal,
FS_SMALL),
SetFill(0, 0),
SetToolTip(STR_GAME_OPTIONS_GUI_SCALE_TOOLTIP),
1056#ifdef HAS_TRUETYPE_FONT
1124 NWidget(
WWT_EMPTY, INVALID_COLOUR,
WID_GO_BASE_SFX_VOLUME),
SetMinimalSize(67, 0),
SetMinimalTextLines(1, 12 +
WidgetDimensions::unscaled.vsep_normal,
FS_SMALL),
SetFill(1, 0),
SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1128 NWidget(
WWT_EMPTY, INVALID_COLOUR,
WID_GO_BASE_MUSIC_VOLUME),
SetMinimalSize(67, 0),
SetMinimalTextLines(1, 12 +
WidgetDimensions::unscaled.vsep_normal,
FS_SMALL),
SetFill(1, 0),
SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1137 NWidget(
WWT_EMPTY, INVALID_COLOUR,
WID_GO_BASE_SFX_DESCRIPTION),
SetMinimalSize(200, 0),
SetMinimalTextLines(1, 0),
SetToolTip(STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP),
SetFill(1, 0),
1156 NWidget(
WWT_EMPTY, INVALID_COLOUR,
WID_GO_BASE_MUSIC_DESCRIPTION),
SetMinimalSize(200, 0),
SetMinimalTextLines(1, 0),
SetToolTip(STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP),
SetFill(1, 0),
1186 _nested_game_options_widgets
1198static const StringID _game_settings_restrict_dropdown[] = {
1199 STR_CONFIG_SETTING_RESTRICT_BASIC,
1200 STR_CONFIG_SETTING_RESTRICT_ADVANCED,
1201 STR_CONFIG_SETTING_RESTRICT_ALL,
1202 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,
1203 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,
1205static_assert(
lengthof(_game_settings_restrict_dropdown) ==
RM_END);
1293 std::max(size.height,
GetSettingsTree().GetMaxHelpHeight(size.width));
1309 if (this->closing_dropdown) {
1310 this->closing_dropdown =
false;
1311 assert(this->valuedropdown_entry !=
nullptr);
1313 this->valuedropdown_entry =
nullptr;
1320 if (this->warn_missing ==
WHR_NONE) {
1333 if (this->warn_missing !=
WHR_NONE) {
1364 for (
int mode = 0; mode !=
RM_END; mode++) {
1369 list.push_back(MakeDropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
1397 if (this->last_clicked !=
nullptr) {
1402 switch (
sd->GetType()) {
1406 default: NOT_REACHED();
1430 if (this->last_clicked != pe) this->
SetDirty();
1431 this->last_clicked = pe;
1438 this->manually_changed_folding =
true;
1444 this->manually_changed_folding =
true;
1460 if (!list.empty()) {
1468 if (!list.empty()) {
1494 this->manually_changed_folding =
true;
1505 if (!
sd->IsEditable()) {
1517 if (this->valuedropdown_entry == pe) {
1520 this->closing_dropdown =
false;
1522 this->valuedropdown_entry =
nullptr;
1524 if (this->valuedropdown_entry !=
nullptr) this->valuedropdown_entry->
SetButtons({});
1525 this->closing_dropdown =
false;
1537 if (
pt.y >= wi_rect.top &&
pt.y <= wi_rect.bottom) {
1538 this->valuedropdown_entry = pe;
1555 if (
sd->IsBoolSetting()) {
1588 if (this->clicked_entry !=
nullptr) {
1589 this->clicked_entry->SetButtons({});
1591 this->clicked_entry = pe;
1612 this->valuewindow_entry = pe;
1622 if (this->clicked_entry !=
nullptr) {
1624 this->clicked_entry =
nullptr;
1632 if (!str.has_value())
return;
1634 assert(this->valuewindow_entry !=
nullptr);
1638 if (!str->empty()) {
1646 value =
sd->GetDefaultValue();
1661 if (!this->manually_changed_folding) {
1680 assert(this->valuedropdown_entry !=
nullptr);
1703 assert(this->valuedropdown_entry !=
nullptr);
1704 this->closing_dropdown =
true;
1728 if (this->last_clicked !=
nullptr && !
GetSettingsTree().IsVisible(this->last_clicked)) {
1760static constexpr NWidgetPart _nested_settings_selection_widgets[] = {
1770 NWidget(
WWT_DROPDOWN, COLOUR_MAUVE,
WID_GS_RESTRICT_DROPDOWN),
SetMinimalSize(100, 12),
SetToolTip(STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT),
SetFill(1, 0),
SetResize(1, 0),
1774 NWidget(
WWT_DROPDOWN, COLOUR_MAUVE,
WID_GS_TYPE_DROPDOWN),
SetMinimalSize(100, 12),
SetToolTip(STR_CONFIG_SETTING_TYPE_DROPDOWN_HELPTEXT),
SetFill(1, 0),
SetResize(1, 0),
1804 _nested_settings_selection_widgets
1824void DrawArrowButtons(
int x,
int y, Colours button_colour, uint8_t state,
bool clickable_left,
bool clickable_right)
1827 Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
1829 Rect lr = {x, y, x + (int)dim.width - 1, y + (
int)dim.height - 1};
1830 Rect rr = {x + (int)dim.width, y, x + (
int)dim.width * 2 - 1, y + (int)dim.height - 1};
1834 DrawSpriteIgnorePadding(SPR_ARROW_LEFT, PAL_NONE, lr,
SA_CENTER);
1835 DrawSpriteIgnorePadding(SPR_ARROW_RIGHT, PAL_NONE, rr,
SA_CENTER);
1839 if (rtl ? !clickable_right : !clickable_left) {
1842 if (rtl ? !clickable_left : !clickable_right) {
1862 DrawSpriteIgnorePadding(SPR_ARROW_DOWN, PAL_NONE, r,
SA_CENTER);
1878 static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
1894 void SetButtonState()
2014 this->query_widget = line;
2024 if (!str.has_value())
return;
2026 switch (this->query_widget) {
2060static constexpr NWidgetPart _nested_cust_currency_widgets[] = {
2096 SetToolTip(STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP),
2105 _nested_cust_currency_widgets
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
Base functions for all AIs.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().
static MusicDriver * GetInstance()
Get the currently active instance of the music driver.
virtual void SetVolume(uint8_t vol)=0
Set the volume, if possible.
std::string social_platform
Social platform this plugin is for.
std::string name
Name of the plugin.
std::string version
Version of the plugin.
@ PLATFORM_NOT_RUNNING
The plugin failed to initialize because the Social Platform is not running.
@ UNSUPPORTED_API
The plugin does not support the current API version.
@ RUNNING
The plugin is successfully loaded and running.
@ FAILED
The plugin failed to initialize.
@ DUPLICATE
Another plugin of the same Social Platform is already loaded.
@ INVALID_SIGNATURE
The signature of the plugin is invalid.
@ UNLOADED
The plugin is unloaded upon request.
static std::vector< SocialIntegrationPlugin * > GetPlugins()
Get the list of loaded social integration plugins.
static constexpr TimerGame< struct Calendar >::Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
virtual void ToggleVsync(bool vsync)
Change the vsync setting.
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
virtual std::vector< int > GetListOfMonitorRefreshRates()
Get a list of refresh rates of each available monitor.
Functions related to commands.
Definition of stuff that is very close to a company, like the company struct itself.
Functions related to companies.
Configuration options of the network stuff.
static const std::string NETWORK_SURVEY_DETAILS_LINK
Link with more details & privacy statement of the survey.
std::array< CurrencySpec, CURRENCY_END > _currency_specs
Array of currencies used by the system.
Functions to handle different currencies.
static constexpr TimerGameCalendar::Year MIN_EURO_YEAR
The earliest year custom currencies may switch to the Euro.
@ CURRENCY_CUSTOM
Custom currency.
CurrencySpec & GetCustomCurrency()
Get the custom currency.
static constexpr TimerGameCalendar::Year CF_NOEURO
Currency never switches to the Euro (as far as known).
const CurrencySpec & GetCurrency()
Get the currently selected currency.
std::vector< Dimension > _resolutions
List of resolutions.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
Dimension GetDropDownListDimension(const DropDownList &list)
Determine width and height required to fully display a DropDownList.
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist)
Show a drop down list.
Common drop down list components.
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Functions related to errors.
@ WL_ERROR
Errors (eg. saving/loading failed)
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
Factory to 'query' all available blitters.
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
void InitFontCache(bool monospace)
(Re)initialize the font cache related things, i.e.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Functions to read fonts from files and cache them.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
int GetStringLineCount(std::string_view str, int maxw)
Calculates number of lines of string.
bool _left_button_down
Is left mouse button pressed?
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
bool _ctrl_pressed
Is Ctrl pressed?
bool _left_button_clicked
Is left mouse button clicked?
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
int _gui_scale_cfg
GUI scale in config.
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
SwitchMode _switch_mode
The next mainloop command.
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
int _gui_scale
GUI scale, 100 is 100%.
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
@ FS_SMALL
Index of the small font in the font tables.
@ FS_NORMAL
Index of the normal font in the font tables.
@ SA_RIGHT
Right align the text (must be a single bit).
@ SA_CENTER
Center both horizontally and vertically.
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
GUI functions that shouldn't be here.
Declaration of functions and types defined in highscore.h and highscore_gui.h.
Information about languages and their files.
LanguageList _languages
The actual list of language meta data.
const LanguageMetadata * _current_language
The currently loaded language.
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
void ShowQuery(EncodedString &&caption, EncodedString &&message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
void ShowQueryString(std::string_view str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Functions to mix sound samples.
Base for all music playback.
void ChangeMusicSet(int index)
Change the configured music set and reset playback.
bool _network_available
is network mode available?
Basic functions/variables used all over the place.
Part of the network protocol handling content distribution.
void ShowNetworkContentListWindow(ContentVector *cv=nullptr, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
GUIs related to networking.
Part of the network protocol handling opt-in survey.
@ Length
Vehicle length (trains and road vehicles)
Functions to find and configure NewGRFs.
void ChangeAutosaveFrequency(bool reset)
Reset the interval of the autosave.
@ SM_MENU
Switch to game intro menu.
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Base for the GUIs that have an edit box in them.
declaration of OTTD revision dependent variables
A number of safeguards to prevent using unsafe methods.
SettingsContainer & GetSettingsTree()
Construct settings tree.
Declarations of classes for handling display of individual configuration settings.
RestrictionMode
How the list of advanced settings is filtered.
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
@ RM_ALL
List all settings regardless of the default/newgame/... values.
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
@ RM_END
End for iteration.
@ RM_BASIC
Display settings associated to the "basic" list.
@ LeftDepressed
Of a numeric setting entry, the left button is depressed.
@ RightDepressed
Of a numeric setting entry, the right button is depressed.
bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
ClientSettings _settings_client
The current settings for this game.
void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
Callback function for the reset all settings button.
WarnHiddenResult
Warnings about hidden search results.
@ WHR_CATEGORY_TYPE
Both category and type settings filtered matches away.
@ WHR_CATEGORY
Category setting filtered matches away.
@ WHR_NONE
Nothing was filtering matches away.
@ WHR_TYPE
Type setting filtered matches away.
static const uint32_t _autosave_dropdown_to_minutes[]
Available settings for autosave intervals.
static std::string GetListLabel(const TBaseSet *baseset)
Get string to use when listing this set in the settings window.
static void AddCustomRefreshRates()
Add the refresh rate from the config and the refresh rates from all the monitors to our list of refre...
std::unique_ptr< NWidgetBase > MakeNWidgetSocialPlugins()
Construct nested container widget for managing the list of social plugins.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
void ShowGameSettings()
Open advanced settings window.
static uint GetCurrentResolutionIndex()
Get index of the current screen resolution.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
static void ShowCustCurrency()
Open custom currency window.
void ShowGameOptions()
Open the game options window.
Dimension _circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
Functions for setting GUIs.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
Functions and types used internally for the settings configurations.
@ GuiCurrency
The number represents money, so when reading value multiply by exchange rate.
@ GuiZeroIsSpecial
A value of zero is possible and has a custom string (the one after "strval").
@ GuiDropdown
The value represents a limited number of string-options (internally integer) presented as dropdown.
SettingType
Type of settings for filtering.
@ ST_CLIENT
Client setting.
@ ST_ALL
Used in setting filter to match all types.
@ ST_COMPANY
Company setting.
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
void DrawSliderWidget(Rect r, int min_value, int max_value, int nmarks, int value, SliderMarkFunc *mark_func)
Draw a slider widget with knob at given value.
bool ClickSliderWidget(Rect r, Point pt, int min_value, int max_value, int nmarks, int &value)
Handle click on a slider widget to change the value.
Interface definitions for game to report/respond to social integration.
void ChangeSoundSet(int index)
Change the configured sound set and reset sounds.
Functions related to sound.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Functions related to low-level strings.
CharSetFilter
Valid filter types for IsValidChar.
@ CS_NUMERAL
Only numeric ones.
@ CS_NUMERAL_SIGNED
Only numbers and '-' for negative values.
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Searching and filtering using a stringterm.
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
TextDirection _current_text_dir
Text direction of the currently selected language.
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
@ TD_RTL
Text is written right-to-left by default.
Window for displaying the textfile of a BaseSet.
const std::string name
Name of the content.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
const StringID content_type
STR_CONTENT_TYPE_xxx for title.
Data structure describing a single setting in a tab.
SettingEntryFlags flags
Flags of the setting entry.
uint8_t level
Nesting level of this setting entry.
MusicSettings music
settings related to music/sound
NetworkSettings network
settings related to the network
GUISettings gui
settings related to the GUI
Specification of a currency.
std::string separator
The thousands separator for this currency.
std::string prefix
Prefix to apply when formatting money in this currency.
TimerGameCalendar::Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
std::string suffix
Suffix to apply when formatting money in this currency.
std::string code
3 letter untranslated code to identify the currency.
uint16_t rate
The conversion rate compared to the base currency.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnTimeout() override
Called when this window's timeout has been reached.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
Dimensions (a width and height) of a rectangle in 2D.
bool prefer_sprite
Whether to prefer the built-in sprite font over resizable fonts.
bool global_aa
Whether to anti alias all font sizes.
Information about GRF, used in the game and (part of it) in savegames.
void SetParameterDefaults()
Set the default value for all parameters as specified by action14.
std::vector< uint32_t > param
GRF parameters.
uint8_t settings_restriction_mode
selected restriction mode in adv. settings GUI.
uint16_t refresh_rate
How often we refresh the screen (time between draw-ticks).
uint32_t autosave_interval
how often should we do autosaves?
uint8_t missing_strings_threshold
the number of missing strings before showing the warning
bool scale_bevels
bevels are scaled with GUI scale.
void OnResize() override
Called after the window got resized.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
DropDownList BuildDropDownList(WidgetID widget, int *selected_index) const
Build the dropdown list for a specific widget.
Window to edit settings of the game.
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
void OnEditboxChanged(WidgetID wid) override
The text in an editbox has been edited.
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button).
void OnTimeout() override
Called when this window's timeout has been reached.
QueryString filter_editbox
Filter editbox;.
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
bool closing_dropdown
True, if the dropdown list is currently closing.
void OnInit() override
Notification that the nested widget tree gets initialized.
SettingFilter filter
Filter for the list.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void SetDisplayedHelpText(SettingEntry *pe)
Set the entry that should have its help text displayed, and mark the window dirty so it gets repainte...
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnResize() override
Called after the window got resized.
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
void OnDropdownSelect(WidgetID widget, int index) override
A dropdown option associated to this window has been selected.
void OnPaint() override
The window must be repainted.
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
int warn_lines
Number of lines used for warning about missing search results.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
All settings together for the game.
LocaleSettings locale
settings related to used currency/unit system in the current game
Base integer type, including boolean, settings.
uint8_t currency
currency we currently use
uint8_t effect_vol
The requested effects volume.
uint8_t music_vol
The requested music volume.
ParticipateSurvey participate_survey
Participate in the automated survey.
Coordinates of a point in 2D.
Data stored about a string that can be modified in the GUI.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
static const int ACTION_CLEAR
Clear editbox.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Specification of a rectangle with absolute coordinates of all edges.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
void SetButtons(SettingEntryFlags new_val)
Set the button-depressed flags (#SettingsEntryFlag::LeftDepressed and #SettingsEntryFlag::RightDepres...
const IntSettingDesc * setting
Setting description of the setting.
Filter for settings list.
SettingType type
Filter based on type.
bool type_hides
Whether the type hides filtered strings.
RestrictionMode mode
Filter based on category.
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL).
StringFilter string
Filter string.
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
void ResetAll()
Resets all settings to their default values.
void FoldAll()
Recursively close all folds of sub-pages.
void UnFoldAll()
Recursively open all folds of sub-pages.
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row=0, uint parent_last=0) const
Draw a row in the settings panel.
Data structure describing one page of settings in the settings window.
bool folded
Sub-page is folded (not visible except for its title)
bool IsEmpty() const
Check whether any filter words were entered.
void SetFilterTerm(std::string_view str)
Set the term to filter on.
Templated helper to make a type-safe 'typedef' representing a single POD value.
const char * GetText() const
Get the current text.
Window for displaying a textfile.
TextfileType file_type
Type of textfile to view.
virtual void LoadTextfile(const std::string &textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
High level window description.
Data structure for an opened window.
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
void DrawWidgets() const
Paint all widgets of a window.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
WidgetID mouse_capture_widget
ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
ResizeInfo resize
Resize information.
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
virtual void OnDropdownClose(Point pt, WidgetID widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
void EnableWidget(WidgetID widget_index)
Sets a widget to Enabled.
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
WindowFlags flags
Window flags.
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
int height
Height of the window (number of pixels down in y direction)
int width
width of the window (number of pixels to the right in x direction)
@ CONTENT_TYPE_BASE_SOUNDS
The content consists of base sounds.
@ CONTENT_TYPE_BASE_GRAPHICS
The content consists of base graphics.
@ CONTENT_TYPE_BASE_MUSIC
The content consists of base music.
Stuff related to the text buffer GUI.
@ EnableDefault
enable the 'Default' button ("\0" is returned)
std::optional< std::string > GetTextfile(TextfileType type, Subdirectory dir, const std::string &filename)
Search a textfile file next to the given content.
GUI functions related to textfiles.
TextfileType
Additional text files accompanying Tar archives.
@ TFT_LICENSE
Content license.
@ TFT_README
Content readme.
@ TFT_CHANGELOG
Content changelog.
bool _video_vsync
Whether we should use vsync (only if active video driver supports HW acceleration).
bool _video_hw_accel
Whether to consider hardware accelerated video drivers on startup.
Base of all video drivers.
Functions related to (drawing on) viewports.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Window functions not directly related to making/drawing windows.
@ Lowered
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
@ Centred
Window is centered and shall stay centered after ReInit.
@ Timeout
Window timeout counter.
@ WDP_CENTER
Center the window.
@ WN_GAME_OPTIONS_GAME_OPTIONS
Game options.
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
@ WC_MUSIC_WINDOW
Music window; Window numbers:
@ WC_CUSTOM_CURRENCY
Custom currency; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_TEXTFILE
textfile; Window numbers:
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
@ WC_QUERY_STRING
Query string window; Window numbers:
@ WC_GRF_PARAMETERS
NewGRF parameters; Window numbers:
Functions related to zooming.