OpenTTD Source 20251005-master-ga617d009cc
settings_gui.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#include "stdafx.h"
11#include "currency.h"
12#include "error.h"
13#include "settings_gui.h"
14#include "textbuf_gui.h"
15#include "command_func.h"
16#include "network/network.h"
18#include "town.h"
19#include "settings_internal.h"
20#include "strings_func.h"
21#include "window_func.h"
22#include "string_func.h"
23#include "dropdown_type.h"
24#include "dropdown_func.h"
25#include "slider_func.h"
26#include "highscore.h"
27#include "base_media_base.h"
28#include "base_media_graphics.h"
29#include "base_media_music.h"
30#include "base_media_sounds.h"
31#include "company_base.h"
32#include "company_func.h"
33#include "viewport_func.h"
35#include "ai/ai.hpp"
36#include "blitter/factory.hpp"
37#include "language.h"
38#include "textfile_gui.h"
39#include "stringfilter_type.h"
40#include "querystring_gui.h"
41#include "fontcache.h"
42#include "zoom_func.h"
43#include "rev.h"
46#include "gui.h"
47#include "mixer.h"
48#include "newgrf_config.h"
49#include "network/core/config.h"
50#include "network/network_gui.h"
53#include "social_integration.h"
54#include "sound_func.h"
55#include "settingentry_gui.h"
57
58#include "table/strings.h"
59
61
62#include "safeguards.h"
63
64
65#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
66# define HAS_TRUETYPE_FONT
67#endif
68
69static const StringID _autosave_dropdown[] = {
70 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
71 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_10_MINUTES,
72 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_30_MINUTES,
73 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_60_MINUTES,
74 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_120_MINUTES,
76};
77
79static const uint32_t _autosave_dropdown_to_minutes[] = {
80 0,
81 10,
82 30,
83 60,
84 120,
85};
86
92{
93 auto it = std::ranges::find(_resolutions, Dimension(_screen.width, _screen.height));
94 return std::distance(_resolutions.begin(), it);
95}
96
97static void ShowCustCurrency();
98
101 const std::string name;
103
105 {
106 this->ConstructWindow();
107 this->LoadTextfile(textfile, BASESET_DIR);
108 }
109
110 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
111 {
112 if (widget == WID_TF_CAPTION) {
113 return GetString(stringid, this->content_type, this->name);
114 }
115
116 return this->Window::GetWidgetString(widget, stringid);
117 }
118};
119
126template <class TBaseSet>
127void ShowBaseSetTextfileWindow(Window *parent, TextfileType file_type, const TBaseSet *baseset, StringID content_type)
128{
129 parent->CloseChildWindowById(WC_TEXTFILE, file_type);
130 new BaseSetTextfileWindow(parent, file_type, baseset->name, *baseset->GetTextfile(file_type), content_type);
131}
132
139template <typename TBaseSet>
140static std::string GetListLabel(const TBaseSet *baseset)
141{
142 if (baseset->GetNumInvalid() == 0) return GetString(STR_JUST_RAW_STRING, baseset->name);
143 return GetString(STR_BASESET_STATUS, baseset->name, baseset->GetNumInvalid());
144}
145
146template <class T>
147DropDownList BuildSetDropDownList(int *selected_index)
148{
149 int n = T::GetNumSets();
150 *selected_index = T::GetIndexOfUsedSet();
151 DropDownList list;
152 for (int i = 0; i < n; i++) {
153 list.push_back(MakeDropDownListStringItem(GetListLabel(T::GetSet(i)), i));
154 }
155 return list;
156}
157
158std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 };
159
165{
166 /* Add the refresh rate as selected in the config. */
167 _refresh_rates.insert(_settings_client.gui.refresh_rate);
168
169 /* Add all the refresh rates of all monitors connected to the machine. */
170 std::vector<int> monitor_rates = VideoDriver::GetInstance()->GetListOfMonitorRefreshRates();
171 std::copy(monitor_rates.begin(), monitor_rates.end(), std::inserter(_refresh_rates, _refresh_rates.end()));
172}
173
174static const int SCALE_NMARKS = (MAX_INTERFACE_SCALE - MIN_INTERFACE_SCALE) / 25 + 1; // Show marks at 25% increments
175static const int VOLUME_NMARKS = 9; // Show 5 values and 4 empty marks.
176
177static std::optional<std::string> ScaleMarkFunc(int, int, int value)
178{
179 /* Label only every 100% mark. */
180 if (value % 100 != 0) return std::string{};
181
182 return GetString(STR_GAME_OPTIONS_GUI_SCALE_MARK, value / 100, 0);
183}
184
185static std::optional<std::string> VolumeMarkFunc(int, int mark, int value)
186{
187 /* Label only every other mark. */
188 if (mark % 2 != 0) return std::string{};
189
190 /* 0-127 does not map nicely to 0-100. Dividing first gives us nice round numbers. */
191 return GetString(STR_GAME_OPTIONS_VOLUME_MARK, value / 31 * 25);
192}
193
195static constexpr Colours GAME_OPTIONS_BACKGROUND = COLOUR_MAUVE;
197static constexpr Colours GAME_OPTIONS_BUTTON = COLOUR_YELLOW;
199static constexpr TextColour GAME_OPTIONS_FRAME = TC_ORANGE;
201static constexpr TextColour GAME_OPTIONS_LABEL = TC_LIGHT_BLUE;
203static constexpr TextColour GAME_OPTIONS_SELECTED = TC_WHITE;
204
205static constexpr NWidgetPart _nested_social_plugins_widgets[] = {
209 NWidget(WWT_TEXT, INVALID_COLOUR), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_PLATFORM), SetTextStyle(GAME_OPTIONS_LABEL),
211 EndContainer(),
213 NWidget(WWT_TEXT, INVALID_COLOUR), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE), SetTextStyle(GAME_OPTIONS_LABEL),
215 EndContainer(),
216 EndContainer(),
217 EndContainer(),
218};
219
220static constexpr NWidgetPart _nested_social_plugins_none_widgets[] = {
222 NWidget(WWT_TEXT, INVALID_COLOUR), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGINS_NONE), SetTextStyle(GAME_OPTIONS_LABEL),
223 EndContainer(),
224};
225
227public:
229 {
230 this->plugins = SocialIntegration::GetPlugins();
231
232 if (this->plugins.empty()) {
233 auto widget = MakeNWidgets(_nested_social_plugins_none_widgets, nullptr);
234 this->Add(std::move(widget));
235 } else {
236 for (size_t i = 0; i < this->plugins.size(); i++) {
237 auto widget = MakeNWidgets(_nested_social_plugins_widgets, nullptr);
238 this->Add(std::move(widget));
239 }
240 }
241
242 this->SetPIP(0, WidgetDimensions::unscaled.vsep_wide, 0);
243 }
244
245 void SetupSmallestSize(Window *w) override
246 {
247 this->current_index = -1;
249 }
250
257 template <typename T>
258 std::string &GetWidestPlugin(T SocialIntegrationPlugin::*member) const
259 {
260 std::string *longest = &(this->plugins[0]->*member);
261 int longest_length = 0;
262
263 for (auto *plugin : this->plugins) {
264 int length = GetStringBoundingBox(plugin->*member).width;
265 if (length > longest_length) {
266 longest_length = length;
267 longest = &(plugin->*member);
268 }
269 }
270
271 return *longest;
272 }
273
274 std::string GetWidgetString(WidgetID widget, StringID) const
275 {
276 switch (widget) {
278 /* For SetupSmallestSize, use the longest string we have. */
279 if (this->current_index < 0) {
281 }
282
283 if (this->plugins[this->current_index]->name.empty()) {
284 return this->plugins[this->current_index]->basepath;
285 }
286
287 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_TITLE, this->plugins[this->current_index]->name, this->plugins[this->current_index]->version);
288
290 /* For SetupSmallestSize, use the longest string we have. */
291 if (this->current_index < 0) {
293 }
294
295 return this->plugins[this->current_index]->social_platform;
296
298 static const std::pair<SocialIntegrationPlugin::State, StringID> state_to_string[] = {
299 { SocialIntegrationPlugin::RUNNING, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_RUNNING },
300 { SocialIntegrationPlugin::FAILED, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_FAILED },
301 { SocialIntegrationPlugin::PLATFORM_NOT_RUNNING, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_PLATFORM_NOT_RUNNING },
302 { SocialIntegrationPlugin::UNLOADED, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_UNLOADED },
303 { SocialIntegrationPlugin::DUPLICATE, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_DUPLICATE },
304 { SocialIntegrationPlugin::UNSUPPORTED_API, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_UNSUPPORTED_API },
305 { SocialIntegrationPlugin::INVALID_SIGNATURE, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_INVALID_SIGNATURE },
306 };
307
308 /* For SetupSmallestSize, use the longest string we have. */
309 if (this->current_index < 0) {
311
312 /* Set the longest plugin when looking for the longest status. */
313 StringID longest = STR_NULL;
314 int longest_length = 0;
315 for (const auto &[state, string] : state_to_string) {
316 int length = GetStringBoundingBox(GetString(string, longest_plugin)).width;
317 if (length > longest_length) {
318 longest_length = length;
319 longest = string;
320 }
321 }
322
323 return GetString(longest, longest_plugin);
324 }
325
326 const auto plugin = this->plugins[this->current_index];
327
328 /* Find the string for the state. */
329 for (const auto &[state, string] : state_to_string) {
330 if (plugin->state == state) {
331 return GetString(string, plugin->social_platform);
332 }
333 }
334
335 /* Default string, in case no state matches. */
336 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_FAILED, plugin->social_platform);
337 }
338
339 default: NOT_REACHED();
340 }
341 }
342
343 void Draw(const Window *w) override
344 {
345 this->current_index = 0;
346
347 for (auto &wid : this->children) {
348 wid->Draw(w);
349 this->current_index++;
350 }
351 }
352
353private:
354 int current_index = -1;
355 std::vector<SocialIntegrationPlugin *> plugins{};
356};
357
359std::unique_ptr<NWidgetBase> MakeNWidgetSocialPlugins()
360{
361 return std::make_unique<NWidgetSocialPlugins>();
362}
363
364static const StringID _game_settings_restrict_dropdown[] = {
365 STR_CONFIG_SETTING_RESTRICT_BASIC, // RM_BASIC
366 STR_CONFIG_SETTING_RESTRICT_ADVANCED, // RM_ADVANCED
367 STR_CONFIG_SETTING_RESTRICT_ALL, // RM_ALL
368 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT, // RM_CHANGED_AGAINST_DEFAULT
369 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW, // RM_CHANGED_AGAINST_NEW
370};
371static_assert(lengthof(_game_settings_restrict_dropdown) == RM_END);
372
380
386static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
387{
388 if (confirmed) {
391 w->InvalidateData();
392 }
393}
394
396 static inline GameSettings *settings_ptr;
397
402 bool closing_dropdown = false;
403
408 int warn_lines = 0;
409
410 Scrollbar *vscroll;
411 Scrollbar *vscroll_description;
412 static constexpr uint NUM_DESCRIPTION_LINES = 5;
413
414 GameSettings *opt = nullptr;
415 bool reload = false;
416 bool gui_scale_changed = false;
417 int gui_scale = 0;
418 static inline WidgetID active_tab = WID_GO_TAB_GENERAL;
419
421 {
422 this->opt = &GetGameSettings();
423
425
427 this->filter.min_cat = RM_ALL;
428 this->filter.type = ST_ALL;
429 this->filter.type_hides = false;
430 this->settings_ptr = &GetGameSettings();
431
432 GetSettingsTree().FoldAll(); // Close all sub-pages
433
434 this->CreateNestedTree();
435 this->vscroll = this->GetScrollbar(WID_GO_SCROLLBAR);
436 this->vscroll_description = this->GetScrollbar(WID_GO_HELP_TEXT_SCROLL);
437 this->vscroll_description->SetCapacity(NUM_DESCRIPTION_LINES);
439
441 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
442
443 this->OnInvalidateData(0);
444
445 this->SetTab(GameOptionsWindow::active_tab);
446
447 if constexpr (!NetworkSurveyHandler::IsSurveyPossible()) this->GetWidget<NWidgetStacked>(WID_GO_SURVEY_SEL)->SetDisplayedPlane(SZSP_NONE);
448 }
449
450 void OnInit() override
451 {
452 BaseSettingEntry::circle_size = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
454
455 this->gui_scale = _gui_scale;
456 }
457
458 void Close([[maybe_unused]] int data = 0) override
459 {
461 if (this->reload) _switch_mode = SM_MENU;
462 this->Window::Close();
463 }
464
471 DropDownList BuildDropDownList(WidgetID widget, int *selected_index) const
472 {
473 DropDownList list;
474 switch (widget) {
475 case WID_GO_CURRENCY_DROPDOWN: { // Setup currencies dropdown
476 *selected_index = this->opt->locale.currency;
477 uint64_t disabled = _game_mode == GM_MENU ? 0LL : ~GetMaskOfAllowedCurrencies();
478
479 /* Add non-custom currencies; sorted naturally */
480 for (const CurrencySpec &currency : _currency_specs) {
481 int i = &currency - _currency_specs.data();
482 if (i == CURRENCY_CUSTOM) continue;
483 if (currency.code.empty()) {
484 list.push_back(MakeDropDownListStringItem(currency.name, i, HasBit(disabled, i)));
485 } else {
486 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_CURRENCY_CODE, currency.name, currency.code), i, HasBit(disabled, i)));
487 }
488 }
489 std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
490
491 /* Append custom currency at the end */
492 list.push_back(MakeDropDownListDividerItem()); // separator line
493 list.push_back(MakeDropDownListStringItem(STR_GAME_OPTIONS_CURRENCY_CUSTOM, CURRENCY_CUSTOM, HasBit(disabled, CURRENCY_CUSTOM)));
494 break;
495 }
496
497 case WID_GO_AUTOSAVE_DROPDOWN: { // Setup autosave dropdown
498 int index = 0;
499 for (auto &minutes : _autosave_dropdown_to_minutes) {
500 index++;
501 if (_settings_client.gui.autosave_interval <= minutes) break;
502 }
503 *selected_index = index - 1;
504
505 const StringID *items = _autosave_dropdown;
506 for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
507 list.push_back(MakeDropDownListStringItem(*items, i));
508 }
509 break;
510 }
511
512 case WID_GO_LANG_DROPDOWN: { // Setup interface language dropdown
513 for (uint i = 0; i < _languages.size(); i++) {
514 bool hide_language = IsReleasedVersion() && !_languages[i].IsReasonablyFinished();
515 if (hide_language) continue;
516 bool hide_percentage = IsReleasedVersion() || _languages[i].missing < _settings_client.gui.missing_strings_threshold;
517 std::string name;
518 if (&_languages[i] == _current_language) {
519 *selected_index = i;
520 name = _languages[i].own_name;
521 } else {
522 /* Especially with sprite-fonts, not all localized
523 * names can be rendered. So instead, we use the
524 * international names for anything but the current
525 * selected language. This avoids showing a few ????
526 * entries in the dropdown list. */
527 name = _languages[i].name;
528 }
529 if (hide_percentage) {
530 list.push_back(MakeDropDownListStringItem(std::move(name), i));
531 } else {
532 int percentage = (LANGUAGE_TOTAL_STRINGS - _languages[i].missing) * 100 / LANGUAGE_TOTAL_STRINGS;
533 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_LANGUAGE_PERCENTAGE, std::move(name), percentage), i));
534 }
535 }
536 std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
537 break;
538 }
539
540 case WID_GO_RESOLUTION_DROPDOWN: // Setup resolution dropdown
541 if (_resolutions.empty()) break;
542
543 *selected_index = GetCurrentResolutionIndex();
544 for (uint i = 0; i < _resolutions.size(); i++) {
545 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_RESOLUTION_ITEM, _resolutions[i].width, _resolutions[i].height), i));
546 }
547 break;
548
549 case WID_GO_REFRESH_RATE_DROPDOWN: // Setup refresh rate dropdown
550 for (auto it = _refresh_rates.begin(); it != _refresh_rates.end(); it++) {
551 auto i = std::distance(_refresh_rates.begin(), it);
552 if (*it == _settings_client.gui.refresh_rate) *selected_index = i;
553 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, *it), i));
554 }
555 break;
556
558 list = BuildSetDropDownList<BaseGraphics>(selected_index);
559 break;
560
562 list = BuildSetDropDownList<BaseSounds>(selected_index);
563 break;
564
566 list = BuildSetDropDownList<BaseMusic>(selected_index);
567 break;
568
570 for (int mode = 0; mode != RM_END; mode++) {
571 /* If we are in adv. settings screen for the new game's settings,
572 * we don't want to allow comparing with new game's settings. */
573 bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
574
575 list.push_back(MakeDropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
576 }
577 break;
578
580 list.push_back(MakeDropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL, ST_ALL));
581 list.push_back(MakeDropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME, ST_GAME));
582 list.push_back(MakeDropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME, ST_COMPANY));
583 list.push_back(MakeDropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT, ST_CLIENT));
584 break;
585 }
586
587 return list;
588 }
589
590 std::string GetToggleString(StringID stringid, WidgetID state_widget) const
591 {
592 return GetString(STR_GAME_OPTIONS_SETTING, stringid, this->IsWidgetLowered(state_widget) ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
593 }
594
595 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
596 {
597 switch (widget) {
599 const CurrencySpec &currency = _currency_specs[this->opt->locale.currency];
600 if (currency.code.empty()) return GetString(currency.name);
601 return GetString(STR_GAME_OPTIONS_CURRENCY_CODE, currency.name, currency.code);
602 }
603
605 int index = 0;
606 for (auto &minutes : _autosave_dropdown_to_minutes) {
607 index++;
608 if (_settings_client.gui.autosave_interval <= minutes) break;
609 }
610 return GetString(_autosave_dropdown[index - 1]);
611 }
612
617 case WID_GO_REFRESH_RATE_DROPDOWN: return GetString(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, _settings_client.gui.refresh_rate);
619 auto current_resolution = GetCurrentResolutionIndex();
620
621 if (current_resolution == _resolutions.size()) {
622 return GetString(STR_GAME_OPTIONS_RESOLUTION_OTHER);
623 }
624 return GetString(STR_GAME_OPTIONS_RESOLUTION_ITEM, _resolutions[current_resolution].width, _resolutions[current_resolution].height);
625 }
626
630 const NWidgetSocialPlugins *plugin = this->GetWidget<NWidgetSocialPlugins>(WID_GO_SOCIAL_PLUGINS);
631 assert(plugin != nullptr);
632
633 return plugin->GetWidgetString(widget, stringid);
634 }
635
637 return GetString(_game_settings_restrict_dropdown[this->filter.mode]);
638
640 switch (this->filter.type) {
641 case ST_GAME: return GetString(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME);
642 case ST_COMPANY: return GetString(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME);
643 case ST_CLIENT: return GetString(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT);
644 default: return GetString(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL);
645 }
646 break;
647
649 return GetToggleString(STR_GAME_OPTIONS_PARTICIPATE_SURVEY, WID_GO_SURVEY_PARTICIPATE_BUTTON);
650
652 return GetToggleString(STR_GAME_OPTIONS_GUI_SCALE_AUTO, WID_GO_GUI_SCALE_AUTO);
653
655 return GetToggleString(STR_GAME_OPTIONS_GUI_SCALE_BEVELS, WID_GO_GUI_SCALE_BEVEL_BUTTON);
656
658 return GetToggleString(STR_GAME_OPTIONS_GUI_FONT_SPRITE, WID_GO_GUI_FONT_SPRITE);
659
661 return GetToggleString(STR_GAME_OPTIONS_GUI_FONT_AA, WID_GO_GUI_FONT_AA);
662
664 return GetToggleString(STR_GAME_OPTIONS_FULLSCREEN, WID_GO_FULLSCREEN_BUTTON);
665
667 return GetToggleString(STR_GAME_OPTIONS_VIDEO_ACCELERATION, WID_GO_VIDEO_ACCEL_BUTTON);
668
670 return GetToggleString(STR_GAME_OPTIONS_VIDEO_VSYNC, WID_GO_VIDEO_VSYNC_BUTTON);
671
672 default:
673 return this->Window::GetWidgetString(widget, stringid);
674 }
675 }
676
677 void DrawWidget(const Rect &r, WidgetID widget) const override
678 {
679 switch (widget) {
682 break;
683
686 break;
687
690 break;
691
692 case WID_GO_GUI_SCALE:
693 DrawSliderWidget(r, GAME_OPTIONS_BACKGROUND, GAME_OPTIONS_BUTTON, TC_BLACK, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, SCALE_NMARKS, this->gui_scale, ScaleMarkFunc);
694 break;
695
697 DrawStringMultiLine(r, GetString(STR_GAME_OPTIONS_VIDEO_DRIVER_INFO, std::string{VideoDriver::GetInstance()->GetInfoString()}), GAME_OPTIONS_SELECTED);
698 break;
699
701 DrawSliderWidget(r, GAME_OPTIONS_BACKGROUND, GAME_OPTIONS_BUTTON, TC_BLACK, 0, INT8_MAX, VOLUME_NMARKS, _settings_client.music.effect_vol, VolumeMarkFunc);
702 break;
703
705 DrawSliderWidget(r, GAME_OPTIONS_BACKGROUND, GAME_OPTIONS_BUTTON, TC_BLACK, 0, INT8_MAX, VOLUME_NMARKS, _settings_client.music.music_vol, VolumeMarkFunc);
706 break;
707
708 case WID_GO_OPTIONSPANEL: {
710 tr.top += this->warn_lines * BaseSettingEntry::line_height;
711 uint last_row = this->vscroll->GetPosition() + this->vscroll->GetCapacity() - this->warn_lines;
712 int next_row = GetSettingsTree().Draw(settings_ptr, tr.left, tr.right, tr.top,
713 this->vscroll->GetPosition(), last_row, this->last_clicked);
714 if (next_row == 0) DrawString(tr, STR_CONFIG_SETTINGS_NONE);
715 break;
716 }
717
719 if (this->last_clicked != nullptr) {
720 const IntSettingDesc *sd = this->last_clicked->setting;
721
722 Rect tr = r;
723 std::string str;
724 switch (sd->GetType()) {
725 case ST_COMPANY: str = GetString(STR_CONFIG_SETTING_TYPE, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME); break;
726 case ST_CLIENT: str = GetString(STR_CONFIG_SETTING_TYPE, STR_CONFIG_SETTING_TYPE_CLIENT); break;
727 case ST_GAME: str = GetString(STR_CONFIG_SETTING_TYPE, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME); break;
728 default: NOT_REACHED();
729 }
730 DrawString(tr, str);
731 tr.top += GetCharacterHeight(FS_NORMAL);
732
733 auto [param1, param2] = sd->GetValueParams(sd->GetDefaultValue());
734 DrawString(tr, GetString(STR_CONFIG_SETTING_DEFAULT_VALUE, param1, param2));
735 }
736 break;
737
738 case WID_GO_HELP_TEXT:
739 if (this->last_clicked != nullptr) {
740 const IntSettingDesc *sd = this->last_clicked->setting;
741
742 DrawPixelInfo tmp_dpi;
743 if (FillDrawPixelInfo(&tmp_dpi, r)) {
744 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
745 int scrolls_pos = this->vscroll_description->GetPosition() * GetCharacterHeight(FS_NORMAL);
746 DrawStringMultiLine(0, r.Width() - 1, -scrolls_pos, r.Height() - 1, sd->GetHelp(), TC_WHITE);
747 }
748 }
749 break;
750
751 default:
752 break;
753 }
754 }
755
761 {
762 if (this->last_clicked != pe) this->SetDirty();
763 this->last_clicked = pe;
764 UpdateHelpTextSize();
765 }
766
767 void UpdateHelpTextSize()
768 {
769 NWidgetResizeBase *wid = this->GetWidget<NWidgetResizeBase>(WID_GO_HELP_TEXT);
770 this->vscroll_description->SetCount(this->last_clicked ? CeilDiv(this->last_clicked->GetMaxHelpHeight(wid->current_x), GetCharacterHeight(FS_NORMAL)) : 0);
771 }
772
773 void SetTab(WidgetID widget)
774 {
776 this->LowerWidget(widget);
777 GameOptionsWindow::active_tab = widget;
778
779 int plane;
780 switch (widget) {
781 case WID_GO_TAB_GENERAL: plane = 0; break;
782 case WID_GO_TAB_GRAPHICS: plane = 1; break;
783 case WID_GO_TAB_SOUND: plane = 2; break;
784 case WID_GO_TAB_SOCIAL: plane = 3; break;
785 case WID_GO_TAB_ADVANCED: plane = 4; break;
786 default: NOT_REACHED();
787 }
788
789 this->GetWidget<NWidgetStacked>(WID_GO_TAB_SELECTION)->SetDisplayedPlane(plane);
791 this->SetDirty();
792 }
793
794 void OnResize() override
795 {
796 this->vscroll->SetCapacityFromWidget(this, WID_GO_OPTIONSPANEL, WidgetDimensions::scaled.framerect.Vertical());
797 UpdateHelpTextSize();
798
799 bool changed = false;
800
801 NWidgetResizeBase *wid = this->GetWidget<NWidgetResizeBase>(WID_GO_BASE_GRF_DESCRIPTION);
802 int y = 0;
803 for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
804 std::string str = GetString(STR_JUST_RAW_STRING, BaseGraphics::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
805 y = std::max(y, GetStringHeight(str, wid->current_x));
806 }
807 changed |= wid->UpdateVerticalSize(y);
808
809 wid = this->GetWidget<NWidgetResizeBase>(WID_GO_BASE_SFX_DESCRIPTION);
810 y = 0;
811 for (int i = 0; i < BaseSounds::GetNumSets(); i++) {
812 std::string str = GetString(STR_JUST_RAW_STRING, BaseSounds::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
813 y = std::max(y, GetStringHeight(str, wid->current_x));
814 }
815 changed |= wid->UpdateVerticalSize(y);
816
817 wid = this->GetWidget<NWidgetResizeBase>(WID_GO_BASE_MUSIC_DESCRIPTION);
818 y = 0;
819 for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
820 std::string str = GetString(STR_JUST_RAW_STRING, BaseMusic::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
821 y = std::max(y, GetStringHeight(str, wid->current_x));
822 }
823 changed |= wid->UpdateVerticalSize(y);
824
825 wid = this->GetWidget<NWidgetResizeBase>(WID_GO_VIDEO_DRIVER_INFO);
826 std::string str = GetString(STR_GAME_OPTIONS_VIDEO_DRIVER_INFO, std::string{VideoDriver::GetInstance()->GetInfoString()});
827 y = GetStringHeight(str, wid->current_x);
828 changed |= wid->UpdateVerticalSize(y);
829
830 if (changed) this->ReInit(0, 0, this->flags.Test(WindowFlag::Centred));
831 }
832
833 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
834 {
835 switch (widget) {
838 Dimension d = maxdim(GetStringBoundingBox(STR_GAME_OPTIONS_SFX_VOLUME), GetStringBoundingBox(STR_GAME_OPTIONS_MUSIC_VOLUME));
839 d.width += padding.width;
840 d.height += padding.height;
841 size = maxdim(size, d);
842 break;
843 }
844
853 int selected;
854 size.width = std::max(size.width, GetDropDownListDimension(this->BuildDropDownList(widget, &selected)).width + padding.width);
855 break;
856 }
857
859 fill.height = resize.height = BaseSettingEntry::line_height;
860 resize.width = 1;
861
862 size.height = 8 * resize.height + WidgetDimensions::scaled.framerect.Vertical();
863 break;
864
866 static const StringID setting_types[] = {
867 STR_CONFIG_SETTING_TYPE_CLIENT,
868 STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
869 STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
870 };
871 for (const auto &setting_type : setting_types) {
872 size.width = std::max(size.width, GetStringBoundingBox(GetString(STR_CONFIG_SETTING_TYPE, setting_type)).width + padding.width);
873 }
874 size.height = 2 * GetCharacterHeight(FS_NORMAL);
875 break;
876 }
877
878 case WID_GO_HELP_TEXT:
879 size.height = NUM_DESCRIPTION_LINES * GetCharacterHeight(FS_NORMAL);
880 break;
881
884 size.width = std::max(GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_CATEGORY).width, GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_TYPE).width);
885 break;
886
887 default:
888 break;
889 }
890 }
891
892 void OnPaint() override
893 {
894 if (this->GetWidget<NWidgetStacked>(WID_GO_TAB_SELECTION)->shown_plane != 4) {
895 this->DrawWidgets();
896 return;
897 }
898
899 if (this->closing_dropdown) {
900 this->closing_dropdown = false;
901 assert(this->valuedropdown_entry != nullptr);
902 this->valuedropdown_entry->SetButtons({});
903 this->valuedropdown_entry = nullptr;
904 }
905
906 /* Reserve the correct number of lines for the 'some search results are hidden' notice in the central settings display panel. */
907 const Rect panel = this->GetWidget<NWidgetBase>(WID_GO_OPTIONSPANEL)->GetCurrentRect().Shrink(WidgetDimensions::scaled.frametext);
908 StringID warn_str = STR_CONFIG_SETTING_CATEGORY_HIDES - 1 + this->warn_missing;
909 int new_warn_lines;
910 if (this->warn_missing == WHR_NONE) {
911 new_warn_lines = 0;
912 } else {
913 new_warn_lines = GetStringLineCount(GetString(warn_str, _game_settings_restrict_dropdown[this->filter.min_cat]), panel.Width());
914 }
915 if (this->warn_lines != new_warn_lines) {
916 this->vscroll->SetCount(this->vscroll->GetCount() - this->warn_lines + new_warn_lines);
917 this->warn_lines = new_warn_lines;
918 }
919
920 this->DrawWidgets();
921
922 /* Draw the 'some search results are hidden' notice. */
923 if (this->warn_missing != WHR_NONE) {
925 GetString(warn_str, _game_settings_restrict_dropdown[this->filter.min_cat]),
926 TC_BLACK, SA_CENTER);
927 }
928 }
929
930 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
931 {
932 if (widget >= WID_GO_BASE_GRF_TEXTFILE && widget < WID_GO_BASE_GRF_TEXTFILE + TFT_CONTENT_END) {
933 if (BaseGraphics::GetUsedSet() == nullptr) return;
934
935 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_GRF_TEXTFILE), BaseGraphics::GetUsedSet(), STR_CONTENT_TYPE_BASE_GRAPHICS);
936 return;
937 }
938 if (widget >= WID_GO_BASE_SFX_TEXTFILE && widget < WID_GO_BASE_SFX_TEXTFILE + TFT_CONTENT_END) {
939 if (BaseSounds::GetUsedSet() == nullptr) return;
940
941 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_SFX_TEXTFILE), BaseSounds::GetUsedSet(), STR_CONTENT_TYPE_BASE_SOUNDS);
942 return;
943 }
944 if (widget >= WID_GO_BASE_MUSIC_TEXTFILE && widget < WID_GO_BASE_MUSIC_TEXTFILE + TFT_CONTENT_END) {
945 if (BaseMusic::GetUsedSet() == nullptr) return;
946
947 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_MUSIC_TEXTFILE), BaseMusic::GetUsedSet(), STR_CONTENT_TYPE_BASE_MUSIC);
948 return;
949 }
950 switch (widget) {
953 case WID_GO_TAB_SOUND:
956 SndClickBeep();
957 this->SetTab(widget);
958 break;
959
962 case PS_ASK:
963 case PS_NO:
965 break;
966
967 case PS_YES:
969 break;
970 }
971
975 break;
976
978 OpenBrowser(NETWORK_SURVEY_DETAILS_LINK);
979 break;
980
982 ShowSurveyResultTextfileWindow(this);
983 break;
984
985 case WID_GO_FULLSCREEN_BUTTON: // Click fullscreen on/off
986 /* try to toggle full-screen on/off */
987 if (!ToggleFullScreen(!_fullscreen)) {
988 ShowErrorMessage(GetEncodedString(STR_ERROR_FULLSCREEN_FAILED), {}, WL_ERROR);
989 }
993 break;
994
997 ShowErrorMessage(GetEncodedString(STR_GAME_OPTIONS_VIDEO_ACCELERATION_RESTART), {}, WL_INFO);
1001#ifndef __APPLE__
1006#endif
1007 break;
1008
1010 if (!_video_hw_accel) break;
1011
1014
1020 break;
1021
1024
1026 this->SetDirty();
1027
1029 ReInitAllWindows(true);
1030 break;
1031 }
1032
1033#ifdef HAS_TRUETYPE_FONT
1035 _fcsettings.prefer_sprite = !_fcsettings.prefer_sprite;
1036
1039 this->SetDirty();
1040
1046 ReInitAllWindows(true);
1047 break;
1048
1049 case WID_GO_GUI_FONT_AA:
1050 _fcsettings.global_aa = !_fcsettings.global_aa;
1051
1054
1056 break;
1057#endif /* HAS_TRUETYPE_FONT */
1058
1059 case WID_GO_GUI_SCALE:
1060 /* Any click on the slider deactivates automatic interface scaling, setting it to the current value before being adjusted. */
1061 if (_gui_scale_cfg == -1) {
1062 _gui_scale_cfg = this->gui_scale;
1066 }
1067
1068 if (ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, _ctrl_pressed ? 0 : SCALE_NMARKS, this->gui_scale)) {
1069 this->gui_scale_changed = true;
1070 this->SetWidgetDirty(widget);
1071 }
1072
1073 if (click_count > 0) this->mouse_capture_widget = widget;
1074 break;
1075
1077 {
1078 if (_gui_scale_cfg == -1) {
1081 } else {
1082 _gui_scale_cfg = -1;
1084 if (AdjustGUIZoom(false)) ReInitAllWindows(true);
1085 this->gui_scale = _gui_scale;
1086 }
1087 this->SetWidgetDirty(widget);
1089 break;
1090 }
1091
1093 auto *used_set = BaseGraphics::GetUsedSet();
1094 if (used_set == nullptr || !used_set->IsConfigurable()) break;
1095 GRFConfig &extra_cfg = used_set->GetOrCreateExtraConfig();
1096 if (extra_cfg.param.empty()) extra_cfg.SetParameterDefaults();
1097 OpenGRFParameterWindow(true, extra_cfg, _game_mode == GM_MENU);
1098 if (_game_mode == GM_MENU) this->reload = true;
1099 break;
1100 }
1101
1105 if (ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, 0, INT8_MAX, 0, vol)) {
1106 if (widget == WID_GO_BASE_MUSIC_VOLUME) {
1108 } else {
1109 SetEffectVolume(vol);
1110 }
1111 this->SetWidgetDirty(widget);
1113 }
1114
1115 if (click_count > 0) this->mouse_capture_widget = widget;
1116 break;
1117 }
1118
1120 ShowMusicWindow();
1121 break;
1122 }
1123
1125 if (BaseGraphics::GetUsedSet() == nullptr || BaseGraphics::GetUsedSet()->url.empty()) return;
1126 OpenBrowser(BaseGraphics::GetUsedSet()->url);
1127 break;
1128
1130 if (BaseSounds::GetUsedSet() == nullptr || BaseSounds::GetUsedSet()->url.empty()) return;
1131 OpenBrowser(BaseSounds::GetUsedSet()->url);
1132 break;
1133
1135 if (BaseMusic::GetUsedSet() == nullptr || BaseMusic::GetUsedSet()->url.empty()) return;
1136 OpenBrowser(BaseMusic::GetUsedSet()->url);
1137 break;
1138
1141 break;
1142
1145 break;
1146
1149 break;
1150
1159 int selected;
1160 DropDownList list = this->BuildDropDownList(widget, &selected);
1161 if (!list.empty()) {
1162 ShowDropDownList(this, std::move(list), selected, widget);
1163 } else {
1164 if (widget == WID_GO_RESOLUTION_DROPDOWN) ShowErrorMessage(GetEncodedString(STR_ERROR_RESOLUTION_LIST_FAILED), {}, WL_ERROR);
1165 }
1166 break;
1167 }
1168
1169 case WID_GO_EXPAND_ALL:
1170 this->manually_changed_folding = true;
1172 this->InvalidateData();
1173 break;
1174
1176 this->manually_changed_folding = true;
1178 this->InvalidateData();
1179 break;
1180
1181 case WID_GO_RESET_ALL:
1182 ShowQuery(
1183 GetEncodedString(STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_CAPTION),
1184 GetEncodedString(STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_TEXT),
1185 this,
1187 );
1188 break;
1189
1191 int selected;
1192 DropDownList list = this->BuildDropDownList(widget, &selected);
1193 if (!list.empty()) {
1194 ShowDropDownList(this, std::move(list), this->filter.mode, widget);
1195 }
1196 break;
1197 }
1198
1199 case WID_GO_TYPE_DROPDOWN: {
1200 int selected;
1201 DropDownList list = this->BuildDropDownList(widget, &selected);
1202 if (!list.empty()) {
1203 ShowDropDownList(this, std::move(list), this->filter.type, widget);
1204 }
1205 break;
1206 }
1207
1209 OptionsPanelClick(pt);
1210 break;
1211 }
1212 }
1213
1214 void OptionsPanelClick(Point pt)
1215 {
1216 int32_t btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GO_OPTIONSPANEL, WidgetDimensions::scaled.framerect.top);
1217 if (btn == INT32_MAX || btn < this->warn_lines) return;
1218 btn -= this->warn_lines;
1219
1220 uint cur_row = 0;
1222
1223 if (clicked_entry == nullptr) return; // Clicked below the last setting of the page
1224
1225 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GO_OPTIONSPANEL);
1226 int x = (_current_text_dir == TD_RTL ? this->width - 1 - pt.x : pt.x) - WidgetDimensions::scaled.frametext.left - (clicked_entry->level + 1) * WidgetDimensions::scaled.hsep_indent - wid->pos_x; // Shift x coordinate
1227 if (x < 0) return; // Clicked left of the entry
1228
1229 SettingsPage *clicked_page = dynamic_cast<SettingsPage*>(clicked_entry);
1230 if (clicked_page != nullptr) {
1231 this->SetDisplayedHelpText(nullptr);
1232 clicked_page->folded = !clicked_page->folded; // Flip 'folded'-ness of the sub-page
1233
1234 this->manually_changed_folding = true;
1235
1236 this->InvalidateData();
1237 return;
1238 }
1239
1240 SettingEntry *pe = dynamic_cast<SettingEntry*>(clicked_entry);
1241 assert(pe != nullptr);
1242 const IntSettingDesc *sd = pe->setting;
1243
1244 /* return if action is only active in network, or only settable by server */
1245 if (!sd->IsEditable()) {
1246 this->SetDisplayedHelpText(pe);
1247 return;
1248 }
1249
1250 auto [min_val, max_val] = sd->GetRange();
1251 int32_t value = sd->Read(ResolveObject(settings_ptr, sd));
1252
1253 /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
1254 if (x < SETTING_BUTTON_WIDTH && sd->flags.Test(SettingFlag::GuiDropdown)) {
1255 this->SetDisplayedHelpText(pe);
1256
1257 if (this->valuedropdown_entry == pe) {
1258 /* unclick the dropdown */
1260 this->closing_dropdown = false;
1261 this->valuedropdown_entry->SetButtons({});
1262 this->valuedropdown_entry = nullptr;
1263 } else {
1264 if (this->valuedropdown_entry != nullptr) this->valuedropdown_entry->SetButtons({});
1265 this->closing_dropdown = false;
1266
1267 int rel_y = (pt.y - wid->pos_y - WidgetDimensions::scaled.framerect.top) % wid->resize_y;
1268
1269 Rect wi_rect;
1270 wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
1271 wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
1272 wi_rect.top = pt.y - rel_y + (BaseSettingEntry::line_height - SETTING_BUTTON_HEIGHT) / 2;
1273 wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
1274
1275 /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
1276 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
1277 this->valuedropdown_entry = pe;
1278 this->valuedropdown_entry->SetButtons(SettingEntryFlag::LeftDepressed);
1279
1280 DropDownList list;
1281 for (int32_t i = min_val; i <= static_cast<int32_t>(max_val); i++) {
1282 auto [param1, param2] = sd->GetValueParams(i);
1283 list.push_back(MakeDropDownListStringItem(GetString(STR_JUST_STRING1, param1, param2), i));
1284 }
1285
1286 ShowDropDownListAt(this, std::move(list), value, WID_GO_SETTING_DROPDOWN, wi_rect, COLOUR_ORANGE);
1287 }
1288 }
1289 this->SetDirty();
1290 } else if (x < SETTING_BUTTON_WIDTH) {
1291 this->SetDisplayedHelpText(pe);
1292 int32_t oldvalue = value;
1293
1294 if (sd->IsBoolSetting()) {
1295 value ^= 1;
1296 } else {
1297 /* Add a dynamic step-size to the scroller. In a maximum of
1298 * 50-steps you should be able to get from min to max,
1299 * unless specified otherwise in the 'interval' variable
1300 * of the current setting. */
1301 uint32_t step = (sd->interval == 0) ? ((max_val - min_val) / 50) : sd->interval;
1302 if (step == 0) step = 1;
1303
1304 /* don't allow too fast scrolling */
1305 if (this->flags.Test(WindowFlag::Timeout) && this->timeout_timer > 1) {
1306 _left_button_clicked = false;
1307 return;
1308 }
1309
1310 /* Increase or decrease the value and clamp it to extremes */
1311 if (x >= SETTING_BUTTON_WIDTH / 2) {
1312 value += step;
1313 if (min_val < 0) {
1314 assert(static_cast<int32_t>(max_val) >= 0);
1315 if (value > static_cast<int32_t>(max_val)) value = static_cast<int32_t>(max_val);
1316 } else {
1317 if (static_cast<uint32_t>(value) > max_val) value = static_cast<int32_t>(max_val);
1318 }
1319 if (value < min_val) value = min_val; // skip between "disabled" and minimum
1320 } else {
1321 value -= step;
1322 if (value < min_val) value = sd->flags.Test(SettingFlag::GuiZeroIsSpecial) ? 0 : min_val;
1323 }
1324
1325 /* Set up scroller timeout for numeric values */
1326 if (value != oldvalue) {
1327 if (this->clicked_entry != nullptr) { // Release previous buttons if any
1328 this->clicked_entry->SetButtons({});
1329 }
1330 this->clicked_entry = pe;
1332 this->SetTimeout();
1333 _left_button_clicked = false;
1334 }
1335 }
1336
1337 if (value != oldvalue) {
1338 SetSettingValue(sd, value);
1339 this->SetDirty();
1340 }
1341 } else {
1342 /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
1343 if (this->last_clicked == pe && !sd->IsBoolSetting() && !sd->flags.Test(SettingFlag::GuiDropdown)) {
1344 int64_t value64 = value;
1345 /* Show the correct currency-translated value */
1346 if (sd->flags.Test(SettingFlag::GuiCurrency)) value64 *= GetCurrency().rate;
1347
1348 CharSetFilter charset_filter = CS_NUMERAL; //default, only numeric input allowed
1349 if (min_val < 0) charset_filter = CS_NUMERAL_SIGNED; // special case, also allow '-' sign for negative input
1350
1351 this->valuewindow_entry = pe;
1352 /* Limit string length to 14 so that MAX_INT32 * max currency rate doesn't exceed MAX_INT64. */
1353 ShowQueryString(GetString(STR_JUST_INT, value64), STR_CONFIG_SETTING_QUERY_CAPTION, 15, this, charset_filter, QueryStringFlag::EnableDefault);
1354 }
1355 this->SetDisplayedHelpText(pe);
1356 }
1357 }
1358
1359 void OnTimeout() override
1360 {
1361 if (this->clicked_entry != nullptr) { // On timeout, release any depressed buttons
1362 this->clicked_entry->SetButtons({});
1363 this->clicked_entry = nullptr;
1364 this->SetDirty();
1365 }
1366 }
1367
1368 void OnQueryTextFinished(std::optional<std::string> str) override
1369 {
1370 /* The user pressed cancel */
1371 if (!str.has_value()) return;
1372
1373 assert(this->valuewindow_entry != nullptr);
1374 const IntSettingDesc *sd = this->valuewindow_entry->setting;
1375
1376 int32_t value;
1377 if (!str->empty()) {
1378 auto llvalue = ParseInteger<int64_t>(*str, 10, true);
1379 if (!llvalue.has_value()) return;
1380
1381 /* Save the correct currency-translated value */
1382 if (sd->flags.Test(SettingFlag::GuiCurrency)) llvalue = *llvalue / GetCurrency().rate;
1383
1384 value = ClampTo<int32_t>(*llvalue);
1385 } else {
1386 value = sd->GetDefaultValue();
1387 }
1388
1389 SetSettingValue(this->valuewindow_entry->setting, value);
1390 this->SetDirty();
1391 }
1392
1393 void OnMouseLoop() override
1394 {
1395 if (_left_button_down || !this->gui_scale_changed) return;
1396
1397 this->gui_scale_changed = false;
1398 _gui_scale_cfg = this->gui_scale;
1399
1400 if (AdjustGUIZoom(false)) {
1401 ReInitAllWindows(true);
1403 this->SetDirty();
1404 }
1405 }
1406
1407 void OnDropdownSelect(WidgetID widget, int index, int) override
1408 {
1409 switch (widget) {
1410 case WID_GO_CURRENCY_DROPDOWN: // Currency
1411 if (index == CURRENCY_CUSTOM) ShowCustCurrency();
1412 this->opt->locale.currency = index;
1413 ReInitAllWindows(false);
1414 break;
1415
1416 case WID_GO_AUTOSAVE_DROPDOWN: // Autosave options
1419 this->SetDirty();
1420 break;
1421
1422 case WID_GO_LANG_DROPDOWN: // Change interface language
1426 ClearAllCachedNames();
1428 CheckBlitter();
1429 ReInitAllWindows(false);
1430 break;
1431
1432 case WID_GO_RESOLUTION_DROPDOWN: // Change resolution
1433 if ((uint)index < _resolutions.size() && ChangeResInGame(_resolutions[index].width, _resolutions[index].height)) {
1434 this->SetDirty();
1435 }
1436 break;
1437
1439 _settings_client.gui.refresh_rate = *std::next(_refresh_rates.begin(), index);
1441 /* Show warning to the user that this refresh rate might not be suitable on
1442 * larger maps with many NewGRFs and vehicles. */
1443 ShowErrorMessage(GetEncodedString(STR_GAME_OPTIONS_REFRESH_RATE_WARNING), {}, WL_INFO);
1444 }
1445 break;
1446 }
1447
1449 if (_game_mode == GM_MENU) {
1451 auto set = BaseGraphics::GetSet(index);
1453 this->reload = true;
1454 this->InvalidateData();
1455 }
1456 break;
1457
1459 ChangeSoundSet(index);
1460 break;
1461
1463 ChangeMusicSet(index);
1464 break;
1465
1467 this->filter.mode = (RestrictionMode)index;
1468 if (this->filter.mode == RM_CHANGED_AGAINST_DEFAULT ||
1469 this->filter.mode == RM_CHANGED_AGAINST_NEW) {
1470
1471 if (!this->manually_changed_folding) {
1472 /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
1475 }
1476 } else {
1477 /* Non-'changes' filter. Save as default. */
1479 }
1480 this->InvalidateData();
1481 break;
1482
1484 this->filter.type = (SettingType)index;
1485 this->InvalidateData();
1486 break;
1487
1489 /* Deal with drop down boxes on the panel. */
1490 assert(this->valuedropdown_entry != nullptr);
1491 const IntSettingDesc *sd = this->valuedropdown_entry->setting;
1492 assert(sd->flags.Test(SettingFlag::GuiDropdown));
1493
1494 SetSettingValue(sd, index);
1495 this->SetDirty();
1496 break;
1497 }
1498 }
1499
1500 void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close) override
1501 {
1502 if (widget != WID_GO_SETTING_DROPDOWN) {
1503 /* Normally the default implementation of OnDropdownClose() takes care of
1504 * a few things. We want that behaviour here too, but only for
1505 * "normal" dropdown boxes. The special dropdown boxes added for every
1506 * setting that needs one can't have this call. */
1507 Window::OnDropdownClose(pt, widget, index, click_result, instant_close);
1508 } else {
1509 /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
1510 * the same dropdown button was clicked again, and then not open the dropdown again.
1511 * So, we only remember that it was closed, and process it on the next OnPaint, which is
1512 * after OnClick. */
1513 assert(this->valuedropdown_entry != nullptr);
1514 this->closing_dropdown = true;
1515 this->SetDirty();
1516 }
1517 }
1518
1524 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1525 {
1526 if (!gui_scope) return;
1531
1532#ifndef __APPLE__
1535#endif
1536
1539#ifdef HAS_TRUETYPE_FONT
1543#endif /* HAS_TRUETYPE_FONT */
1544
1545 this->SetWidgetDisabledState(WID_GO_BASE_GRF_DROPDOWN, _game_mode != GM_MENU);
1546
1548
1552
1553 for (TextfileType tft = TFT_CONTENT_BEGIN; tft < TFT_CONTENT_END; tft++) {
1557 }
1558
1560
1561 /* Update which settings are to be visible. */
1562 RestrictionMode min_level = (this->filter.mode <= RM_ALL) ? this->filter.mode : RM_BASIC;
1563 this->filter.min_cat = min_level;
1564 this->filter.type_hides = false;
1566
1567 if (this->filter.string.IsEmpty()) {
1568 this->warn_missing = WHR_NONE;
1569 } else if (min_level < this->filter.min_cat) {
1570 this->warn_missing = this->filter.type_hides ? WHR_CATEGORY_TYPE : WHR_CATEGORY;
1571 } else {
1572 this->warn_missing = this->filter.type_hides ? WHR_TYPE : WHR_NONE;
1573 }
1574 this->vscroll->SetCount(GetSettingsTree().Length() + this->warn_lines);
1575
1576 if (this->last_clicked != nullptr && !GetSettingsTree().IsVisible(this->last_clicked)) {
1577 this->SetDisplayedHelpText(nullptr);
1578 }
1579
1580 bool all_folded = true;
1581 bool all_unfolded = true;
1582 GetSettingsTree().GetFoldingState(all_folded, all_unfolded);
1583 this->SetWidgetDisabledState(WID_GO_EXPAND_ALL, all_unfolded);
1585 }
1586
1587 void OnEditboxChanged(WidgetID wid) override
1588 {
1589 if (wid == WID_GO_FILTER) {
1590 this->filter.string.SetFilterTerm(this->filter_editbox.text.GetText());
1591 if (!this->filter.string.IsEmpty() && !this->manually_changed_folding) {
1592 /* User never expanded/collapsed single pages and entered a filter term.
1593 * Expand everything, to save weird expand clicks, */
1595 }
1596 this->InvalidateData();
1597 }
1598 }
1599};
1600
1601static constexpr NWidgetPart _nested_game_options_widgets[] = {
1604 NWidget(WWT_CAPTION, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1606 EndContainer(),
1609 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_TAB_GENERAL), SetMinimalTextLines(2, 0), SetStringTip(STR_GAME_OPTIONS_TAB_GENERAL, STR_GAME_OPTIONS_TAB_GENERAL_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1610 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_TAB_GRAPHICS), SetMinimalTextLines(2, 0), SetStringTip(STR_GAME_OPTIONS_TAB_GRAPHICS, STR_GAME_OPTIONS_TAB_GRAPHICS_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1611 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_TAB_SOUND), SetMinimalTextLines(2, 0), SetStringTip(STR_GAME_OPTIONS_TAB_SOUND, STR_GAME_OPTIONS_TAB_SOUND_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1612 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_TAB_SOCIAL), SetMinimalTextLines(2, 0), SetStringTip(STR_GAME_OPTIONS_TAB_SOCIAL, STR_GAME_OPTIONS_TAB_SOCIAL_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1613 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_TAB_ADVANCED), SetMinimalTextLines(2, 0), SetStringTip(STR_GAME_OPTIONS_TAB_ADVANCED, STR_GAME_OPTIONS_TAB_ADVANCED_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1614 EndContainer(),
1615 EndContainer(),
1618 /* General tab */
1622 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_LANG_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_LANGUAGE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1623 EndContainer(),
1624
1626 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_AUTOSAVE_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1627 EndContainer(),
1628
1629 NWidget(WWT_FRAME, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_CURRENCY_UNITS_FRAME), SetTextStyle(GAME_OPTIONS_FRAME),
1630 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_CURRENCY_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_CURRENCY_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1631 EndContainer(),
1632
1633 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_GO_SURVEY_SEL),
1634 NWidget(WWT_FRAME, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_PARTICIPATE_SURVEY_FRAME), SetTextStyle(GAME_OPTIONS_FRAME), SetPIP(0, WidgetDimensions::unscaled.vsep_sparse, 0),
1638 EndContainer(),
1640 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_SURVEY_PREVIEW_BUTTON), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_PARTICIPATE_SURVEY_PREVIEW, STR_GAME_OPTIONS_PARTICIPATE_SURVEY_PREVIEW_TOOLTIP),
1641 NWidget(WWT_TEXTBTN, GAME_OPTIONS_BUTTON, WID_GO_SURVEY_LINK_BUTTON), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_PARTICIPATE_SURVEY_LINK, STR_GAME_OPTIONS_PARTICIPATE_SURVEY_LINK_TOOLTIP),
1642 EndContainer(),
1643 EndContainer(),
1644 EndContainer(),
1645 EndContainer(),
1646 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1647 EndContainer(),
1648
1649 /* Graphics tab */
1655 NWidget(WWT_TEXT, INVALID_COLOUR), SetStringTip(STR_GAME_OPTIONS_GUI_SCALE_FRAME), SetTextStyle(GAME_OPTIONS_LABEL),
1656 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_GUI_SCALE), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FS_SMALL), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_GAME_OPTIONS_GUI_SCALE_TOOLTIP),
1657 EndContainer(),
1661 EndContainer(),
1665 EndContainer(),
1666#ifdef HAS_TRUETYPE_FONT
1670 EndContainer(),
1674 EndContainer(),
1675#endif /* HAS_TRUETYPE_FONT */
1676 EndContainer(),
1677 EndContainer(),
1678
1682 NWidget(WWT_TEXT, INVALID_COLOUR), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_RESOLUTION), SetTextStyle(GAME_OPTIONS_LABEL),
1683 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_RESOLUTION_DROPDOWN), SetFill(1, 0), SetToolTip(STR_GAME_OPTIONS_RESOLUTION_TOOLTIP),
1684 EndContainer(),
1686 NWidget(WWT_TEXT, INVALID_COLOUR), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_REFRESH_RATE), SetTextStyle(GAME_OPTIONS_LABEL),
1687 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_REFRESH_RATE_DROPDOWN), SetFill(1, 0), SetToolTip(STR_GAME_OPTIONS_REFRESH_RATE_TOOLTIP),
1688 EndContainer(),
1692 EndContainer(),
1696 EndContainer(),
1697#ifndef __APPLE__
1701 EndContainer(),
1702#endif
1704 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_VIDEO_DRIVER_INFO), SetMinimalTextLines(1, 0), SetFill(1, 0), SetResize(1, 0),
1705 EndContainer(),
1706 EndContainer(),
1707 EndContainer(),
1708
1711 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_GRF_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1713 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1714 EndContainer(),
1715 NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_BASE_GRF_DESCRIPTION), SetStringTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_GRF_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1718 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_OPEN_URL), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
1719 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_README, STR_TEXTFILE_VIEW_README_TOOLTIP),
1720 EndContainer(),
1722 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_TEXTFILE_VIEW_CHANGELOG_TOOLTIP),
1723 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_LICENCE, STR_TEXTFILE_VIEW_LICENCE_TOOLTIP),
1724 EndContainer(),
1725 EndContainer(),
1726 EndContainer(),
1727 EndContainer(),
1728 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1729 EndContainer(),
1730
1731 /* Sound/Music tab */
1736 NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_TEXT_SFX_VOLUME), SetStringTip(STR_GAME_OPTIONS_SFX_VOLUME), SetTextStyle(GAME_OPTIONS_LABEL),
1737 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_BASE_SFX_VOLUME), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FS_SMALL), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1738 EndContainer(),
1740 NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_TEXT_MUSIC_VOLUME), SetStringTip(STR_GAME_OPTIONS_MUSIC_VOLUME), SetTextStyle(GAME_OPTIONS_LABEL),
1741 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_BASE_MUSIC_VOLUME), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FS_SMALL), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1742 EndContainer(),
1743 EndContainer(),
1744
1747 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_SFX_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1748 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1749 EndContainer(),
1750 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_BASE_SFX_DESCRIPTION), SetMinimalTextLines(1, 0), SetToolTip(STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1753 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_OPEN_URL), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
1754 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_README, STR_TEXTFILE_VIEW_README_TOOLTIP),
1755 EndContainer(),
1757 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_TEXTFILE_VIEW_CHANGELOG_TOOLTIP),
1758 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_LICENCE, STR_TEXTFILE_VIEW_LICENCE_TOOLTIP),
1759 EndContainer(),
1760 EndContainer(),
1761 EndContainer(),
1762
1765 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_MUSIC_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1766 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1767 EndContainer(),
1769 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_BASE_MUSIC_DESCRIPTION), SetMinimalTextLines(1, 0), SetToolTip(STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1771 NWidget(WWT_PUSHIMGBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_JUKEBOX), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_MUSIC, STR_TOOLBAR_TOOLTIP_SHOW_SOUND_MUSIC_WINDOW),
1772 EndContainer(),
1773 EndContainer(),
1776 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_OPEN_URL), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
1777 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_README, STR_TEXTFILE_VIEW_README_TOOLTIP),
1778 EndContainer(),
1780 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_TEXTFILE_VIEW_CHANGELOG_TOOLTIP),
1781 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_TEXTFILE_VIEW_LICENCE, STR_TEXTFILE_VIEW_LICENCE_TOOLTIP),
1782 EndContainer(),
1783 EndContainer(),
1784 EndContainer(),
1785 EndContainer(),
1786 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1787 EndContainer(),
1788
1789 /* Social tab */
1792 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1793 EndContainer(),
1794
1795 /* Advanced settings tab */
1799 NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_RESTRICT_CATEGORY), SetStringTip(STR_CONFIG_SETTING_RESTRICT_CATEGORY), SetTextStyle(GAME_OPTIONS_LABEL),
1800 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_RESTRICT_DROPDOWN), SetToolTip(STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
1801 EndContainer(),
1803 NWidget(WWT_TEXT, INVALID_COLOUR, WID_GO_RESTRICT_TYPE), SetStringTip(STR_CONFIG_SETTING_RESTRICT_TYPE), SetTextStyle(GAME_OPTIONS_LABEL),
1804 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_TYPE_DROPDOWN), SetToolTip(STR_CONFIG_SETTING_TYPE_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
1805 EndContainer(),
1807 NWidget(WWT_TEXT, INVALID_COLOUR), SetFill(0, 1), SetStringTip(STR_CONFIG_SETTING_FILTER_TITLE), SetTextStyle(GAME_OPTIONS_LABEL),
1808 NWidget(WWT_EDITBOX, GAME_OPTIONS_BACKGROUND, WID_GO_FILTER), SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1809 EndContainer(),
1810 EndContainer(),
1811
1814 EndContainer(),
1816 EndContainer(),
1817
1819 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_EXPAND_ALL), SetStringTip(STR_CONFIG_SETTING_EXPAND_ALL), SetFill(1, 0), SetResize(1, 0),
1820 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_COLLAPSE_ALL), SetStringTip(STR_CONFIG_SETTING_COLLAPSE_ALL), SetFill(1, 0), SetResize(1, 0),
1821 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_RESET_ALL), SetStringTip(STR_CONFIG_SETTING_RESET_ALL), SetFill(1, 0), SetResize(1, 0),
1822 EndContainer(),
1823
1824 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GO_SETTING_PROPERTIES), SetFill(1, 0), SetResize(1, 0),
1828 EndContainer(),
1829 EndContainer(),
1830 EndContainer(),
1831
1833 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1835 EndContainer(),
1836 EndContainer(),
1837};
1838
1839static WindowDesc _game_options_desc(
1840 WDP_CENTER, "game_options", 0, 0,
1842 {},
1843 _nested_game_options_widgets
1844);
1845
1848{
1850 new GameOptionsWindow(_game_options_desc);
1851}
1852
1862void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
1863{
1864 PixelColour colour = GetColourGradient(button_colour, SHADE_DARKER);
1865 Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
1866
1867 Rect lr = {x, y, x + (int)dim.width - 1, y + (int)dim.height - 1};
1868 Rect rr = {x + (int)dim.width, y, x + (int)dim.width * 2 - 1, y + (int)dim.height - 1};
1869
1870 DrawFrameRect(lr, button_colour, (state == 1) ? FrameFlag::Lowered : FrameFlags{});
1871 DrawFrameRect(rr, button_colour, (state == 2) ? FrameFlag::Lowered : FrameFlags{});
1872 DrawSpriteIgnorePadding(SPR_ARROW_LEFT, PAL_NONE, lr, SA_CENTER);
1873 DrawSpriteIgnorePadding(SPR_ARROW_RIGHT, PAL_NONE, rr, SA_CENTER);
1874
1875 /* Grey out the buttons that aren't clickable */
1876 bool rtl = _current_text_dir == TD_RTL;
1877 if (rtl ? !clickable_right : !clickable_left) {
1879 }
1880 if (rtl ? !clickable_left : !clickable_right) {
1882 }
1883}
1884
1894void DrawUpDownButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_up, bool clickable_down)
1895{
1896 PixelColour colour = GetColourGradient(button_colour, SHADE_DARKER);
1897
1898 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1901
1902 DrawFrameRect(ur, button_colour, (state == 1) ? FrameFlag::Lowered : FrameFlags{});
1903 DrawFrameRect(dr, button_colour, (state == 2) ? FrameFlag::Lowered : FrameFlags{});
1904 DrawSpriteIgnorePadding(SPR_ARROW_UP, PAL_NONE, ur, SA_CENTER);
1905 DrawSpriteIgnorePadding(SPR_ARROW_DOWN, PAL_NONE, dr, SA_CENTER);
1906
1907 /* Grey out the buttons that aren't clickable */
1908 if (!clickable_up) GfxFillRect(ur.Shrink(WidgetDimensions::scaled.bevel), colour, FILLRECT_CHECKER);
1909 if (!clickable_down) GfxFillRect(dr.Shrink(WidgetDimensions::scaled.bevel), colour, FILLRECT_CHECKER);
1910}
1911
1920void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
1921{
1922 PixelColour colour = GetColourGradient(button_colour, SHADE_DARKER);
1923
1924 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1925
1926 DrawFrameRect(r, button_colour, state ? FrameFlag::Lowered : FrameFlags{});
1927 DrawSpriteIgnorePadding(SPR_ARROW_DOWN, PAL_NONE, r, SA_CENTER);
1928
1929 if (!clickable) {
1931 }
1932}
1933
1943void DrawBoolButton(int x, int y, Colours button_colour, Colours background, bool state, bool clickable)
1944{
1945 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1946 DrawFrameRect(r, state ? COLOUR_GREEN : background, state ? FrameFlags{FrameFlag::Lowered} : FrameFlags{FrameFlag::Lowered, FrameFlag::BorderOnly});
1947 if (!clickable) {
1948 GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), GetColourGradient(state ? COLOUR_GREEN : background, SHADE_DARKER), FILLRECT_CHECKER);
1949 }
1950
1951 Rect button_rect = r.WithWidth(SETTING_BUTTON_WIDTH / 3, state ^ (_current_text_dir == TD_RTL));
1952 DrawFrameRect(button_rect, button_colour, {});
1953 if (!clickable) {
1954 GfxFillRect(button_rect.Shrink(WidgetDimensions::scaled.bevel), GetColourGradient(button_colour, SHADE_DARKER), FILLRECT_CHECKER);
1955 }
1956}
1957
1959 WidgetID query_widget{};
1960
1962 {
1963 this->InitNested();
1964
1965 SetButtonState();
1966 }
1967
1968 void SetButtonState()
1969 {
1971 this->SetWidgetDisabledState(WID_CC_RATE_UP, GetCustomCurrency().rate == UINT16_MAX);
1974 }
1975
1976 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1977 {
1978 switch (widget) {
1979 case WID_CC_RATE: return GetString(STR_CURRENCY_EXCHANGE_RATE, 1, 1);
1980 case WID_CC_SEPARATOR: return GetString(STR_CURRENCY_SEPARATOR, GetCustomCurrency().separator);
1981 case WID_CC_PREFIX: return GetString(STR_CURRENCY_PREFIX, GetCustomCurrency().prefix);
1982 case WID_CC_SUFFIX: return GetString(STR_CURRENCY_SUFFIX, GetCustomCurrency().suffix);
1983 case WID_CC_YEAR:
1984 return GetString((GetCustomCurrency().to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER, GetCustomCurrency().to_euro);
1985
1986 case WID_CC_PREVIEW:
1987 return GetString(STR_CURRENCY_PREVIEW, 10000);
1988
1989 default:
1990 return this->Window::GetWidgetString(widget, stringid);
1991 }
1992 }
1993
1994 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1995 {
1996 switch (widget) {
1997 /* Set the appropriate width for the up/down buttons. */
1998 case WID_CC_RATE_DOWN:
1999 case WID_CC_RATE_UP:
2000 case WID_CC_YEAR_DOWN:
2001 case WID_CC_YEAR_UP:
2002 size = maxdim(size, {(uint)SETTING_BUTTON_WIDTH / 2, (uint)SETTING_BUTTON_HEIGHT});
2003 break;
2004
2005 /* Set the appropriate width for the edit buttons. */
2007 case WID_CC_PREFIX_EDIT:
2008 case WID_CC_SUFFIX_EDIT:
2009 size = maxdim(size, {(uint)SETTING_BUTTON_WIDTH, (uint)SETTING_BUTTON_HEIGHT});
2010 break;
2011
2012 /* Make sure the window is wide enough for the widest exchange rate */
2013 case WID_CC_RATE:
2014 size = GetStringBoundingBox(GetString(STR_CURRENCY_EXCHANGE_RATE, 1, INT32_MAX));
2015 break;
2016 }
2017 }
2018
2019 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2020 {
2021 int line = 0;
2022 int len = 0;
2023 std::string str;
2025
2026 switch (widget) {
2027 case WID_CC_RATE_DOWN:
2028 if (GetCustomCurrency().rate > 1) GetCustomCurrency().rate--;
2029 if (GetCustomCurrency().rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
2031 break;
2032
2033 case WID_CC_RATE_UP:
2034 if (GetCustomCurrency().rate < UINT16_MAX) GetCustomCurrency().rate++;
2035 if (GetCustomCurrency().rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
2037 break;
2038
2039 case WID_CC_RATE:
2040 str = GetString(STR_JUST_INT, GetCustomCurrency().rate);
2041 len = 5;
2042 line = WID_CC_RATE;
2043 afilter = CS_NUMERAL;
2044 break;
2045
2047 case WID_CC_SEPARATOR:
2049 len = 7;
2050 line = WID_CC_SEPARATOR;
2051 break;
2052
2053 case WID_CC_PREFIX_EDIT:
2054 case WID_CC_PREFIX:
2055 str = GetCustomCurrency().prefix;
2056 len = 15;
2057 line = WID_CC_PREFIX;
2058 break;
2059
2060 case WID_CC_SUFFIX_EDIT:
2061 case WID_CC_SUFFIX:
2062 str = GetCustomCurrency().suffix;
2063 len = 15;
2064 line = WID_CC_SUFFIX;
2065 break;
2066
2067 case WID_CC_YEAR_DOWN:
2071 break;
2072
2073 case WID_CC_YEAR_UP:
2077 break;
2078
2079 case WID_CC_YEAR:
2080 str = GetString(STR_JUST_INT, GetCustomCurrency().to_euro);
2081 len = 7;
2082 line = WID_CC_YEAR;
2083 afilter = CS_NUMERAL;
2084 break;
2085 }
2086
2087 if (len != 0) {
2088 this->query_widget = line;
2089 ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, {});
2090 }
2091
2092 this->SetTimeout();
2093 this->SetDirty();
2094 }
2095
2096 void OnQueryTextFinished(std::optional<std::string> str) override
2097 {
2098 if (!str.has_value()) return;
2099
2100 switch (this->query_widget) {
2101 case WID_CC_RATE: {
2102 auto val = ParseInteger(*str, 10, true);
2103 if (!val.has_value()) return;
2104 GetCustomCurrency().rate = Clamp(*val, 1, UINT16_MAX);
2105 break;
2106 }
2107
2108 case WID_CC_SEPARATOR: // Thousands separator
2109 GetCustomCurrency().separator = std::move(*str);
2110 break;
2111
2112 case WID_CC_PREFIX:
2113 GetCustomCurrency().prefix = std::move(*str);
2114 break;
2115
2116 case WID_CC_SUFFIX:
2117 GetCustomCurrency().suffix = std::move(*str);
2118 break;
2119
2120 case WID_CC_YEAR: { // Year to switch to euro
2122 if (!str->empty()) {
2123 auto val = ParseInteger(*str, 10, true);
2124 if (!val.has_value()) return;
2126 }
2127 GetCustomCurrency().to_euro = year;
2128 break;
2129 }
2130 }
2132 SetButtonState();
2133 }
2134
2135 void OnTimeout() override
2136 {
2137 this->SetDirty();
2138 }
2139};
2140
2141static constexpr NWidgetPart _nested_cust_currency_widgets[] = {
2143 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2144 NWidget(WWT_CAPTION, COLOUR_GREY), SetStringTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2145 EndContainer(),
2146 NWidget(WWT_PANEL, COLOUR_GREY),
2151 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_DOWN), SetArrowWidgetTypeTip(AWV_DECREASE, STR_CURRENCY_DECREASE_EXCHANGE_RATE_TOOLTIP),
2152 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_UP), SetArrowWidgetTypeTip(AWV_INCREASE, STR_CURRENCY_INCREASE_EXCHANGE_RATE_TOOLTIP),
2153 EndContainer(),
2154 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CC_RATE), SetToolTip(STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
2155 EndContainer(),
2157 NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SEPARATOR_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
2158 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CC_SEPARATOR), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
2159 EndContainer(),
2161 NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_PREFIX_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
2162 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CC_PREFIX), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
2163 EndContainer(),
2165 NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SUFFIX_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
2166 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CC_SUFFIX), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
2167 EndContainer(),
2170 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_DOWN), SetArrowWidgetTypeTip(AWV_DECREASE, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2171 NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_UP), SetArrowWidgetTypeTip(AWV_INCREASE, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2172 EndContainer(),
2173 NWidget(WWT_TEXT, INVALID_COLOUR, WID_CC_YEAR), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
2174 EndContainer(),
2175 EndContainer(),
2176 NWidget(WWT_LABEL, INVALID_COLOUR, WID_CC_PREVIEW),
2177 SetToolTip(STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP),
2178 EndContainer(),
2179 EndContainer(),
2180};
2181
2182static WindowDesc _cust_currency_desc(
2183 WDP_CENTER, {}, 0, 0,
2185 {},
2186 _nested_cust_currency_widgets
2187);
2188
2190static void ShowCustCurrency()
2191{
2193 new CustomCurrencyWindow(_cust_currency_desc);
2194}
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
Base functions for all AIs.
Generic functions for replacing base data (graphics, sounds).
Generic functions for replacing base graphics data.
Generic functions for replacing base music data.
Generic functions for replacing base sounds data.
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 const GraphicsSet * GetUsedSet()
Return the used set.
static int GetNumSets()
Count the number of available graphics sets.
static const GraphicsSet * GetSet(int index)
Get the name of the graphics set at the specified index.
static bool SetSet(const GraphicsSet *set)
Set the set to be used.
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().
Enum-as-bit-set wrapper.
static void ClearFontCaches(FontSizes fontsizes)
Clear cached information for the specified font caches.
static void LoadFontCaches(FontSizes fontsizes)
(Re)initialize the font cache related things, i.e.
static MusicDriver * GetInstance()
Get the currently active instance of the music driver.
virtual void SetVolume(uint8_t vol)=0
Set the volume, if possible.
Baseclass for nested widgets.
uint current_x
Current horizontal size (after resizing).
int pos_y
Vertical position of top-left corner of the widget in the window.
int pos_x
Horizontal position of top-left corner of the widget in the window.
uint resize_y
Vertical resize step (0 means not resizable).
void Add(std::unique_ptr< NWidgetBase > &&wid)
Append widget wid to container.
Definition widget.cpp:1292
std::vector< std::unique_ptr< NWidgetBase > > children
Child widgets in container.
void SetPIP(uint8_t pip_pre, uint8_t pip_inter, uint8_t pip_post)
Set additional pre/inter/post space for the container.
Definition widget.cpp:1508
Base class for a resizable nested widget.
bool UpdateVerticalSize(uint min_y)
Set absolute (post-scaling) minimal size of the widget.
Definition widget.cpp:1120
void Draw(const Window *w) override
Draw the widgets of the tree.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
std::string & GetWidestPlugin(T SocialIntegrationPlugin::*member) const
Find of all the plugins the one where the member is the widest (in pixels).
Vertical container.
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
Definition widget.cpp:1718
Scrollbar data structure.
size_type GetCapacity() const
Gets the number of visible elements of the scrollbar.
void SetCount(size_t num)
Sets the number of elements in the list.
void SetCapacity(size_t capacity)
Set the capacity of visible elements.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2425
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2499
size_type GetCount() const
Gets the number of elements in the list.
size_type GetPosition() const
Gets the position of the first visible element in the list.
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.
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:93
RectPadding bevel
Bevel thickness, affected by "scaled bevels" game option.
Definition window_gui.h:38
int hsep_indent
Width of indentation for tree layouts.
Definition window_gui.h:63
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.
Definition config.h:30
std::array< CurrencySpec, CURRENCY_END > _currency_specs
Array of currencies used by the system.
Definition currency.cpp:80
Functions to handle different currencies.
static constexpr TimerGameCalendar::Year MIN_EURO_YEAR
The earliest year custom currencies may switch to the Euro.
Definition currency.h:19
@ CURRENCY_CUSTOM
Custom currency.
Definition currency.h:58
CurrencySpec & GetCustomCurrency()
Get the custom currency.
Definition currency.h:110
static constexpr TimerGameCalendar::Year CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition currency.h:17
const CurrencySpec & GetCurrency()
Get the currently selected currency.
Definition currency.h:119
std::vector< Dimension > _resolutions
List of resolutions.
Definition driver.cpp:28
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
Definition dropdown.cpp:415
Dimension GetDropDownListDimension(const DropDownList &list)
Determine width and height required to fully display a DropDownList.
Definition dropdown.cpp:374
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.
Definition dropdown.cpp:397
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)
Definition error.h:26
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition error.h:24
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)
Definition fileio_type.h:96
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:87
Functions to read fonts from files and cache them.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:713
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:966
int GetStringLineCount(std::string_view str, int maxw)
Calculates number of lines of string.
Definition gfx.cpp:737
bool _left_button_down
Is left mouse button pressed?
Definition gfx.cpp:42
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:895
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.
Definition gfx.cpp:666
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
bool _left_button_clicked
Is left mouse button clicked?
Definition gfx.cpp:43
int _gui_scale_cfg
GUI scale in config.
Definition gfx.cpp:65
bool DrawStringMultiLineWithClipping(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw a multiline string, possibly over multiple lines, if the region is within the current display cl...
Definition gfx.cpp:868
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.
Definition gfx.cpp:783
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:116
SwitchMode _switch_mode
The next mainloop command.
Definition gfx.cpp:50
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition gfx.cpp:1566
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition gfx.cpp:1816
int _gui_scale
GUI scale, 100 is 100%.
Definition gfx.cpp:64
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition gfxinit.cpp:325
@ FS_SMALL
Index of the small font in the font tables.
Definition gfx_type.h:250
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:390
@ SA_CENTER
Center both horizontally and vertically.
Definition gfx_type.h:398
constexpr FontSizes FONTSIZES_ALL
Mask of all possible font sizes.
Definition gfx_type.h:262
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:307
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:346
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetToolbarMinimalSize(int width)
Widget part function to setting the minimal size for a toolbar button.
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetAlternateColourTip(Colours colour, StringID tip)
Widget part function for setting the alternate colour and tooltip.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
constexpr NWidgetPart SetResizeWidgetTypeTip(ResizeWidgetValues widget_type, StringID tip)
Widget part function for setting the resize widget type and tooltip.
std::unique_ptr< NWidgetBase > MakeNWidgets(std::span< const NWidgetPart > nwid_parts, std::unique_ptr< NWidgetBase > &&container)
Construct a nested widget tree from an array of parts.
Definition widget.cpp:3374
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetValues widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetAlignment(StringAlignment align)
Widget part function for setting the alignment of text/images.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
constexpr NWidgetPart SetPIPRatio(uint8_t ratio_pre, uint8_t ratio_inter, uint8_t ratio_post)
Widget part function for setting a pre/inter/post ratio.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:966
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1547
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.
Definition strings.cpp:53
const LanguageMetadata * _current_language
The currently loaded language.
Definition strings.cpp:54
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
Definition strings.cpp:2020
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
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.
@ WID_TF_CAPTION
The caption of the window.
Definition misc_widget.h:50
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?
Definition network.cpp:69
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.
Definition openttd.cpp:1314
@ SM_MENU
Switch to game intro menu.
Definition openttd.h:33
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:388
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.
SettingEntryFlag
Flags for SettingEntry.
@ 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).
Definition settings.cpp:62
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
static constexpr TextColour GAME_OPTIONS_LABEL
Colour for label text of game options.
static constexpr Colours GAME_OPTIONS_BACKGROUND
Colour for background of game options.
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.
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.
void DrawBoolButton(int x, int y, Colours button_colour, Colours background, bool state, bool clickable)
Draw a toggle button.
void DrawUpDownButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_up, bool clickable_down)
Draw [^][v] buttons.
void ShowBaseSetTextfileWindow(Window *parent, TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
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.
static constexpr TextColour GAME_OPTIONS_FRAME
Colour for frame text of game options.
static uint GetCurrentResolutionIndex()
Get index of the current screen resolution.
static constexpr Colours GAME_OPTIONS_BUTTON
Colour for buttons of game options.
static void ShowCustCurrency()
Open custom currency window.
static constexpr TextColour GAME_OPTIONS_SELECTED
Colour for selected text of game options.
void ShowGameOptions()
Open the game options window.
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_GAME
Game setting.
@ ST_COMPANY
Company setting.
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
@ WID_GO_BASE_SFX_OPEN_URL
Open base SFX URL.
@ WID_GO_SETTING_DROPDOWN
Dynamically created dropdown for changing setting value.
@ WID_GO_BASE_MUSIC_DESCRIPTION
Description of selected base music set.
@ WID_GO_BASE_MUSIC_CONTENT_DOWNLOAD
'Get Content' button for base music.
@ WID_GO_RESTRICT_DROPDOWN
The drop down box to restrict the list of settings.
@ WID_GO_RESOLUTION_DROPDOWN
Dropdown for the resolution.
@ WID_GO_COLLAPSE_ALL
Collapse all button.
@ WID_GO_CURRENCY_DROPDOWN
Currency dropdown.
@ WID_GO_BASE_GRF_DESCRIPTION
Description of selected base GRF.
@ WID_GO_BASE_SFX_DESCRIPTION
Description of selected base SFX.
@ WID_GO_GUI_FONT_AA_TEXT
Text for anti-alias toggle.
@ WID_GO_RESET_ALL
Reset all button.
@ WID_GO_GUI_SCALE_BEVEL_BUTTON
Toggle for chunky bevels.
@ WID_GO_GUI_SCALE
GUI Scale slider.
@ WID_GO_BASE_SFX_TEXTFILE
Open base SFX readme, changelog (+1) or license (+2).
@ WID_GO_TAB_ADVANCED
Advanced tab.
@ WID_GO_GUI_FONT_SPRITE
Toggle whether to prefer the sprite font over TTF fonts.
@ WID_GO_GUI_SCALE_AUTO
Autodetect GUI scale button.
@ WID_GO_SOCIAL_PLUGINS
Main widget handling the social plugins.
@ WID_GO_BASE_GRF_CONTENT_DOWNLOAD
'Get Content' button for base GRF.
@ WID_GO_FILTER
Text filter.
@ WID_GO_BASE_GRF_TEXTFILE
Open base GRF readme, changelog (+1) or license (+2).
@ WID_GO_TAB_GENERAL
General tab.
@ WID_GO_VIDEO_VSYNC_TEXT
Text for video vsync toggle.
@ WID_GO_BASE_GRF_DROPDOWN
Use to select a base GRF.
@ WID_GO_BASE_MUSIC_VOLUME
Change music volume.
@ WID_GO_GUI_FONT_SPRITE_TEXT
Text for sprite font toggle.
@ WID_GO_BASE_SFX_VOLUME
Change sound effects volume.
@ WID_GO_BASE_GRF_PARAMETERS
Base GRF parameters.
@ WID_GO_LANG_DROPDOWN
Language dropdown.
@ WID_GO_VIDEO_ACCEL_TEXT
Text for video acceleration toggle.
@ WID_GO_GUI_FONT_AA
Toggle whether to anti-alias fonts.
@ WID_GO_VIDEO_VSYNC_BUTTON
Toggle for video vsync.
@ WID_GO_SURVEY_LINK_BUTTON
Button to open browser to go to the survey website.
@ WID_GO_SURVEY_PARTICIPATE_TEXT
Text for automated survey toggle.
@ WID_GO_OPTIONSPANEL
Panel widget containing the option lists.
@ WID_GO_TAB_SELECTION
Background of the tab selection.
@ WID_GO_SURVEY_PARTICIPATE_BUTTON
Toggle for participating in the automated survey.
@ WID_GO_AUTOSAVE_DROPDOWN
Dropdown to say how often to autosave.
@ WID_GO_TAB_GRAPHICS
Graphics tab.
@ WID_GO_HELP_TEXT_SCROLL
Scrollbar for setting description.
@ WID_GO_SCROLLBAR
Scrollbar.
@ WID_GO_GUI_SCALE_AUTO_TEXT
Text for Autodetect GUI scale.
@ WID_GO_TEXT_MUSIC_VOLUME
Music volume label.
@ WID_GO_GUI_SCALE_BEVEL_TEXT
Text for chunky bevels.
@ WID_GO_BASE_MUSIC_JUKEBOX
Open the jukebox.
@ WID_GO_SOCIAL_PLUGIN_STATE
State of the social plugin.
@ WID_GO_SETTING_PROPERTIES
Information area to display setting type and default value.
@ WID_GO_SURVEY_SEL
Selection to hide survey if no JSON library is compiled in.
@ WID_GO_REFRESH_RATE_DROPDOWN
Dropdown for all available refresh rates.
@ WID_GO_EXPAND_ALL
Expand all button.
@ WID_GO_SOCIAL_PLUGIN_TITLE
Title of the frame of the social plugin.
@ WID_GO_BASE_GRF_OPEN_URL
Open base GRF URL.
@ WID_GO_BASE_MUSIC_TEXTFILE
Open base music readme, changelog (+1) or license (+2).
@ WID_GO_RESTRICT_CATEGORY
Label upfront to the category drop-down box to restrict the list of settings to show.
@ WID_GO_VIDEO_ACCEL_BUTTON
Toggle for video acceleration.
@ WID_GO_TAB_SOCIAL
Social tab.
@ WID_GO_FULLSCREEN_TEXT
Text for toggle fullscreen.
@ WID_GO_HELP_TEXT
Information area to display help text of the selected option.
@ WID_GO_SURVEY_PREVIEW_BUTTON
Button to open a preview window with the survey results.
@ WID_GO_BASE_SFX_CONTENT_DOWNLOAD
'Get Content' button for base SFX.
@ WID_GO_SOCIAL_PLUGIN_PLATFORM
Platform of the social plugin.
@ WID_GO_BASE_MUSIC_DROPDOWN
Use to select a base music set.
@ WID_GO_BASE_MUSIC_OPEN_URL
Open base music URL.
@ WID_GO_TYPE_DROPDOWN
The drop down box to choose client/game/company/all settings.
@ WID_GO_FULLSCREEN_BUTTON
Toggle fullscreen.
@ WID_GO_TAB_SOUND
Sound tab.
@ WID_GO_BASE_SFX_DROPDOWN
Use to select a base SFX.
@ WID_GO_TEXT_SFX_VOLUME
Sound effects volume label.
@ WID_GO_VIDEO_DRIVER_INFO
Label showing details about the current video driver.
@ WID_GO_RESTRICT_TYPE
Label upfront to the type drop-down box to restrict the list of settings to show.
@ WID_CC_YEAR_DOWN
Down button.
@ WID_CC_YEAR
Year of introduction.
@ WID_CC_SUFFIX_EDIT
Suffix edit button.
@ WID_CC_SEPARATOR_EDIT
Separator edit button.
@ WID_CC_RATE_DOWN
Down button.
@ WID_CC_RATE_UP
Up button.
@ WID_CC_PREVIEW
Preview.
@ WID_CC_PREFIX
Current prefix.
@ WID_CC_PREFIX_EDIT
Prefix edit button.
@ WID_CC_SUFFIX
Current suffix.
@ WID_CC_YEAR_UP
Up button.
@ WID_CC_SEPARATOR
Current separator.
@ WID_CC_RATE
Rate of currency.
void DrawSliderWidget(Rect r, Colours wedge_colour, Colours handle_colour, TextColour text_colour, int min_value, int max_value, int nmarks, int value, SliderMarkFunc *mark_func)
Draw a slider widget with knob at given value.
Definition slider.cpp:34
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.
Definition slider.cpp:94
Interface definitions for game to report/respond to social integration.
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Definition sound.cpp:253
void ChangeSoundSet(int index)
Change the configured sound set and reset sounds.
Definition sound.cpp:167
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.
Definition stdafx.h:271
Parse strings.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
Functions related to low-level strings.
CharSetFilter
Valid filter types for IsValidChar.
Definition string_type.h:24
@ CS_NUMERAL
Only numeric ones.
Definition string_type.h:26
@ CS_NUMERAL_SIGNED
Only numbers and '-' for negative values.
Definition string_type.h:28
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition string_type.h:25
Searching and filtering using a stringterm.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
void CheckForMissingGlyphs(MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
Definition strings.cpp:2362
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
std::string_view GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
Definition strings.cpp:2269
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
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.
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
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.
static Dimension circle_size
Dimension of the circle +/- icon.
static int line_height
Height of a single setting.
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
T y
Y coordinate.
T x
X coordinate.
Specification of a currency.
Definition currency.h:77
std::string separator
The thousands separator for this currency.
Definition currency.h:79
std::string prefix
Prefix to apply when formatting money in this currency.
Definition currency.h:81
TimerGameCalendar::Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
Definition currency.h:80
std::string suffix
Suffix to apply when formatting money in this currency.
Definition currency.h:82
std::string code
3 letter untranslated code to identify the currency.
Definition currency.h:83
uint16_t rate
The conversion rate compared to the base currency.
Definition currency.h:78
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.
Data about how and where to blit pixels.
Definition gfx_type.h:157
bool prefer_sprite
Whether to prefer the built-in sprite font over resizable fonts.
Definition fontcache.h:185
bool global_aa
Whether to anti alias all font sizes.
Definition fontcache.h:186
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.
SettingFilter filter
Filter for the list.
bool closing_dropdown
True, if the dropdown list is currently closing.
void OnTimeout() override
Called when this window's timeout has been reached.
void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close) override
A dropdown window associated to this window has been closed.
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
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, int) override
A dropdown option associated to this window has been selected.
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnPaint() override
The window must be repainted.
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button).
void OnEditboxChanged(WidgetID wid) override
The text in an editbox has been edited.
QueryString filter_editbox
Filter editbox;.
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
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.
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.
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.
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
DropDownList BuildDropDownList(WidgetID widget, int *selected_index) const
Build the dropdown list for a specific widget.
void OnInit() override
Notification that the nested widget tree gets initialized.
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
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.
std::tuple< int32_t, uint32_t > GetRange() const
Get the min/max range for the setting.
Definition settings.cpp:476
int32_t GetDefaultValue() const
Get the default value of the setting.
Definition settings.cpp:467
StringID GetHelp() const
Get the help text of the setting.
Definition settings.cpp:436
virtual bool IsBoolSetting() const
Check whether this setting is a boolean type setting.
std::pair< StringParameter, StringParameter > GetValueParams(int32_t value) const
Get parameters for drawing the value of the setting.
Definition settings.cpp:445
int32_t Read(const void *object) const
Read the integer from the the actual setting.
Definition settings.cpp:567
int32_t interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
char own_name[32]
the localized name of this language
Definition language.h:30
uint8_t currency
currency we currently use
uint8_t effect_vol
The requested effects volume.
uint8_t music_vol
The requested music volume.
Partial widget specification to allow NWidgets to be written nested.
ParticipateSurvey participate_survey
Participate in the automated survey.
Colour for pixel/line drawing.
Definition gfx_type.h:405
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.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
int Height() const
Get height of Rect.
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
Definition settings.cpp:894
SettingFlags flags
Handles how a setting would show up in the GUI (text/currency, etc.).
SettingType GetType() const
Return the type of the setting.
Definition settings.cpp:911
Standard setting.
void SetButtons(SettingEntryFlags new_val)
Set the button-depressed flags (#SettingsEntryFlag::LeftDepressed and #SettingsEntryFlag::RightDepres...
uint GetMaxHelpHeight(int maxw) override
Get the biggest height of the help text(s), if the width is at least maxw.
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.
std::string_view GetText() const
Get the current text.
Definition textbuf.cpp:284
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.
Definition window_gui.h:167
Data structure for an opened window.
Definition window_gui.h:273
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:978
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1102
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1789
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition window_gui.h:320
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:766
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3216
Window * parent
Parent window.
Definition window_gui.h:328
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:556
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:504
WidgetID mouse_capture_widget
ID of current mouse capture widget (e.g. dragged scrollbar). INVALID_WIDGET if no widget has mouse ca...
Definition window_gui.h:326
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1075
ResizeInfo resize
Resize information.
Definition window_gui.h:314
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition window_gui.h:391
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
Definition window_gui.h:515
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1779
void CloseChildWindowById(WindowClass wc, WindowNumber number) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1090
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:485
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:491
void SetWidgetsLoweredState(bool lowered_stat, Args... widgets)
Sets the lowered/raised status of a list of widgets.
Definition window_gui.h:526
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:441
void EnableWidget(WidgetID widget_index)
Sets a widget to Enabled.
Definition window_gui.h:400
virtual void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close)
A dropdown window associated to this window has been closed.
Definition window.cpp:286
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition window_gui.h:355
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:460
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1802
WindowFlags flags
Window flags.
Definition window_gui.h:300
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:313
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:381
int height
Height of the window (number of pixels down in y direction)
Definition window_gui.h:312
int width
width of the window (number of pixels to the right in x direction)
Definition window_gui.h:311
@ 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, std::string_view 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.
Base of the town class.
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 DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition widget.cpp:289
void SetupWidgetDimensions()
Set up pre-scaled versions of Widget Dimensions.
Definition widget.cpp:80
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
@ WWT_LABEL
Centered label.
Definition widget_type.h:49
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:71
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:63
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:67
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:45
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:40
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:53
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:77
@ WWT_BOOLBTN
Standard boolean toggle button.
Definition widget_type.h:47
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:69
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:61
@ WWT_FRAME
Frame.
Definition widget_type.h:52
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:38
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition widget_type.h:60
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:57
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:62
@ WWT_TEXT
Pure simple text.
Definition widget_type.h:50
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:72
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:21
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:22
@ RWV_HIDE_BEVEL
Bevel of resize box is hidden.
Definition widget_type.h:30
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1193
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition window.cpp:3392
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1205
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition window.cpp:3184
Window functions not directly related to making/drawing windows.
@ BorderOnly
Draw border only, no background.
@ 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.
Definition window_gui.h:145
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_GAME_OPTIONS_GAME_OPTIONS
Game options.
Definition window_type.h:31
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50
@ 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.