OpenTTD Source 20260711-master-g3fb3006dff
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "currency_func.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
100struct BaseSetTextfileWindow : public TextfileWindow {
101 const std::string name;
103
104 BaseSetTextfileWindow(Window *parent, TextfileType file_type, const std::string &name, const std::string &textfile, StringID content_type) : TextfileWindow(parent, file_type), name(name), content_type(content_type)
105 {
106 this->ConstructWindow();
107 this->LoadTextfile(textfile, Subdirectory::Baseset);
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
127template <class TBaseSet>
128void ShowBaseSetTextfileWindow(Window *parent, TextfileType file_type, const TBaseSet *baseset, StringID content_type)
129{
130 parent->CloseChildWindowById(WindowClass::Textfile, file_type);
131 new BaseSetTextfileWindow(parent, file_type, baseset->name, *baseset->GetTextfile(file_type), content_type);
132}
133
141template <typename TBaseSet>
142static std::string GetListLabel(const TBaseSet *baseset)
143{
144 if (baseset->GetNumInvalid() == 0) return GetString(STR_JUST_RAW_STRING, baseset->name);
145 return GetString(STR_BASESET_STATUS, baseset->name, baseset->GetNumInvalid());
146}
147
148template <class T>
149DropDownList BuildSetDropDownList(int *selected_index)
150{
151 int n = T::GetNumSets();
152 *selected_index = T::GetIndexOfUsedSet();
153 DropDownList list;
154 for (int i = 0; i < n; i++) {
155 list.push_back(MakeDropDownListStringItem(GetListLabel(T::GetSet(i)), i));
156 }
157 return list;
158}
159
160std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 };
161
167{
168 /* Add the refresh rate as selected in the config. */
169 _refresh_rates.insert(_settings_client.gui.refresh_rate);
170
171 /* Add all the refresh rates of all monitors connected to the machine. */
172 std::vector<int> monitor_rates = VideoDriver::GetInstance()->GetListOfMonitorRefreshRates();
173 std::copy(monitor_rates.begin(), monitor_rates.end(), std::inserter(_refresh_rates, _refresh_rates.end()));
174}
175
176static const int SCALE_NMARKS = (MAX_INTERFACE_SCALE - MIN_INTERFACE_SCALE) / 25 + 1;
177static const int VOLUME_NMARKS = 9;
178
179static std::optional<std::string> ScaleMarkFunc(int, int, int value)
180{
181 /* Label only every 100% mark. */
182 if (value % 100 != 0) return std::string{};
183
184 return GetString(STR_GAME_OPTIONS_GUI_SCALE_MARK, value / 100, 0);
185}
186
187static std::optional<std::string> VolumeMarkFunc(int, int mark, int value)
188{
189 /* Label only every other mark. */
190 if (mark % 2 != 0) return std::string{};
191
192 /* 0-127 does not map nicely to 0-100. Dividing first gives us nice round numbers. */
193 return GetString(STR_GAME_OPTIONS_VOLUME_MARK, value / 31 * 25);
194}
195
206
207static constexpr std::initializer_list<NWidgetPart> _nested_social_plugins_widgets = {
211 NWidget(WWT_TEXT, Colours::Invalid), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_PLATFORM), SetTextStyle(GAME_OPTIONS_LABEL),
213 EndContainer(),
215 NWidget(WWT_TEXT, Colours::Invalid), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE), SetTextStyle(GAME_OPTIONS_LABEL),
217 EndContainer(),
218 EndContainer(),
219 EndContainer(),
220};
221
222static constexpr std::initializer_list<NWidgetPart> _nested_social_plugins_none_widgets = {
224 NWidget(WWT_TEXT, Colours::Invalid), SetResize(1, 0), SetFill(1, 0), SetStringTip(STR_GAME_OPTIONS_SOCIAL_PLUGINS_NONE), SetTextStyle(GAME_OPTIONS_LABEL),
225 EndContainer(),
226};
227
228class NWidgetSocialPlugins : public NWidgetVertical {
229public:
230 NWidgetSocialPlugins() : NWidgetVertical({}, WID_GO_SOCIAL_PLUGINS)
231 {
232 this->plugins = SocialIntegration::GetPlugins();
233
234 if (this->plugins.empty()) {
235 auto widget = MakeNWidgets(_nested_social_plugins_none_widgets, nullptr);
236 this->Add(std::move(widget));
237 } else {
238 for (size_t i = 0; i < this->plugins.size(); i++) {
239 auto widget = MakeNWidgets(_nested_social_plugins_widgets, nullptr);
240 this->Add(std::move(widget));
241 }
242 }
243
244 this->SetPIP(0, WidgetDimensions::unscaled.vsep_wide, 0);
245 }
246
247 void SetupSmallestSize(Window *w) override
248 {
249 this->current_index = -1;
251 }
252
259 template <typename T>
260 std::string &GetWidestPlugin(T SocialIntegrationPlugin::*member) const
261 {
262 std::string *longest = &(this->plugins[0]->*member);
263 int longest_length = 0;
264
265 for (auto *plugin : this->plugins) {
266 int length = GetStringBoundingBox(plugin->*member).width;
267 if (length > longest_length) {
268 longest_length = length;
269 longest = &(plugin->*member);
270 }
271 }
272
273 return *longest;
274 }
275
276 std::string GetWidgetString(WidgetID widget, StringID) const
277 {
278 switch (widget) {
280 /* For SetupSmallestSize, use the longest string we have. */
281 if (this->current_index < 0) {
283 }
284
285 if (this->plugins[this->current_index]->name.empty()) {
286 return this->plugins[this->current_index]->basepath;
287 }
288
289 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_TITLE, this->plugins[this->current_index]->name, this->plugins[this->current_index]->version);
290
292 /* For SetupSmallestSize, use the longest string we have. */
293 if (this->current_index < 0) {
295 }
296
297 return this->plugins[this->current_index]->social_platform;
298
300 static const std::pair<SocialIntegrationPlugin::State, StringID> state_to_string[] = {
301 { SocialIntegrationPlugin::RUNNING, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_RUNNING },
302 { SocialIntegrationPlugin::FAILED, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_FAILED },
303 { SocialIntegrationPlugin::PLATFORM_NOT_RUNNING, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_PLATFORM_NOT_RUNNING },
304 { SocialIntegrationPlugin::UNLOADED, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_UNLOADED },
305 { SocialIntegrationPlugin::DUPLICATE, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_DUPLICATE },
306 { SocialIntegrationPlugin::UNSUPPORTED_API, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_UNSUPPORTED_API },
307 { SocialIntegrationPlugin::INVALID_SIGNATURE, STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_INVALID_SIGNATURE },
308 };
309
310 /* For SetupSmallestSize, use the longest string we have. */
311 if (this->current_index < 0) {
313
314 /* Set the longest plugin when looking for the longest status. */
315 StringID longest = STR_NULL;
316 int longest_length = 0;
317 for (const auto &[state, string] : state_to_string) {
318 int length = GetStringBoundingBox(GetString(string, longest_plugin)).width;
319 if (length > longest_length) {
320 longest_length = length;
321 longest = string;
322 }
323 }
324
325 return GetString(longest, longest_plugin);
326 }
327
328 const auto plugin = this->plugins[this->current_index];
329
330 /* Find the string for the state. */
331 for (const auto &[state, string] : state_to_string) {
332 if (plugin->state == state) {
333 return GetString(string, plugin->social_platform);
334 }
335 }
336
337 /* Default string, in case no state matches. */
338 return GetString(STR_GAME_OPTIONS_SOCIAL_PLUGIN_STATE_FAILED, plugin->social_platform);
339 }
340
341 default: NOT_REACHED();
342 }
343 }
344
345 void Draw(const Window *w) override
346 {
347 this->current_index = 0;
348
349 for (auto &wid : this->children) {
350 wid->Draw(w);
351 this->current_index++;
352 }
353 }
354
355private:
356 int current_index = -1;
357 std::vector<SocialIntegrationPlugin *> plugins{};
358};
359
361std::unique_ptr<NWidgetBase> MakeNWidgetSocialPlugins()
362{
363 return std::make_unique<NWidgetSocialPlugins>();
364}
365
366static const StringID _game_settings_restrict_dropdown[] = {
367 STR_CONFIG_SETTING_RESTRICT_BASIC, // RM_BASIC
368 STR_CONFIG_SETTING_RESTRICT_ADVANCED, // RM_ADVANCED
369 STR_CONFIG_SETTING_RESTRICT_ALL, // RM_ALL
370 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT, // RM_CHANGED_AGAINST_DEFAULT
371 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW, // RM_CHANGED_AGAINST_NEW
372};
373static_assert(lengthof(_game_settings_restrict_dropdown) == RM_END);
374
382
388static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
389{
390 if (confirmed) {
393 w->InvalidateData();
394 }
395}
396
397struct GameOptionsWindow : Window {
398 static inline GameSettings *settings_ptr;
399
404 bool closing_dropdown = false;
405
410 int warn_lines = 0;
411
412 Scrollbar *vscroll;
413 Scrollbar *vscroll_description;
414 static constexpr uint NUM_DESCRIPTION_LINES = 5;
415
416 GameSettings *opt = nullptr;
417 bool reload = false;
418 bool gui_scale_changed = false;
419 int gui_scale = 0;
420 static inline int previous_gui_scale = 0;
421 static inline WidgetID active_tab = WID_GO_TAB_GENERAL;
422
423 GameOptionsWindow(WindowDesc &desc) : Window(desc), filter_editbox(50)
424 {
425 this->opt = &GetGameSettings();
426
428
429 this->filter.mode = (RestrictionMode)_settings_client.gui.settings_restriction_mode;
430 this->filter.min_cat = RM_ALL;
431 this->filter.type = ST_ALL;
432 this->filter.type_hides = false;
433 this->settings_ptr = &GetGameSettings();
434
435 GetSettingsTree().FoldAll(); // Close all sub-pages
436
437 this->CreateNestedTree();
438 this->vscroll = this->GetScrollbar(WID_GO_SCROLLBAR);
439 this->vscroll_description = this->GetScrollbar(WID_GO_HELP_TEXT_SCROLL);
440 this->vscroll_description->SetCapacity(NUM_DESCRIPTION_LINES);
442
443 this->querystrings[WID_GO_FILTER] = &this->filter_editbox;
444 this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
445
446 this->OnInvalidateData(0);
447
448 this->SetTab(GameOptionsWindow::active_tab);
449
451 }
452
460
461 void Close([[maybe_unused]] int data = 0) override
462 {
463 CloseWindowById(WindowClass::CustomCurrenty, 0);
464 if (this->reload) _switch_mode = SwitchMode::Menu;
465 this->Window::Close();
466 }
467
474 DropDownList BuildDropDownList(WidgetID widget, int *selected_index) const
475 {
476 DropDownList list;
477 switch (widget) {
478 case WID_GO_CURRENCY_DROPDOWN: { // Setup currencies dropdown
479 *selected_index = to_underlying(this->opt->locale.currency);
480 Currencies disabled = _game_mode == GameMode::Menu ? Currencies{} : GetMaskOfAllowedCurrencies().Flip();
481
482 /* Add non-custom currencies; sorted naturally */
483 for (Currency i : EnumRange(Currency::End)) {
484 if (i == Currency::Custom) continue;
485 CurrencySpec &currency = _currency_specs[i];
486 if (currency.code.empty()) {
487 list.push_back(MakeDropDownListStringItem(currency.name, i, disabled.Test(i)));
488 } else {
489 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_CURRENCY_CODE, currency.name, currency.code), i, disabled.Test(i)));
490 }
491 }
492 std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
493
494 /* Append custom currency at the end */
495 list.push_back(MakeDropDownListDividerItem()); // separator line
496 list.push_back(MakeDropDownListStringItem(STR_GAME_OPTIONS_CURRENCY_CUSTOM, Currency::Custom, disabled.Test(Currency::Custom)));
497 break;
498 }
499
500 case WID_GO_AUTOSAVE_DROPDOWN: { // Setup autosave dropdown
501 int index = 0;
502 for (auto &minutes : _autosave_dropdown_to_minutes) {
503 index++;
504 if (_settings_client.gui.autosave_interval <= minutes) break;
505 }
506 *selected_index = index - 1;
507
508 const StringID *items = _autosave_dropdown;
509 for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
510 list.push_back(MakeDropDownListStringItem(*items, i));
511 }
512 break;
513 }
514
515 case WID_GO_LANG_DROPDOWN: { // Setup interface language dropdown
516 for (uint i = 0; i < _languages.size(); i++) {
517 bool hide_language = IsReleasedVersion() && !_languages[i].IsReasonablyFinished();
518 if (hide_language) continue;
519 bool hide_percentage = IsReleasedVersion() || _languages[i].missing < _settings_client.gui.missing_strings_threshold;
520 std::string name;
521 if (&_languages[i] == _current_language) {
522 *selected_index = i;
523 name = _languages[i].own_name;
524 } else {
525 /* Especially with sprite-fonts, not all localized
526 * names can be rendered. So instead, we use the
527 * international names for anything but the current
528 * selected language. This avoids showing a few ????
529 * entries in the dropdown list. */
530 name = _languages[i].name;
531 }
532 if (hide_percentage) {
533 list.push_back(MakeDropDownListStringItem(std::move(name), i));
534 } else {
535 int percentage = (LANGUAGE_TOTAL_STRINGS - _languages[i].missing) * 100 / LANGUAGE_TOTAL_STRINGS;
536 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_LANGUAGE_PERCENTAGE, std::move(name), percentage), i));
537 }
538 }
539 std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
540 break;
541 }
542
543 case WID_GO_RESOLUTION_DROPDOWN: // Setup resolution dropdown
544 if (_resolutions.empty()) break;
545
546 *selected_index = GetCurrentResolutionIndex();
547 for (uint i = 0; i < _resolutions.size(); i++) {
548 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_RESOLUTION_ITEM, _resolutions[i].width, _resolutions[i].height), i));
549 }
550 break;
551
552 case WID_GO_REFRESH_RATE_DROPDOWN: // Setup refresh rate dropdown
553 for (auto it = _refresh_rates.begin(); it != _refresh_rates.end(); it++) {
554 auto i = std::distance(_refresh_rates.begin(), it);
555 if (*it == _settings_client.gui.refresh_rate) *selected_index = i;
556 list.push_back(MakeDropDownListStringItem(GetString(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, *it), i));
557 }
558 break;
559
561 list = BuildSetDropDownList<BaseGraphics>(selected_index);
562 break;
563
565 list = BuildSetDropDownList<BaseSounds>(selected_index);
566 break;
567
569 list = BuildSetDropDownList<BaseMusic>(selected_index);
570 break;
571
573 for (RestrictionMode mode : EnumRange(RM_END)) {
574 /* If we are in adv. settings screen for the new game's settings,
575 * we don't want to allow comparing with new game's settings. */
576 bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
577
578 list.push_back(MakeDropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
579 }
580 break;
581
583 list.push_back(MakeDropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL, ST_ALL));
584 list.push_back(MakeDropDownListStringItem(_game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME, ST_GAME));
585 list.push_back(MakeDropDownListStringItem(_game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME, ST_COMPANY));
586 list.push_back(MakeDropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT, ST_CLIENT));
587 break;
588 }
589
590 return list;
591 }
592
593 std::string GetToggleString(StringID stringid, WidgetID state_widget) const
594 {
595 return GetString(STR_GAME_OPTIONS_SETTING, stringid, this->IsWidgetLowered(state_widget) ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
596 }
597
598 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
599 {
600 switch (widget) {
602 const CurrencySpec &currency = _currency_specs[this->opt->locale.currency];
603 if (currency.code.empty()) return GetString(currency.name);
604 return GetString(STR_GAME_OPTIONS_CURRENCY_CODE, currency.name, currency.code);
605 }
606
608 int index = 0;
609 for (auto &minutes : _autosave_dropdown_to_minutes) {
610 index++;
611 if (_settings_client.gui.autosave_interval <= minutes) break;
612 }
613 return GetString(_autosave_dropdown[index - 1]);
614 }
615
616 case WID_GO_LANG_DROPDOWN: return _current_language->own_name;
620 case WID_GO_REFRESH_RATE_DROPDOWN: return GetString(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, _settings_client.gui.refresh_rate);
622 auto current_resolution = GetCurrentResolutionIndex();
623
624 if (current_resolution == _resolutions.size()) {
625 return GetString(STR_GAME_OPTIONS_RESOLUTION_OTHER);
626 }
627 return GetString(STR_GAME_OPTIONS_RESOLUTION_ITEM, _resolutions[current_resolution].width, _resolutions[current_resolution].height);
628 }
629
634 assert(plugin != nullptr);
635
636 return plugin->GetWidgetString(widget, stringid);
637 }
638
640 return GetString(_game_settings_restrict_dropdown[this->filter.mode]);
641
643 switch (this->filter.type) {
644 case ST_GAME: return GetString(_game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME);
645 case ST_COMPANY: return GetString(_game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME);
646 case ST_CLIENT: return GetString(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT);
647 default: return GetString(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL);
648 }
649 break;
650
652 return GetToggleString(STR_GAME_OPTIONS_PARTICIPATE_SURVEY, WID_GO_SURVEY_PARTICIPATE_BUTTON);
653
655 return GetToggleString(STR_GAME_OPTIONS_GUI_SCALE_AUTO, WID_GO_GUI_SCALE_AUTO);
656
658 return GetToggleString(STR_GAME_OPTIONS_GUI_SCALE_BEVELS, WID_GO_GUI_SCALE_BEVEL_BUTTON);
659
661 return GetToggleString(STR_GAME_OPTIONS_GUI_FONT_SPRITE, WID_GO_GUI_FONT_SPRITE);
662
664 return GetToggleString(STR_GAME_OPTIONS_GUI_FONT_AA, WID_GO_GUI_FONT_AA);
665
667 return GetToggleString(STR_GAME_OPTIONS_FULLSCREEN, WID_GO_FULLSCREEN_BUTTON);
668
670 return GetToggleString(STR_GAME_OPTIONS_VIDEO_ACCELERATION, WID_GO_VIDEO_ACCEL_BUTTON);
671
673 return GetToggleString(STR_GAME_OPTIONS_VIDEO_VSYNC, WID_GO_VIDEO_VSYNC_BUTTON);
674
675 default:
676 return this->Window::GetWidgetString(widget, stringid);
677 }
678 }
679
680 void DrawWidget(const Rect &r, WidgetID widget) const override
681 {
682 switch (widget) {
685 break;
686
689 break;
690
693 break;
694
695 case WID_GO_GUI_SCALE:
696 DrawSliderWidget(r, GAME_OPTIONS_BACKGROUND, GAME_OPTIONS_BUTTON, TextColour::Black, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, SCALE_NMARKS, this->gui_scale, ScaleMarkFunc);
697 break;
698
700 DrawStringMultiLine(r, GetString(STR_GAME_OPTIONS_VIDEO_DRIVER_INFO, std::string{VideoDriver::GetInstance()->GetInfoString()}), GAME_OPTIONS_SELECTED);
701 break;
702
705 break;
706
709 break;
710
711 case WID_GO_OPTIONSPANEL: {
713 tr.top += this->warn_lines * BaseSettingEntry::line_height;
714 uint last_row = this->vscroll->GetPosition() + this->vscroll->GetCapacity() - this->warn_lines;
715 int next_row = GetSettingsTree().Draw(settings_ptr, tr.left, tr.right, tr.top,
716 this->vscroll->GetPosition(), last_row, this->last_clicked);
717 if (next_row == 0) DrawString(tr, STR_CONFIG_SETTINGS_NONE);
718 break;
719 }
720
722 if (this->last_clicked != nullptr) {
723 const IntSettingDesc *sd = this->last_clicked->setting;
724
725 Rect tr = r;
726 std::string str;
727 switch (sd->GetType()) {
728 case ST_COMPANY: str = GetString(STR_CONFIG_SETTING_TYPE, _game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME); break;
729 case ST_CLIENT: str = GetString(STR_CONFIG_SETTING_TYPE, STR_CONFIG_SETTING_TYPE_CLIENT); break;
730 case ST_GAME: str = GetString(STR_CONFIG_SETTING_TYPE, _game_mode == GameMode::Menu ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME); break;
731 default: NOT_REACHED();
732 }
733 DrawString(tr, str);
735
736 auto [param1, param2] = sd->GetValueParams(sd->GetDefaultValue());
737 DrawString(tr, GetString(STR_CONFIG_SETTING_DEFAULT_VALUE, param1, param2));
738 }
739 break;
740
741 case WID_GO_HELP_TEXT:
742 if (this->last_clicked != nullptr) {
743 const IntSettingDesc *sd = this->last_clicked->setting;
744
745 DrawPixelInfo tmp_dpi;
746 if (FillDrawPixelInfo(&tmp_dpi, r)) {
747 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
748 int scrolls_pos = this->vscroll_description->GetPosition() * GetCharacterHeight(FontSize::Normal);
749 DrawStringMultiLine(0, r.Width() - 1, -scrolls_pos, r.Height() - 1, sd->GetHelp(), TextColour::White);
750 }
751 }
752 break;
753
754 default:
755 break;
756 }
757 }
758
764 {
765 if (this->last_clicked != pe) this->SetDirty();
766 this->last_clicked = pe;
767 UpdateHelpTextSize();
768 }
769
770 void UpdateHelpTextSize()
771 {
773 this->vscroll_description->SetCount(this->last_clicked ? CeilDiv(this->last_clicked->GetMaxHelpHeight(wid->current_x), GetCharacterHeight(FontSize::Normal)) : 0);
774 }
775
776 void SetTab(WidgetID widget)
777 {
779 this->LowerWidget(widget);
780 GameOptionsWindow::active_tab = widget;
781
782 int plane;
783 switch (widget) {
784 case WID_GO_TAB_GENERAL: plane = 0; break;
785 case WID_GO_TAB_GRAPHICS: plane = 1; break;
786 case WID_GO_TAB_SOUND: plane = 2; break;
787 case WID_GO_TAB_SOCIAL: plane = 3; break;
788 case WID_GO_TAB_ADVANCED: plane = 4; break;
789 default: NOT_REACHED();
790 }
791
792 this->GetWidget<NWidgetStacked>(WID_GO_TAB_SELECTION)->SetDisplayedPlane(plane);
794 this->SetDirty();
795 }
796
797 void OnResize() override
798 {
799 this->vscroll->SetCapacityFromWidget(this, WID_GO_OPTIONSPANEL, WidgetDimensions::scaled.framerect.Vertical());
800 UpdateHelpTextSize();
801
802 bool changed = false;
803
805 int y = 0;
806 for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
807 std::string str = GetString(STR_JUST_RAW_STRING, BaseGraphics::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
808 y = std::max(y, GetStringHeight(str, wid->current_x));
809 }
810 changed |= wid->UpdateVerticalSize(y);
811
813 y = 0;
814 for (int i = 0; i < BaseSounds::GetNumSets(); i++) {
815 std::string str = GetString(STR_JUST_RAW_STRING, BaseSounds::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
816 y = std::max(y, GetStringHeight(str, wid->current_x));
817 }
818 changed |= wid->UpdateVerticalSize(y);
819
821 y = 0;
822 for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
823 std::string str = GetString(STR_JUST_RAW_STRING, BaseMusic::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
824 y = std::max(y, GetStringHeight(str, wid->current_x));
825 }
826 changed |= wid->UpdateVerticalSize(y);
827
829 std::string str = GetString(STR_GAME_OPTIONS_VIDEO_DRIVER_INFO, std::string{VideoDriver::GetInstance()->GetInfoString()});
830 y = GetStringHeight(str, wid->current_x);
831 changed |= wid->UpdateVerticalSize(y);
832
833 if (changed) this->ReInit(0, 0, this->flags.Test(WindowFlag::Centred));
834 }
835
836 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
837 {
838 switch (widget) {
841 Dimension d = maxdim(GetStringBoundingBox(STR_GAME_OPTIONS_SFX_VOLUME), GetStringBoundingBox(STR_GAME_OPTIONS_MUSIC_VOLUME));
842 d.width += padding.width;
843 d.height += padding.height;
844 size = maxdim(size, d);
845 break;
846 }
847
856 int selected;
857 size.width = std::max(size.width, GetDropDownListDimension(this->BuildDropDownList(widget, &selected)).width + padding.width);
858 break;
859 }
860
862 fill.height = resize.height = BaseSettingEntry::line_height;
863 resize.width = 1;
864
865 size.height = 8 * resize.height + WidgetDimensions::scaled.framerect.Vertical();
866 break;
867
869 static const StringID setting_types[] = {
870 STR_CONFIG_SETTING_TYPE_CLIENT,
871 STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
872 STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
873 };
874 for (const auto &setting_type : setting_types) {
875 size.width = std::max(size.width, GetStringBoundingBox(GetString(STR_CONFIG_SETTING_TYPE, setting_type)).width + padding.width);
876 }
877 size.height = 2 * GetCharacterHeight(FontSize::Normal);
878 break;
879 }
880
881 case WID_GO_HELP_TEXT:
882 size.height = NUM_DESCRIPTION_LINES * GetCharacterHeight(FontSize::Normal);
883 break;
884
887 size.width = std::max(GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_CATEGORY).width, GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_TYPE).width);
888 break;
889
890 default:
891 break;
892 }
893 }
894
895 void OnPaint() override
896 {
897 if (GameOptionsWindow::active_tab != WID_GO_TAB_ADVANCED) {
898 this->DrawWidgets();
899 return;
900 }
901
902 if (this->closing_dropdown) {
903 this->closing_dropdown = false;
904 assert(this->valuedropdown_entry != nullptr);
905 this->valuedropdown_entry->SetButtons({});
906 this->valuedropdown_entry = nullptr;
907 }
908
909 /* Reserve the correct number of lines for the 'some search results are hidden' notice in the central settings display panel. */
910 const Rect panel = this->GetWidget<NWidgetBase>(WID_GO_OPTIONSPANEL)->GetCurrentRect().Shrink(WidgetDimensions::scaled.frametext);
911 StringID warn_str = STR_CONFIG_SETTING_CATEGORY_HIDES - 1 + this->warn_missing;
912 int new_warn_lines;
913 if (this->warn_missing == WHR_NONE) {
914 new_warn_lines = 0;
915 } else {
916 new_warn_lines = GetStringLineCount(GetString(warn_str, _game_settings_restrict_dropdown[this->filter.min_cat]), panel.Width());
917 }
918 if (this->warn_lines != new_warn_lines) {
919 this->vscroll->SetCount(this->vscroll->GetCount() - this->warn_lines + new_warn_lines);
920 this->warn_lines = new_warn_lines;
921 }
922
923 this->DrawWidgets();
924
925 /* Draw the 'some search results are hidden' notice. */
926 if (this->warn_missing != WHR_NONE) {
928 GetString(warn_str, _game_settings_restrict_dropdown[this->filter.min_cat]),
929 TextColour::Black, {AlignmentH::Centre, AlignmentV::Middle});
930 }
931 }
932
933 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
934 {
936 if (BaseGraphics::GetUsedSet() == nullptr) return;
937
938 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_GRF_TEXTFILE), BaseGraphics::GetUsedSet(), STR_CONTENT_TYPE_BASE_GRAPHICS);
939 return;
940 }
942 if (BaseSounds::GetUsedSet() == nullptr) return;
943
944 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_SFX_TEXTFILE), BaseSounds::GetUsedSet(), STR_CONTENT_TYPE_BASE_SOUNDS);
945 return;
946 }
948 if (BaseMusic::GetUsedSet() == nullptr) return;
949
950 ShowBaseSetTextfileWindow(this, (TextfileType)(widget - WID_GO_BASE_MUSIC_TEXTFILE), BaseMusic::GetUsedSet(), STR_CONTENT_TYPE_BASE_MUSIC);
951 return;
952 }
953 switch (widget) {
956 case WID_GO_TAB_SOUND:
959 SndClickBeep();
960 this->SetTab(widget);
961 break;
962
964 switch (_settings_client.network.participate_survey) {
965 case ParticipateSurvey::Ask:
966 case ParticipateSurvey::No:
967 _settings_client.network.participate_survey = ParticipateSurvey::Yes;
968 break;
969
970 case ParticipateSurvey::Yes:
971 _settings_client.network.participate_survey = ParticipateSurvey::No;
972 break;
973 }
974
975 this->SetWidgetLoweredState(WID_GO_SURVEY_PARTICIPATE_BUTTON, _settings_client.network.participate_survey == ParticipateSurvey::Yes);
978 break;
979
981 OpenBrowser(NETWORK_SURVEY_DETAILS_LINK);
982 break;
983
986 break;
987
988 case WID_GO_FULLSCREEN_BUTTON: // Click fullscreen on/off
989 /* try to toggle full-screen on/off */
990 if (!ToggleFullScreen(!_fullscreen)) {
991 ShowErrorMessage(GetEncodedString(STR_ERROR_FULLSCREEN_FAILED), {}, WarningLevel::Error);
992 }
996 break;
997
1000 ShowErrorMessage(GetEncodedString(STR_GAME_OPTIONS_VIDEO_ACCELERATION_RESTART), {}, WarningLevel::Info);
1004#ifndef __APPLE__
1009#endif
1010 break;
1011
1013 if (!_video_hw_accel) break;
1014
1017
1023 break;
1024
1026 _settings_client.gui.scale_bevels = !_settings_client.gui.scale_bevels;
1027
1029 this->SetDirty();
1030
1032 ReInitAllWindows(true);
1033 break;
1034 }
1035
1036#ifdef HAS_TRUETYPE_FONT
1038 _fcsettings.prefer_sprite = !_fcsettings.prefer_sprite;
1039
1040 this->SetWidgetLoweredState(WID_GO_GUI_FONT_SPRITE, _fcsettings.prefer_sprite);
1041 this->SetWidgetDisabledState(WID_GO_GUI_FONT_AA, _fcsettings.prefer_sprite);
1042 this->SetDirty();
1043
1049 ReInitAllWindows(true);
1050 break;
1051
1052 case WID_GO_GUI_FONT_AA:
1053 _fcsettings.global_aa = !_fcsettings.global_aa;
1054
1055 this->SetWidgetLoweredState(WID_GO_GUI_FONT_AA, _fcsettings.global_aa);
1057
1059 break;
1060#endif /* HAS_TRUETYPE_FONT */
1061
1062 case WID_GO_GUI_SCALE:
1063 /* Any click on the slider deactivates automatic interface scaling, setting it to the current value before being adjusted. */
1064 if (_gui_scale_cfg == -1) {
1065 _gui_scale_cfg = this->gui_scale;
1069 }
1070
1071 if (ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, _ctrl_pressed ? 0 : SCALE_NMARKS, this->gui_scale)) {
1072 this->gui_scale_changed = true;
1073 this->SetWidgetDirty(widget);
1074 }
1075
1076 if (click_count > 0) this->mouse_capture_widget = widget;
1077 break;
1078
1080 {
1081 if (_gui_scale_cfg == -1) {
1082 _gui_scale_cfg = this->previous_gui_scale; // Load the previous GUI scale
1084 if (AdjustGUIZoom(false)) ReInitAllWindows(true);
1085 this->gui_scale = _gui_scale;
1086 } else {
1087 this->previous_gui_scale = _gui_scale; // Set the previous GUI scale value as the current one
1088 _gui_scale_cfg = -1;
1090 if (AdjustGUIZoom(false)) ReInitAllWindows(true);
1091 this->gui_scale = _gui_scale;
1092 }
1093 this->SetWidgetDirty(widget);
1095 break;
1096 }
1097
1099 auto *used_set = BaseGraphics::GetUsedSet();
1100 if (used_set == nullptr || !used_set->IsConfigurable()) break;
1101 GRFConfig &extra_cfg = used_set->GetOrCreateExtraConfig();
1102 if (extra_cfg.param.empty()) extra_cfg.SetParameterDefaults();
1103 OpenGRFParameterWindow(true, extra_cfg, _game_mode == GameMode::Menu);
1104 if (_game_mode == GameMode::Menu) this->reload = true;
1105 break;
1106 }
1107
1110 uint8_t &vol = (widget == WID_GO_BASE_MUSIC_VOLUME) ? _settings_client.music.music_vol : _settings_client.music.effect_vol;
1111 if (ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, 0, INT8_MAX, 0, vol)) {
1112 if (widget == WID_GO_BASE_MUSIC_VOLUME) {
1114 } else {
1115 SetEffectVolume(vol);
1116 }
1117 this->SetWidgetDirty(widget);
1118 SetWindowClassesDirty(WindowClass::Music);
1119 }
1120
1121 if (click_count > 0) this->mouse_capture_widget = widget;
1122 break;
1123 }
1124
1126 ShowMusicWindow();
1127 break;
1128 }
1129
1131 if (BaseGraphics::GetUsedSet() == nullptr || BaseGraphics::GetUsedSet()->url.empty()) return;
1132 OpenBrowser(BaseGraphics::GetUsedSet()->url);
1133 break;
1134
1136 if (BaseSounds::GetUsedSet() == nullptr || BaseSounds::GetUsedSet()->url.empty()) return;
1137 OpenBrowser(BaseSounds::GetUsedSet()->url);
1138 break;
1139
1141 if (BaseMusic::GetUsedSet() == nullptr || BaseMusic::GetUsedSet()->url.empty()) return;
1142 OpenBrowser(BaseMusic::GetUsedSet()->url);
1143 break;
1144
1147 break;
1148
1151 break;
1152
1155 break;
1156
1160 int selected;
1161 DropDownList list = this->BuildDropDownList(widget, &selected);
1162 if (!list.empty()) {
1163 ShowDropDownList(this, std::move(list), selected, widget);
1164 } else {
1165 if (widget == WID_GO_RESOLUTION_DROPDOWN) ShowErrorMessage(GetEncodedString(STR_ERROR_RESOLUTION_LIST_FAILED), {}, WarningLevel::Error);
1166 }
1167 break;
1168 }
1169
1175 int selected;
1176 DropDownList list = this->BuildDropDownList(widget, &selected);
1177 if (!list.empty()) {
1178 ShowDropDownList(this, std::move(list), selected, widget, 0, DropDownOption::Filterable);
1179 } else {
1180 if (widget == WID_GO_RESOLUTION_DROPDOWN) ShowErrorMessage(GetEncodedString(STR_ERROR_RESOLUTION_LIST_FAILED), {}, WarningLevel::Error);
1181 }
1182 break;
1183 }
1184
1185 case WID_GO_EXPAND_ALL:
1186 this->manually_changed_folding = true;
1188 this->InvalidateData();
1189 break;
1190
1192 this->manually_changed_folding = true;
1194 this->InvalidateData();
1195 break;
1196
1197 case WID_GO_RESET_ALL:
1198 ShowQuery(
1199 GetEncodedString(STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_CAPTION),
1200 GetEncodedString(STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_TEXT),
1201 this,
1203 );
1204 break;
1205
1207 int selected;
1208 DropDownList list = this->BuildDropDownList(widget, &selected);
1209 if (!list.empty()) {
1210 ShowDropDownList(this, std::move(list), this->filter.mode, widget);
1211 }
1212 break;
1213 }
1214
1215 case WID_GO_TYPE_DROPDOWN: {
1216 int selected;
1217 DropDownList list = this->BuildDropDownList(widget, &selected);
1218 if (!list.empty()) {
1219 ShowDropDownList(this, std::move(list), this->filter.type, widget);
1220 }
1221 break;
1222 }
1223
1225 OptionsPanelClick(pt);
1226 break;
1227 }
1228 }
1229
1230 void OptionsPanelClick(Point pt)
1231 {
1232 int32_t btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GO_OPTIONSPANEL, WidgetDimensions::scaled.framerect.top);
1233 if (btn == INT32_MAX || btn < this->warn_lines) return;
1234 btn -= this->warn_lines;
1235
1236 uint cur_row = 0;
1238
1239 if (clicked_entry == nullptr) return; // Clicked below the last setting of the page
1240
1242 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
1243 if (x < 0) return; // Clicked left of the entry
1244
1245 SettingsPage *clicked_page = dynamic_cast<SettingsPage*>(clicked_entry);
1246 if (clicked_page != nullptr) {
1247 this->SetDisplayedHelpText(nullptr);
1248 clicked_page->folded = !clicked_page->folded; // Flip 'folded'-ness of the sub-page
1249
1250 this->manually_changed_folding = true;
1251
1252 this->InvalidateData();
1253 return;
1254 }
1255
1256 SettingEntry *pe = dynamic_cast<SettingEntry*>(clicked_entry);
1257 assert(pe != nullptr);
1258 const IntSettingDesc *sd = pe->setting;
1259
1260 /* return if action is only active in network, or only settable by server */
1261 if (!sd->IsEditable()) {
1262 this->SetDisplayedHelpText(pe);
1263 return;
1264 }
1265
1266 auto [min_val, max_val] = sd->GetRange();
1267 int32_t value = sd->Read(ResolveObject(settings_ptr, sd));
1268
1269 /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
1270 if (x < SETTING_BUTTON_WIDTH && sd->flags.Test(SettingFlag::GuiDropdown)) {
1271 this->SetDisplayedHelpText(pe);
1272
1273 if (this->valuedropdown_entry == pe) {
1274 /* unclick the dropdown */
1275 this->CloseChildWindows(WindowClass::DropdownMenu);
1276 this->closing_dropdown = false;
1277 this->valuedropdown_entry->SetButtons({});
1278 this->valuedropdown_entry = nullptr;
1279 } else {
1280 if (this->valuedropdown_entry != nullptr) this->valuedropdown_entry->SetButtons({});
1281 this->closing_dropdown = false;
1282
1283 int rel_y = (pt.y - wid->pos_y - WidgetDimensions::scaled.framerect.top) % wid->resize_y;
1284
1285 Rect wi_rect;
1286 wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
1287 wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
1288 wi_rect.top = pt.y - rel_y + (BaseSettingEntry::line_height - SETTING_BUTTON_HEIGHT) / 2;
1289 wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
1290
1291 /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
1292 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
1293 this->valuedropdown_entry = pe;
1295
1296 DropDownList list;
1297 for (int32_t i = min_val; i <= static_cast<int32_t>(max_val); i++) {
1298 auto [param1, param2] = sd->GetValueParams(i);
1299 list.push_back(MakeDropDownListStringItem(GetString(STR_JUST_STRING1, param1, param2), i));
1300 }
1301
1302 ShowDropDownListAt(this, std::move(list), value, WID_GO_SETTING_DROPDOWN, wi_rect, Colours::Orange);
1303 }
1304 }
1305 this->SetDirty();
1306 } else if (x < SETTING_BUTTON_WIDTH) {
1307 this->SetDisplayedHelpText(pe);
1308 int32_t oldvalue = value;
1309
1310 if (sd->IsBoolSetting()) {
1311 value ^= 1;
1312 } else {
1313 /* Add a dynamic step-size to the scroller. In a maximum of
1314 * 50-steps you should be able to get from min to max,
1315 * unless specified otherwise in the 'interval' variable
1316 * of the current setting. */
1317 uint32_t step = (sd->interval == 0) ? ((max_val - min_val) / 50) : sd->interval;
1318 if (step == 0) step = 1;
1319
1320 /* don't allow too fast scrolling */
1321 if (this->flags.Test(WindowFlag::Timeout) && this->timeout_timer > 1) {
1322 _left_button_clicked = false;
1323 return;
1324 }
1325
1326 /* Increase or decrease the value and clamp it to extremes */
1327 if (x >= SETTING_BUTTON_WIDTH / 2) {
1328 value += step;
1329 if (min_val < 0) {
1330 assert(static_cast<int32_t>(max_val) >= 0);
1331 if (value > static_cast<int32_t>(max_val)) value = static_cast<int32_t>(max_val);
1332 } else {
1333 if (static_cast<uint32_t>(value) > max_val) value = static_cast<int32_t>(max_val);
1334 }
1335 if (value < min_val) value = min_val; // skip between "disabled" and minimum
1336 } else {
1337 value -= step;
1338 if (value < min_val) value = sd->flags.Test(SettingFlag::GuiZeroIsSpecial) ? 0 : min_val;
1339 }
1340
1341 /* Set up scroller timeout for numeric values */
1342 if (value != oldvalue) {
1343 if (this->clicked_entry != nullptr) { // Release previous buttons if any
1344 this->clicked_entry->SetButtons({});
1345 }
1346 this->clicked_entry = pe;
1348 this->SetTimeout();
1349 _left_button_clicked = false;
1350 }
1351 }
1352
1353 if (value != oldvalue) {
1354 SetSettingValue(sd, value);
1355 this->SetDirty();
1356 }
1357 } else {
1358 /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
1359 if (this->last_clicked == pe && !sd->IsBoolSetting() && !sd->flags.Test(SettingFlag::GuiDropdown)) {
1360 int64_t value64 = value;
1361 /* Show the correct currency-translated value */
1362 if (sd->flags.Test(SettingFlag::GuiCurrency)) value64 *= GetCurrency().rate;
1363
1364 CharSetFilter charset_filter = CS_NUMERAL; //default, only numeric input allowed
1365 if (min_val < 0) charset_filter = CS_NUMERAL_SIGNED; // special case, also allow '-' sign for negative input
1366
1367 this->valuewindow_entry = pe;
1368 /* Limit string length to 14 so that MAX_INT32 * max currency rate doesn't exceed MAX_INT64. */
1369 ShowQueryString(GetString(STR_JUST_INT, value64), STR_CONFIG_SETTING_QUERY_CAPTION, 15, this, charset_filter, QueryStringFlag::EnableDefault);
1370 }
1371 this->SetDisplayedHelpText(pe);
1372 }
1373 }
1374
1375 void OnTimeout() override
1376 {
1377 if (this->clicked_entry != nullptr) { // On timeout, release any depressed buttons
1378 this->clicked_entry->SetButtons({});
1379 this->clicked_entry = nullptr;
1380 this->SetDirty();
1381 }
1382 }
1383
1384 void OnQueryTextFinished(std::optional<std::string> str) override
1385 {
1386 /* The user pressed cancel */
1387 if (!str.has_value()) return;
1388
1389 assert(this->valuewindow_entry != nullptr);
1390 const IntSettingDesc *sd = this->valuewindow_entry->setting;
1391
1392 int32_t value;
1393 if (!str->empty()) {
1394 auto llvalue = ParseInteger<int64_t>(*str, 10, true);
1395 if (!llvalue.has_value()) return;
1396
1397 /* Save the correct currency-translated value */
1398 if (sd->flags.Test(SettingFlag::GuiCurrency)) llvalue = *llvalue / GetCurrency().rate;
1399
1400 value = ClampTo<int32_t>(*llvalue);
1401 } else {
1402 value = sd->GetDefaultValue();
1403 }
1404
1405 SetSettingValue(this->valuewindow_entry->setting, value);
1406 this->SetDirty();
1407 }
1408
1409 void OnMouseLoop() override
1410 {
1411 if (_left_button_down || !this->gui_scale_changed) return;
1412
1413 this->gui_scale_changed = false;
1414 _gui_scale_cfg = this->gui_scale;
1415
1416 if (AdjustGUIZoom(false)) {
1417 ReInitAllWindows(true);
1419 this->SetDirty();
1420 }
1421 }
1422
1423 void OnDropdownSelect(WidgetID widget, int index, int) override
1424 {
1425 switch (widget) {
1426 case WID_GO_CURRENCY_DROPDOWN: { // Currency
1427 Currency currency = static_cast<Currency>(index);
1428 if (currency == Currency::Custom) ShowCustCurrency();
1429 this->opt->locale.currency = currency;
1430 ReInitAllWindows(false);
1431 break;
1432 }
1433
1434 case WID_GO_AUTOSAVE_DROPDOWN: // Autosave options
1435 _settings_client.gui.autosave_interval = _autosave_dropdown_to_minutes[index];
1437 this->SetDirty();
1438 break;
1439
1440 case WID_GO_LANG_DROPDOWN: // Change interface language
1442 CloseWindowByClass(WindowClass::QueryString);
1444 ClearAllCachedNames();
1446 CheckBlitter();
1447 ReInitAllWindows(false);
1448 break;
1449
1450 case WID_GO_RESOLUTION_DROPDOWN: // Change resolution
1451 if ((uint)index < _resolutions.size() && ChangeResInGame(_resolutions[index].width, _resolutions[index].height)) {
1452 this->SetDirty();
1453 }
1454 break;
1455
1457 _settings_client.gui.refresh_rate = *std::next(_refresh_rates.begin(), index);
1458 if (_settings_client.gui.refresh_rate > 60) {
1459 /* Show warning to the user that this refresh rate might not be suitable on
1460 * larger maps with many NewGRFs and vehicles. */
1461 ShowErrorMessage(GetEncodedString(STR_GAME_OPTIONS_REFRESH_RATE_WARNING), {}, WarningLevel::Info);
1462 }
1463 break;
1464 }
1465
1467 if (_game_mode == GameMode::Menu) {
1468 CloseWindowByClass(WindowClass::NewGRFParameters);
1469 auto set = BaseGraphics::GetSet(index);
1471 this->reload = true;
1472 this->InvalidateData();
1473 }
1474 break;
1475
1477 ChangeSoundSet(index);
1478 break;
1479
1481 ChangeMusicSet(index);
1482 break;
1483
1485 this->filter.mode = (RestrictionMode)index;
1486 if (this->filter.mode == RM_CHANGED_AGAINST_DEFAULT ||
1487 this->filter.mode == RM_CHANGED_AGAINST_NEW) {
1488
1489 if (!this->manually_changed_folding) {
1490 /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
1491 GetSettingsTree().UpdateFilterState(this->filter, false);
1493 }
1494 } else {
1495 /* Non-'changes' filter. Save as default. */
1496 _settings_client.gui.settings_restriction_mode = this->filter.mode;
1497 }
1498 this->InvalidateData();
1499 break;
1500
1502 this->filter.type = (SettingType)index;
1503 this->InvalidateData();
1504 break;
1505
1507 /* Deal with drop down boxes on the panel. */
1508 assert(this->valuedropdown_entry != nullptr);
1509 const IntSettingDesc *sd = this->valuedropdown_entry->setting;
1510 assert(sd->flags.Test(SettingFlag::GuiDropdown));
1511
1512 SetSettingValue(sd, index);
1513 this->SetDirty();
1514 break;
1515 }
1516 }
1517
1518 void OnDropdownClose(Point pt, WidgetID widget, int index, int click_result, bool instant_close) override
1519 {
1520 if (widget != WID_GO_SETTING_DROPDOWN) {
1521 /* Normally the default implementation of OnDropdownClose() takes care of
1522 * a few things. We want that behaviour here too, but only for
1523 * "normal" dropdown boxes. The special dropdown boxes added for every
1524 * setting that needs one can't have this call. */
1525 Window::OnDropdownClose(pt, widget, index, click_result, instant_close);
1526 } else {
1527 /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
1528 * the same dropdown button was clicked again, and then not open the dropdown again.
1529 * So, we only remember that it was closed, and process it on the next OnPaint, which is
1530 * after OnClick. */
1531 assert(this->valuedropdown_entry != nullptr);
1532 this->closing_dropdown = true;
1533 this->SetDirty();
1534 }
1535 }
1536
1542 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1543 {
1544 if (!gui_scope) return;
1545 this->SetWidgetLoweredState(WID_GO_SURVEY_PARTICIPATE_BUTTON, _settings_client.network.participate_survey == ParticipateSurvey::Yes);
1549
1550#ifndef __APPLE__
1553#endif
1554
1557#ifdef HAS_TRUETYPE_FONT
1558 this->SetWidgetLoweredState(WID_GO_GUI_FONT_SPRITE, _fcsettings.prefer_sprite);
1559 this->SetWidgetLoweredState(WID_GO_GUI_FONT_AA, _fcsettings.global_aa);
1560 this->SetWidgetDisabledState(WID_GO_GUI_FONT_AA, _fcsettings.prefer_sprite);
1561#endif /* HAS_TRUETYPE_FONT */
1562
1564
1566
1570
1571 for (TextfileType tft : EnumRange(TFT_CONTENT_BEGIN, TFT_CONTENT_END)) {
1575 }
1576
1578
1579 /* Update which settings are to be visible. */
1580 RestrictionMode min_level = (this->filter.mode <= RM_ALL) ? this->filter.mode : RM_BASIC;
1581 this->filter.min_cat = min_level;
1582 this->filter.type_hides = false;
1583 GetSettingsTree().UpdateFilterState(this->filter, false);
1584
1585 if (this->filter.string.IsEmpty()) {
1586 this->warn_missing = WHR_NONE;
1587 } else if (min_level < this->filter.min_cat) {
1588 this->warn_missing = this->filter.type_hides ? WHR_CATEGORY_TYPE : WHR_CATEGORY;
1589 } else {
1590 this->warn_missing = this->filter.type_hides ? WHR_TYPE : WHR_NONE;
1591 }
1592 this->vscroll->SetCount(GetSettingsTree().Length() + this->warn_lines);
1593
1594 if (this->last_clicked != nullptr && !GetSettingsTree().IsVisible(this->last_clicked)) {
1595 this->SetDisplayedHelpText(nullptr);
1596 }
1597
1598 bool all_folded = true;
1599 bool all_unfolded = true;
1600 GetSettingsTree().GetFoldingState(all_folded, all_unfolded);
1601 this->SetWidgetDisabledState(WID_GO_EXPAND_ALL, all_unfolded);
1603 }
1604
1605 void OnEditboxChanged(WidgetID wid) override
1606 {
1607 if (wid == WID_GO_FILTER) {
1608 this->filter.string.SetFilterTerm(this->filter_editbox.text.GetText());
1609 if (!this->filter.string.IsEmpty() && !this->manually_changed_folding) {
1610 /* User never expanded/collapsed single pages and entered a filter term.
1611 * Expand everything, to save weird expand clicks, */
1613 }
1614 this->InvalidateData();
1615 }
1616 }
1617};
1618
1619static constexpr std::initializer_list<NWidgetPart> _nested_game_options_widgets = {
1622 NWidget(WWT_CAPTION, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1624 EndContainer(),
1627 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),
1628 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),
1629 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),
1630 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),
1631 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),
1632 EndContainer(),
1633 EndContainer(),
1636 /* General tab */
1640 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_LANG_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_LANGUAGE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1641 EndContainer(),
1642
1644 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_AUTOSAVE_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1645 EndContainer(),
1646
1647 NWidget(WWT_FRAME, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_CURRENCY_UNITS_FRAME), SetTextStyle(GAME_OPTIONS_FRAME),
1648 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_CURRENCY_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_CURRENCY_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1649 EndContainer(),
1650
1652 NWidget(WWT_FRAME, GAME_OPTIONS_BACKGROUND), SetStringTip(STR_GAME_OPTIONS_PARTICIPATE_SURVEY_FRAME), SetTextStyle(GAME_OPTIONS_FRAME), SetPIP(0, WidgetDimensions::unscaled.vsep_sparse, 0),
1656 EndContainer(),
1658 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),
1659 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),
1660 EndContainer(),
1661 EndContainer(),
1662 EndContainer(),
1663 EndContainer(),
1664 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1665 EndContainer(),
1666
1667 /* Graphics tab */
1673 NWidget(WWT_TEXT, Colours::Invalid), SetStringTip(STR_GAME_OPTIONS_GUI_SCALE_FRAME), SetTextStyle(GAME_OPTIONS_LABEL),
1674 NWidget(WWT_EMPTY, Colours::Invalid, WID_GO_GUI_SCALE), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FontSize::Small), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_GAME_OPTIONS_GUI_SCALE_TOOLTIP),
1675 EndContainer(),
1679 EndContainer(),
1683 EndContainer(),
1684#ifdef HAS_TRUETYPE_FONT
1688 EndContainer(),
1692 EndContainer(),
1693#endif /* HAS_TRUETYPE_FONT */
1694 EndContainer(),
1695 EndContainer(),
1696
1700 NWidget(WWT_TEXT, Colours::Invalid), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_RESOLUTION), SetTextStyle(GAME_OPTIONS_LABEL),
1701 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_RESOLUTION_DROPDOWN), SetFill(1, 0), SetToolTip(STR_GAME_OPTIONS_RESOLUTION_TOOLTIP),
1702 EndContainer(),
1704 NWidget(WWT_TEXT, Colours::Invalid), SetFill(1, 0), SetResize(1, 0), SetStringTip(STR_GAME_OPTIONS_REFRESH_RATE), SetTextStyle(GAME_OPTIONS_LABEL),
1705 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_REFRESH_RATE_DROPDOWN), SetFill(1, 0), SetToolTip(STR_GAME_OPTIONS_REFRESH_RATE_TOOLTIP),
1706 EndContainer(),
1710 EndContainer(),
1714 EndContainer(),
1715#ifndef __APPLE__
1719 EndContainer(),
1720#endif
1723 EndContainer(),
1724 EndContainer(),
1725 EndContainer(),
1726
1729 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_GRF_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1731 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_GRF_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1732 EndContainer(),
1733 NWidget(WWT_TEXT, Colours::Invalid, WID_GO_BASE_GRF_DESCRIPTION), SetStringTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_GRF_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1736 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),
1737 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),
1738 EndContainer(),
1740 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),
1741 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),
1742 EndContainer(),
1743 EndContainer(),
1744 EndContainer(),
1745 EndContainer(),
1746 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1747 EndContainer(),
1748
1749 /* Sound/Music tab */
1755 NWidget(WWT_EMPTY, Colours::Invalid, WID_GO_BASE_SFX_VOLUME), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FontSize::Small), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1756 EndContainer(),
1759 NWidget(WWT_EMPTY, Colours::Invalid, WID_GO_BASE_MUSIC_VOLUME), SetMinimalTextLines(1, 12 + WidgetDimensions::unscaled.vsep_normal, FontSize::Small), SetFill(1, 0), SetResize(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
1760 EndContainer(),
1761 EndContainer(),
1762
1765 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_SFX_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1766 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_SFX_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1767 EndContainer(),
1768 NWidget(WWT_EMPTY, Colours::Invalid, WID_GO_BASE_SFX_DESCRIPTION), SetMinimalTextLines(1, 0), SetToolTip(STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1771 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),
1772 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),
1773 EndContainer(),
1775 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),
1776 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),
1777 EndContainer(),
1778 EndContainer(),
1779 EndContainer(),
1780
1783 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_DROPDOWN), SetToolTip(STR_GAME_OPTIONS_BASE_MUSIC_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1784 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_BASE_MUSIC_CONTENT_DOWNLOAD), SetStringTip(STR_GAME_OPTIONS_ONLINE_CONTENT, STR_GAME_OPTIONS_ONLINE_CONTENT_TOOLTIP),
1785 EndContainer(),
1787 NWidget(WWT_EMPTY, Colours::Invalid, WID_GO_BASE_MUSIC_DESCRIPTION), SetMinimalTextLines(1, 0), SetToolTip(STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1790 EndContainer(),
1791 EndContainer(),
1794 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),
1795 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),
1796 EndContainer(),
1798 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),
1799 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),
1800 EndContainer(),
1801 EndContainer(),
1802 EndContainer(),
1803 EndContainer(),
1804 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1805 EndContainer(),
1806
1807 /* Social tab */
1810 NWidget(NWID_SPACER), SetFill(1, 1), SetResize(1, 1), // Allows this pane to resize
1811 EndContainer(),
1812
1813 /* Advanced settings tab */
1818 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_RESTRICT_DROPDOWN), SetToolTip(STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
1819 EndContainer(),
1822 NWidget(WWT_DROPDOWN, GAME_OPTIONS_BUTTON, WID_GO_TYPE_DROPDOWN), SetToolTip(STR_CONFIG_SETTING_TYPE_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
1823 EndContainer(),
1825 NWidget(WWT_TEXT, Colours::Invalid), SetFill(0, 1), SetStringTip(STR_CONFIG_SETTING_FILTER_TITLE), SetTextStyle(GAME_OPTIONS_LABEL),
1826 NWidget(WWT_EDITBOX, GAME_OPTIONS_BACKGROUND, WID_GO_FILTER), SetStringTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
1827 EndContainer(),
1828 EndContainer(),
1829
1832 EndContainer(),
1834 EndContainer(),
1835
1837 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_EXPAND_ALL), SetStringTip(STR_CONFIG_SETTING_EXPAND_ALL), SetFill(1, 0), SetResize(1, 0),
1838 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_COLLAPSE_ALL), SetStringTip(STR_CONFIG_SETTING_COLLAPSE_ALL), SetFill(1, 0), SetResize(1, 0),
1839 NWidget(WWT_PUSHTXTBTN, GAME_OPTIONS_BUTTON, WID_GO_RESET_ALL), SetStringTip(STR_CONFIG_SETTING_RESET_ALL), SetFill(1, 0), SetResize(1, 0),
1840 EndContainer(),
1841
1846 EndContainer(),
1847 EndContainer(),
1848 EndContainer(),
1849
1851 NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
1853 EndContainer(),
1854 EndContainer(),
1855};
1856
1859 WindowPosition::Center, "game_options", 0, 0,
1860 WindowClass::GameOptions, WindowClass::None,
1861 {},
1862 _nested_game_options_widgets
1863);
1864
1867{
1868 CloseWindowByClass(WindowClass::GameOptions);
1870}
1871
1881void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
1882{
1883 PixelColour colour = GetColourGradient(button_colour, Shade::Darker);
1884 Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
1885
1886 Rect lr = {x, y, x + (int)dim.width - 1, y + (int)dim.height - 1};
1887 Rect rr = {x + (int)dim.width, y, x + (int)dim.width * 2 - 1, y + (int)dim.height - 1};
1888
1889 DrawFrameRect(lr, button_colour, (state == 1) ? FrameFlag::Lowered : FrameFlags{});
1890 DrawFrameRect(rr, button_colour, (state == 2) ? FrameFlag::Lowered : FrameFlags{});
1893
1894 /* Grey out the buttons that aren't clickable */
1895 bool rtl = _current_text_dir == TD_RTL;
1896 if (rtl ? !clickable_right : !clickable_left) {
1898 }
1899 if (rtl ? !clickable_left : !clickable_right) {
1901 }
1902}
1903
1913void DrawUpDownButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_up, bool clickable_down)
1914{
1915 PixelColour colour = GetColourGradient(button_colour, Shade::Darker);
1916
1917 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1920
1921 DrawFrameRect(ur, button_colour, (state == 1) ? FrameFlag::Lowered : FrameFlags{});
1922 DrawFrameRect(dr, button_colour, (state == 2) ? FrameFlag::Lowered : FrameFlags{});
1925
1926 /* Grey out the buttons that aren't clickable */
1927 if (!clickable_up) GfxFillRect(ur.Shrink(WidgetDimensions::scaled.bevel), colour, FillRectMode::Checker);
1928 if (!clickable_down) GfxFillRect(dr.Shrink(WidgetDimensions::scaled.bevel), colour, FillRectMode::Checker);
1929}
1930
1939void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
1940{
1941 PixelColour colour = GetColourGradient(button_colour, Shade::Darker);
1942
1943 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1944
1945 DrawFrameRect(r, button_colour, state ? FrameFlag::Lowered : FrameFlags{});
1947
1948 if (!clickable) {
1950 }
1951}
1952
1962void DrawBoolButton(int x, int y, Colours button_colour, Colours background, bool state, bool clickable)
1963{
1964 Rect r = {x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1};
1966 if (!clickable) {
1968 }
1969
1970 Rect button_rect = r.WithWidth(SETTING_BUTTON_WIDTH / 3, state ^ (_current_text_dir == TD_RTL));
1971 DrawFrameRect(button_rect, button_colour, {});
1972 if (!clickable) {
1974 }
1975}
1976
1977struct CustomCurrencyWindow : Window {
1978 WidgetID query_widget{};
1979
1980 CustomCurrencyWindow(WindowDesc &desc) : Window(desc)
1981 {
1982 this->InitNested();
1983
1984 SetButtonState();
1985 }
1986
1987 void SetButtonState()
1988 {
1990 this->SetWidgetDisabledState(WID_CC_RATE_UP, GetCustomCurrency().rate == UINT16_MAX);
1993 }
1994
1995 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1996 {
1997 switch (widget) {
1998 case WID_CC_RATE: return GetString(STR_CURRENCY_EXCHANGE_RATE, 1, 1);
1999 case WID_CC_SEPARATOR: return GetString(STR_CURRENCY_SEPARATOR, GetCustomCurrency().separator);
2000 case WID_CC_PREFIX: return GetString(STR_CURRENCY_PREFIX, GetCustomCurrency().prefix);
2001 case WID_CC_SUFFIX: return GetString(STR_CURRENCY_SUFFIX, GetCustomCurrency().suffix);
2002 case WID_CC_YEAR:
2003 return GetString((GetCustomCurrency().to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER, GetCustomCurrency().to_euro);
2004
2005 case WID_CC_PREVIEW:
2006 return GetString(STR_CURRENCY_PREVIEW, 10000);
2007
2008 default:
2009 return this->Window::GetWidgetString(widget, stringid);
2010 }
2011 }
2012
2013 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
2014 {
2015 switch (widget) {
2016 /* Set the appropriate width for the up/down buttons. */
2017 case WID_CC_RATE_DOWN:
2018 case WID_CC_RATE_UP:
2019 case WID_CC_YEAR_DOWN:
2020 case WID_CC_YEAR_UP:
2021 size = maxdim(size, {(uint)SETTING_BUTTON_WIDTH / 2, (uint)SETTING_BUTTON_HEIGHT});
2022 break;
2023
2024 /* Set the appropriate width for the edit buttons. */
2026 case WID_CC_PREFIX_EDIT:
2027 case WID_CC_SUFFIX_EDIT:
2028 size = maxdim(size, {(uint)SETTING_BUTTON_WIDTH, (uint)SETTING_BUTTON_HEIGHT});
2029 break;
2030
2031 /* Make sure the window is wide enough for the widest exchange rate */
2032 case WID_CC_RATE:
2033 size = GetStringBoundingBox(GetString(STR_CURRENCY_EXCHANGE_RATE, 1, INT32_MAX));
2034 break;
2035 }
2036 }
2037
2038 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
2039 {
2040 int line = 0;
2041 int len = 0;
2042 std::string str;
2044
2045 switch (widget) {
2046 case WID_CC_RATE_DOWN:
2047 if (GetCustomCurrency().rate > 1) GetCustomCurrency().rate--;
2048 if (GetCustomCurrency().rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
2050 break;
2051
2052 case WID_CC_RATE_UP:
2053 if (GetCustomCurrency().rate < UINT16_MAX) GetCustomCurrency().rate++;
2054 if (GetCustomCurrency().rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
2056 break;
2057
2058 case WID_CC_RATE:
2059 str = GetString(STR_JUST_INT, GetCustomCurrency().rate);
2060 len = 5;
2061 line = WID_CC_RATE;
2062 afilter = CS_NUMERAL;
2063 break;
2064
2066 case WID_CC_SEPARATOR:
2068 len = 7;
2069 line = WID_CC_SEPARATOR;
2070 break;
2071
2072 case WID_CC_PREFIX_EDIT:
2073 case WID_CC_PREFIX:
2074 str = GetCustomCurrency().prefix;
2075 len = 15;
2076 line = WID_CC_PREFIX;
2077 break;
2078
2079 case WID_CC_SUFFIX_EDIT:
2080 case WID_CC_SUFFIX:
2081 str = GetCustomCurrency().suffix;
2082 len = 15;
2083 line = WID_CC_SUFFIX;
2084 break;
2085
2086 case WID_CC_YEAR_DOWN:
2090 break;
2091
2092 case WID_CC_YEAR_UP:
2096 break;
2097
2098 case WID_CC_YEAR:
2099 str = GetString(STR_JUST_INT, GetCustomCurrency().to_euro);
2100 len = 7;
2101 line = WID_CC_YEAR;
2102 afilter = CS_NUMERAL;
2103 break;
2104 }
2105
2106 if (len != 0) {
2107 this->query_widget = line;
2108 ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, {});
2109 }
2110
2111 this->SetTimeout();
2112 this->SetDirty();
2113 }
2114
2115 void OnQueryTextFinished(std::optional<std::string> str) override
2116 {
2117 if (!str.has_value()) return;
2118
2119 switch (this->query_widget) {
2120 case WID_CC_RATE: {
2121 auto val = ParseInteger(*str, 10, true);
2122 if (!val.has_value()) return;
2123 GetCustomCurrency().rate = Clamp(*val, 1, UINT16_MAX);
2124 break;
2125 }
2126
2127 case WID_CC_SEPARATOR: // Thousands separator
2128 GetCustomCurrency().separator = std::move(*str);
2129 break;
2130
2131 case WID_CC_PREFIX:
2132 GetCustomCurrency().prefix = std::move(*str);
2133 break;
2134
2135 case WID_CC_SUFFIX:
2136 GetCustomCurrency().suffix = std::move(*str);
2137 break;
2138
2139 case WID_CC_YEAR: { // Year to switch to euro
2141 if (!str->empty()) {
2142 auto val = ParseInteger(*str, 10, true);
2143 if (!val.has_value()) return;
2145 }
2146 GetCustomCurrency().to_euro = year;
2147 break;
2148 }
2149 }
2151 SetButtonState();
2152 }
2153
2154 void OnTimeout() override
2155 {
2156 this->SetDirty();
2157 }
2158};
2159
2160static constexpr std::initializer_list<NWidgetPart> _nested_cust_currency_widgets = {
2163 NWidget(WWT_CAPTION, Colours::Grey), SetStringTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2164 EndContainer(),
2172 EndContainer(),
2173 NWidget(WWT_TEXT, Colours::Invalid, WID_CC_RATE), SetToolTip(STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
2174 EndContainer(),
2176 NWidget(WWT_PUSHBTN, Colours::DarkBlue, WID_CC_SEPARATOR_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
2177 NWidget(WWT_TEXT, Colours::Invalid, WID_CC_SEPARATOR), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
2178 EndContainer(),
2180 NWidget(WWT_PUSHBTN, Colours::DarkBlue, WID_CC_PREFIX_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
2181 NWidget(WWT_TEXT, Colours::Invalid, WID_CC_PREFIX), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
2182 EndContainer(),
2184 NWidget(WWT_PUSHBTN, Colours::DarkBlue, WID_CC_SUFFIX_EDIT), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
2185 NWidget(WWT_TEXT, Colours::Invalid, WID_CC_SUFFIX), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
2186 EndContainer(),
2189 NWidget(WWT_PUSHARROWBTN, Colours::Yellow, WID_CC_YEAR_DOWN), SetArrowWidgetTypeTip(ArrowWidgetType::Decrease, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2190 NWidget(WWT_PUSHARROWBTN, Colours::Yellow, WID_CC_YEAR_UP), SetArrowWidgetTypeTip(ArrowWidgetType::Increase, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2191 EndContainer(),
2192 NWidget(WWT_TEXT, Colours::Invalid, WID_CC_YEAR), SetToolTip(STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
2193 EndContainer(),
2194 EndContainer(),
2196 SetToolTip(STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP),
2197 EndContainer(),
2198 EndContainer(),
2199};
2200
2203 WindowPosition::Center, {}, 0, 0,
2204 WindowClass::CustomCurrenty, WindowClass::None,
2205 {},
2206 _nested_cust_currency_widgets
2207);
2208
2210static void ShowCustCurrency()
2211{
2212 CloseWindowById(WindowClass::CustomCurrenty, 0);
2214}
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.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Flip()
Flip all bits.
static const GraphicsSet * GetUsedSet()
static const GraphicsSet * GetSet(int index)
static bool SetSet(const GraphicsSet *set)
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Iterate a range of enum values.
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:1328
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:1544
Base class for a resizable nested widget.
bool UpdateVerticalSize(uint min_y)
Set absolute (post-scaling) minimal size of the widget.
Definition widget.cpp:1156
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).
void SetupSmallestSize(Window *w) override
Compute smallest size needed by the widget.
Definition widget.cpp:1754
static constexpr bool IsSurveyPossible()
Check whether a survey is possible.
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:2462
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:2536
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
StrongType::Typedef< int32_t, struct YearTag< struct Calendar >, StrongType::Compare, StrongType::Integer > Year
virtual std::string_view GetInfoString() const
Get some information about the selected driver/backend to be shown to the user.
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:42
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:95
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:28
Currencies GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition currency.cpp:128
EnumIndexArray< CurrencySpec, Currency, Currency::End > _currency_specs
Array of currencies used by the system.
Definition currency.cpp:80
Functions to handle different currencies.
CurrencySpec & GetCustomCurrency()
Get the custom currency.
const CurrencySpec & GetCurrency()
Get the currently selected currency.
static constexpr TimerGameCalendar::Year MIN_EURO_YEAR
The earliest year custom currencies may switch to the Euro.
Currency
This enum gives the currencies a unique id which must be maintained for savegame compatibility and in...
@ End
Always the last item.
@ Custom
Custom currency.
static constexpr TimerGameCalendar::Year CF_NOEURO
Currency never switches to the Euro (as far as known).
EnumBitSet< Currency, uint64_t, Currency::End > Currencies
Bitmask of Currency.
std::vector< Dimension > _resolutions
List of resolutions.
Definition driver.cpp:28
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, DropDownOptions options, std::string *const persistent_filter_text)
Show a drop down list.
Definition dropdown.cpp:570
std::unique_ptr< DropDownListItem > MakeDropDownListDividerItem()
Creates new DropDownListDividerItem.
Definition dropdown.cpp:36
std::unique_ptr< DropDownListItem > MakeDropDownListStringItem(StringID str, int value, bool masked, bool shaded)
Creates new DropDownListStringItem.
Definition dropdown.cpp:49
Dimension GetDropDownListDimension(const DropDownList &list)
Determine width and height required to fully display a DropDownList.
Definition dropdown.cpp:547
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options, std::string *const persistent_filter_text)
Show a drop down list.
Definition dropdown.cpp:587
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.
@ Filterable
Set if the dropdown is filterable.
#define T
Climate temperate.
Definition engines.h:91
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
Functions related to errors.
@ Info
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition error.h:24
@ Error
Errors (eg. saving/loading failed).
Definition error.h:26
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
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:88
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.
@ Centre
Align to the centre.
@ End
Align to the end, LTR/RTL aware.
@ Middle
Align to the middle.
bool DrawStringMultiLineWithClipping(int left, int right, int top, int bottom, std::string_view str, ExtendedTextColour colour, Alignment 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:872
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:716
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:971
int GetStringLineCount(std::string_view str, int maxw)
Calculates number of lines of string.
Definition gfx.cpp:740
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:899
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
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
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, ExtendedTextColour colour, Alignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition gfx.cpp:787
int DrawString(int left, int right, int top, std::string_view str, ExtendedTextColour colour, Alignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:668
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:1572
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition gfx.cpp:1836
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:324
void DrawSpriteIgnorePadding(SpriteID img, PaletteID pal, const Rect &r, Alignment align)
Draw a sprite within a Rect, ignoring the sprite's padding.
Definition widget.cpp:350
@ Small
Index of the small font in the font tables.
Definition gfx_type.h:250
@ Normal
Index of the normal font in the font tables.
Definition gfx_type.h:249
constexpr FontSizes FONTSIZES_ALL
Mask of all possible font sizes.
Definition gfx_type.h:262
Colours
One of 16 base colours used for companies and windows/widgets.
Definition gfx_type.h:283
@ Mauve
Mauve.
Definition gfx_type.h:295
@ Invalid
Invalid marker.
Definition gfx_type.h:302
@ Yellow
Yellow.
Definition gfx_type.h:288
@ DarkBlue
Dark blue.
Definition gfx_type.h:285
@ Orange
Orange.
Definition gfx_type.h:297
@ Grey
Grey.
Definition gfx_type.h:299
@ Green
Green.
Definition gfx_type.h:291
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:315
@ White
White colour.
Definition gfx_type.h:330
@ LightBlue
Light blue colour.
Definition gfx_type.h:331
@ Orange
Orange colour.
Definition gfx_type.h:324
@ Black
Black colour.
Definition gfx_type.h:334
@ Checker
Draw only every second pixel, used for greying-out.
Definition gfx_type.h:393
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 SetResizeWidgetTypeTip(ResizeWidgetType widget_type, StringID tip)
Widget part function for setting the resize widget type 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 SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FontSize::Normal)
Widget part function for setting the minimal text lines.
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:3419
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 SetTextStyle(TextColour colour, FontSize size=FontSize::Normal)
Widget part function for setting the text style.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetType widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart SetAlignment(Alignment 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:972
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1553
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:2051
#define Rect
Macro that prevents name conflicts between included headers.
#define Point
Macro that prevents name conflicts between included headers.
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
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
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:53
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=ContentType::End, ContentType type2=ContentType::End)
Show the content list window with a given set of content.
void ShowSurveyResultTextfileWindow(Window *parent)
Show the surver results as a text file.
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:1310
@ Menu
In the main menu.
Definition openttd.h:19
@ Menu
Switch to game intro menu.
Definition openttd.h:33
PixelColour GetColourGradient(Colours colour, Shade shade)
Get colour gradient palette index.
Definition palette.cpp:393
@ Darker
Darker colour shade.
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.
const void * ResolveObject(const GameSettings *settings_ptr, const IntSettingDesc *sd)
Resolve the underlying object where to dynamically load/save a setting to.
SettingsContainer & GetSettingsTree()
Construct settings tree.
Declarations of classes for handling display of individual configuration settings.
RestrictionMode
How the list of advanced settings is filtered.
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
@ RM_ALL
List all settings regardless of the default/newgame/... values.
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
@ RM_END
End for iteration.
@ RM_BASIC
Display settings associated to the "basic" list.
@ LeftDepressed
Of a numeric setting entry, the left button is depressed.
@ RightDepressed
Of a numeric setting entry, the right button is depressed.
bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
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 WindowDesc _cust_currency_desc(WindowPosition::Center, {}, 0, 0, WindowClass::CustomCurrenty, WindowClass::None, {}, _nested_cust_currency_widgets)
Window definition for the custom currency window.
static const uint32_t _autosave_dropdown_to_minutes[]
Available settings for autosave intervals.
static const int VOLUME_NMARKS
Show 5 values and 4 empty marks.
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...
static WindowDesc _game_options_desc(WindowPosition::Center, "game_options", 0, 0, WindowClass::GameOptions, WindowClass::None, {}, _nested_game_options_widgets)
Window definition for the game options window.
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 const int SCALE_NMARKS
Show marks at 25% increments.
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
Functions related to the horizontal slider widget.
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:254
void ChangeSoundSet(int index)
Change the configured sound set and reset sounds.
Definition sound.cpp:168
Functions related to sound.
static const SpriteID SPR_ARROW_RIGHT
Definition sprites.h:87
static const SpriteID SPR_IMG_MUSIC
Definition sprites.h:1267
static const SpriteID SPR_CIRCLE_FOLDED
(+) icon.
Definition sprites.h:96
static const SpriteID SPR_ARROW_LEFT
Definition sprites.h:86
static const SpriteID SPR_CIRCLE_UNFOLDED
(-) icon.
Definition sprites.h:97
static const SpriteID SPR_ARROW_DOWN
Definition sprites.h:84
static const SpriteID SPR_ARROW_UP
Definition sprites.h:85
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:2382
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:2299
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.
T y
Y coordinate.
T x
X coordinate.
Specification of a currency.
std::string separator
The thousands separator for this currency.
std::string prefix
Prefix to apply when formatting money in this currency.
TimerGameCalendar::Year to_euro
Year of switching to the Euro. May also be CF_NOEURO or CF_ISEURO.
std::string suffix
Suffix to apply when formatting money in this currency.
std::string code
3 letter untranslated code to identify the currency.
uint16_t rate
The conversion rate compared to the base currency.
StringID name
Translated name of this currency.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnTimeout() override
Called when this window's timeout has been reached.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
Dimensions (a width and height) of a rectangle in 2D.
Data about how and where to blit pixels.
Definition gfx_type.h:157
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.
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.
static int previous_gui_scale
Previous GUI scale.
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:502
int32_t GetDefaultValue() const
Get the default value of the setting.
Definition settings.cpp:493
StringID GetHelp() const
Get the help text of the setting.
Definition settings.cpp:461
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:471
int32_t Read(const void *object) const
Read the integer from the the actual setting.
Definition settings.cpp:593
int32_t interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
Currency currency
Currency we currently use.
Colour for pixel/line drawing.
Definition gfx_type.h:307
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.
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:920
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:937
Standard setting.
void SetButtons(SettingEntryFlags new_val)
Set the button-depressed flags (SettingsEntryFlag::LeftDepressed and SettingsEntryFlag::RightDepresse...
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.
std::string_view GetText() const
Get the current text.
Definition textbuf.cpp:284
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:172
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:984
void CloseChildWindows(WindowClass wc=WindowClass::Invalid) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1081
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1109
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1814
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:792
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing).
Definition window.cpp:3255
Window * parent
Parent window.
Definition window_gui.h:328
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:562
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:510
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
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:1804
void CloseChildWindowById(WindowClass wc, WindowNumber number) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1096
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
Definition window.cpp:491
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:290
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition window_gui.h:355
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1838
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:989
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:1828
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:319
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
@ BaseSounds
The content consists of base sounds.
@ BaseGraphics
The content consists of base graphics.
@ BaseMusic
The content consists of base music.
Stuff related to the text buffer GUI.
@ EnableDefault
enable the 'Default' button ("\0" is returned)
Definition textbuf_gui.h:20
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_CONTENT_END
This marker is used to generate the above three buttons in sequence by various of places in the code.
@ 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:308
void SetupWidgetDimensions()
Set up pre-scaled versions of Widget Dimensions.
Definition widget.cpp:98
@ 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:48
@ NWID_SPACER
Invisible widget that takes some space.
Definition widget_type.h:70
@ WWT_EDITBOX
a textbox for typing
Definition widget_type.h:62
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_CAPTION
Window caption (window title between closebox and stickybox).
Definition widget_type.h:52
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:76
@ WWT_BOOLBTN
Standard boolean toggle button.
Definition widget_type.h:46
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window).
Definition widget_type.h:60
@ WWT_FRAME
Frame.
Definition widget_type.h:51
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:37
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window).
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX).
Definition widget_type.h:56
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
@ WWT_TEXT
Pure simple text.
Definition widget_type.h:49
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
@ Decrease
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:20
@ Increase
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:21
@ HideBevel
Bevel of resize box is hidden.
Definition widget_type.h:29
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:1201
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition window.cpp:3432
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1214
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Definition window.cpp:3223
Window functions not directly related to making/drawing windows.
EnumBitSet< FrameFlag, uint8_t > FrameFlags
Bitset of FrameFlag elements.
Definition window_gui.h:32
@ BorderOnly
Draw border only, no background.
Definition window_gui.h:26
@ Lowered
If set the frame is lowered and the background colour brighter (ie. buttons when pressed).
Definition window_gui.h:27
@ Centred
Window is centered and shall stay centered after ReInit.
Definition window_gui.h:234
@ Timeout
Window timeout counter.
Definition window_gui.h:224
@ Center
Center the window.
Definition window_gui.h:147
int WidgetID
Widget ID.
Definition window_type.h:21
@ GameOptions
Game options.
Definition window_type.h:32
Functions related to zooming.