OpenTTD Source  12.0-beta2
settings_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "currency.h"
12 #include "error.h"
13 #include "settings_gui.h"
14 #include "textbuf_gui.h"
15 #include "command_func.h"
16 #include "network/network.h"
17 #include "town.h"
18 #include "settings_internal.h"
19 #include "strings_func.h"
20 #include "window_func.h"
21 #include "string_func.h"
22 #include "widgets/dropdown_type.h"
23 #include "widgets/dropdown_func.h"
24 #include "widgets/slider_func.h"
25 #include "highscore.h"
26 #include "base_media_base.h"
27 #include "company_base.h"
28 #include "company_func.h"
29 #include "viewport_func.h"
30 #include "core/geometry_func.hpp"
31 #include "ai/ai.hpp"
32 #include "blitter/factory.hpp"
33 #include "language.h"
34 #include "textfile_gui.h"
35 #include "stringfilter_type.h"
36 #include "querystring_gui.h"
37 #include "fontcache.h"
38 #include "zoom_func.h"
39 #include "rev.h"
40 #include "video/video_driver.hpp"
41 #include "music/music_driver.hpp"
42 
43 #include <vector>
44 #include <iterator>
45 
46 #include "safeguards.h"
47 #include "video/video_driver.hpp"
48 
49 
50 static const StringID _autosave_dropdown[] = {
51  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
52  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_1_MONTH,
53  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_3_MONTHS,
54  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_6_MONTHS,
55  STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_12_MONTHS,
57 };
58 
59 static const StringID _gui_zoom_dropdown[] = {
60  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_AUTO,
61  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_NORMAL,
62  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_2X_ZOOM,
63  STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_4X_ZOOM,
65 };
66 
67 static const StringID _font_zoom_dropdown[] = {
68  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_AUTO,
69  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_NORMAL,
70  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_2X_ZOOM,
71  STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_4X_ZOOM,
73 };
74 
76 
77 static const void *ResolveObject(const GameSettings *settings_ptr, const IntSettingDesc *sd);
78 
84 {
85  auto it = std::find(_resolutions.begin(), _resolutions.end(), Dimension(_screen.width, _screen.height));
86  return std::distance(_resolutions.begin(), it);
87 }
88 
89 static void ShowCustCurrency();
90 
91 template <class T>
92 static DropDownList BuildSetDropDownList(int *selected_index, bool allow_selection)
93 {
94  int n = T::GetNumSets();
95  *selected_index = T::GetIndexOfUsedSet();
96 
97  DropDownList list;
98  for (int i = 0; i < n; i++) {
99  list.emplace_back(new DropDownListCharStringItem(T::GetSet(i)->name, i, !allow_selection && (*selected_index != i)));
100  }
101 
102  return list;
103 }
104 
105 DropDownList BuildMusicSetDropDownList(int *selected_index)
106 {
107  return BuildSetDropDownList<BaseMusic>(selected_index, true);
108 }
109 
111 template <class TBaseSet>
113  const TBaseSet* baseset;
115 
117  {
118  const char *textfile = this->baseset->GetTextfile(file_type);
119  this->LoadTextfile(textfile, BASESET_DIR);
120  }
121 
122  void SetStringParameters(int widget) const override
123  {
124  if (widget == WID_TF_CAPTION) {
126  SetDParamStr(1, this->baseset->name);
127  }
128  }
129 };
130 
137 template <class TBaseSet>
138 void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet* baseset, StringID content_type)
139 {
140  CloseWindowById(WC_TEXTFILE, file_type);
141  new BaseSetTextfileWindow<TBaseSet>(file_type, baseset, content_type);
142 }
143 
144 std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 };
145 
151 {
152  /* Add the refresh rate as selected in the config. */
153  _refresh_rates.insert(_settings_client.gui.refresh_rate);
154 
155  /* Add all the refresh rates of all monitors connected to the machine. */
156  std::vector<int> monitorRates = VideoDriver::GetInstance()->GetListOfMonitorRefreshRates();
157  std::copy(monitorRates.begin(), monitorRates.end(), std::inserter(_refresh_rates, _refresh_rates.end()));
158 }
159 
161  GameSettings *opt;
162  bool reload;
163 
164  GameOptionsWindow(WindowDesc *desc) : Window(desc)
165  {
166  this->opt = &GetGameSettings();
167  this->reload = false;
168 
170 
172  this->OnInvalidateData(0);
173  }
174 
175  void Close() override
176  {
179  if (this->reload) _switch_mode = SM_MENU;
180  this->Window::Close();
181  }
182 
189  DropDownList BuildDropDownList(int widget, int *selected_index) const
190  {
191  DropDownList list;
192  switch (widget) {
193  case WID_GO_CURRENCY_DROPDOWN: { // Setup currencies dropdown
194  *selected_index = this->opt->locale.currency;
195  StringID *items = BuildCurrencyDropdown();
196  uint64 disabled = _game_mode == GM_MENU ? 0LL : ~GetMaskOfAllowedCurrencies();
197 
198  /* Add non-custom currencies; sorted naturally */
199  for (uint i = 0; i < CURRENCY_END; items++, i++) {
200  if (i == CURRENCY_CUSTOM) continue;
201  list.emplace_back(new DropDownListStringItem(*items, i, HasBit(disabled, i)));
202  }
203  std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
204 
205  /* Append custom currency at the end */
206  list.emplace_back(new DropDownListItem(-1, false)); // separator line
207  list.emplace_back(new DropDownListStringItem(STR_GAME_OPTIONS_CURRENCY_CUSTOM, CURRENCY_CUSTOM, HasBit(disabled, CURRENCY_CUSTOM)));
208  break;
209  }
210 
211  case WID_GO_AUTOSAVE_DROPDOWN: { // Setup autosave dropdown
212  *selected_index = _settings_client.gui.autosave;
213  const StringID *items = _autosave_dropdown;
214  for (uint i = 0; *items != INVALID_STRING_ID; items++, i++) {
215  list.emplace_back(new DropDownListStringItem(*items, i, false));
216  }
217  break;
218  }
219 
220  case WID_GO_LANG_DROPDOWN: { // Setup interface language dropdown
221  for (uint i = 0; i < _languages.size(); i++) {
222  bool hide_language = IsReleasedVersion() && !_languages[i].IsReasonablyFinished();
223  if (hide_language) continue;
224  bool hide_percentage = IsReleasedVersion() || _languages[i].missing < _settings_client.gui.missing_strings_threshold;
225  auto item = new DropDownListParamStringItem(hide_percentage ? STR_JUST_RAW_STRING : STR_GAME_OPTIONS_LANGUAGE_PERCENTAGE, i, false);
226  if (&_languages[i] == _current_language) {
227  *selected_index = i;
228  item->SetParamStr(0, _languages[i].own_name);
229  } else {
230  /* Especially with sprite-fonts, not all localized
231  * names can be rendered. So instead, we use the
232  * international names for anything but the current
233  * selected language. This avoids showing a few ????
234  * entries in the dropdown list. */
235  item->SetParamStr(0, _languages[i].name);
236  }
237  item->SetParam(1, (LANGUAGE_TOTAL_STRINGS - _languages[i].missing) * 100 / LANGUAGE_TOTAL_STRINGS);
238  list.emplace_back(item);
239  }
240  std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
241  break;
242  }
243 
244  case WID_GO_RESOLUTION_DROPDOWN: // Setup resolution dropdown
245  if (_resolutions.empty()) break;
246 
247  *selected_index = GetCurrentResolutionIndex();
248  for (uint i = 0; i < _resolutions.size(); i++) {
249  auto item = new DropDownListParamStringItem(STR_GAME_OPTIONS_RESOLUTION_ITEM, i, false);
250  item->SetParam(0, _resolutions[i].width);
251  item->SetParam(1, _resolutions[i].height);
252  list.emplace_back(item);
253  }
254  break;
255 
256  case WID_GO_REFRESH_RATE_DROPDOWN: // Setup refresh rate dropdown
257  for (auto it = _refresh_rates.begin(); it != _refresh_rates.end(); it++) {
258  auto i = std::distance(_refresh_rates.begin(), it);
259  if (*it == _settings_client.gui.refresh_rate) *selected_index = i;
260  auto item = new DropDownListParamStringItem(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, i, false);
261  item->SetParam(0, *it);
262  list.emplace_back(item);
263  }
264  break;
265 
267  *selected_index = _gui_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _gui_zoom + 1 : 0;
268  const StringID *items = _gui_zoom_dropdown;
269  for (int i = 0; *items != INVALID_STRING_ID; items++, i++) {
270  list.emplace_back(new DropDownListStringItem(*items, i, i != 0 && _settings_client.gui.zoom_min > ZOOM_LVL_OUT_4X - i + 1));
271  }
272  break;
273  }
274 
276  *selected_index = _font_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _font_zoom + 1 : 0;
277  const StringID *items = _font_zoom_dropdown;
278  for (int i = 0; *items != INVALID_STRING_ID; items++, i++) {
279  list.emplace_back(new DropDownListStringItem(*items, i, false));
280  }
281  break;
282  }
283 
285  list = BuildSetDropDownList<BaseGraphics>(selected_index, (_game_mode == GM_MENU));
286  break;
287 
289  list = BuildSetDropDownList<BaseSounds>(selected_index, (_game_mode == GM_MENU));
290  break;
291 
293  list = BuildMusicSetDropDownList(selected_index);
294  break;
295  }
296 
297  return list;
298  }
299 
300  void SetStringParameters(int widget) const override
301  {
302  switch (widget) {
303  case WID_GO_CURRENCY_DROPDOWN: SetDParam(0, _currency_specs[this->opt->locale.currency].name); break;
304  case WID_GO_AUTOSAVE_DROPDOWN: SetDParam(0, _autosave_dropdown[_settings_client.gui.autosave]); break;
306  case WID_GO_GUI_ZOOM_DROPDOWN: SetDParam(0, _gui_zoom_dropdown[_gui_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _gui_zoom_cfg + 1 : 0]); break;
307  case WID_GO_FONT_ZOOM_DROPDOWN: SetDParam(0, _font_zoom_dropdown[_font_zoom_cfg != ZOOM_LVL_CFG_AUTO ? ZOOM_LVL_OUT_4X - _font_zoom_cfg + 1 : 0]); break;
309  case WID_GO_BASE_GRF_STATUS: SetDParam(0, BaseGraphics::GetUsedSet()->GetNumInvalid()); break;
312  case WID_GO_BASE_MUSIC_STATUS: SetDParam(0, BaseMusic::GetUsedSet()->GetNumInvalid()); break;
315  auto current_resolution = GetCurrentResolutionIndex();
316 
317  if (current_resolution == _resolutions.size()) {
318  SetDParam(0, STR_GAME_OPTIONS_RESOLUTION_OTHER);
319  } else {
320  SetDParam(0, STR_GAME_OPTIONS_RESOLUTION_ITEM);
321  SetDParam(1, _resolutions[current_resolution].width);
322  SetDParam(2, _resolutions[current_resolution].height);
323  }
324  break;
325  }
326  }
327  }
328 
329  void DrawWidget(const Rect &r, int widget) const override
330  {
331  switch (widget) {
334  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
335  break;
336 
339  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
340  break;
341 
344  DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, STR_BLACK_RAW_STRING);
345  break;
346 
349  break;
350 
353  break;
354  }
355  }
356 
357  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
358  {
359  switch (widget) {
361  /* Find the biggest description for the default size. */
362  for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
364  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
365  }
366  break;
367 
369  /* Find the biggest description for the default size. */
370  for (int i = 0; i < BaseGraphics::GetNumSets(); i++) {
371  uint invalid_files = BaseGraphics::GetSet(i)->GetNumInvalid();
372  if (invalid_files == 0) continue;
373 
374  SetDParam(0, invalid_files);
375  *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_GRF_STATUS));
376  }
377  break;
378 
380  /* Find the biggest description for the default size. */
381  for (int i = 0; i < BaseSounds::GetNumSets(); i++) {
383  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
384  }
385  break;
386 
388  /* Find the biggest description for the default size. */
389  for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
390  SetDParamStr(0, BaseMusic::GetSet(i)->GetDescription(GetCurrentLanguageIsoCode()));
391  size->height = std::max(size->height, (uint)GetStringHeight(STR_BLACK_RAW_STRING, size->width));
392  }
393  break;
394 
396  /* Find the biggest description for the default size. */
397  for (int i = 0; i < BaseMusic::GetNumSets(); i++) {
398  uint invalid_files = BaseMusic::GetSet(i)->GetNumInvalid();
399  if (invalid_files == 0) continue;
400 
401  SetDParam(0, invalid_files);
402  *size = maxdim(*size, GetStringBoundingBox(STR_GAME_OPTIONS_BASE_MUSIC_STATUS));
403  }
404  break;
405 
406  default: {
407  int selected;
408  DropDownList list = this->BuildDropDownList(widget, &selected);
409  if (!list.empty()) {
410  /* Find the biggest item for the default size. */
411  for (const auto &ddli : list) {
412  Dimension string_dim;
413  int width = ddli->Width();
414  string_dim.width = width + padding.width;
415  string_dim.height = ddli->Height(width) + padding.height;
416  *size = maxdim(*size, string_dim);
417  }
418  }
419  }
420  }
421  }
422 
423  void OnClick(Point pt, int widget, int click_count) override
424  {
425  if (widget >= WID_GO_BASE_GRF_TEXTFILE && widget < WID_GO_BASE_GRF_TEXTFILE + TFT_END) {
426  if (BaseGraphics::GetUsedSet() == nullptr) return;
427 
428  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_GRF_TEXTFILE), BaseGraphics::GetUsedSet(), STR_CONTENT_TYPE_BASE_GRAPHICS);
429  return;
430  }
431  if (widget >= WID_GO_BASE_SFX_TEXTFILE && widget < WID_GO_BASE_SFX_TEXTFILE + TFT_END) {
432  if (BaseSounds::GetUsedSet() == nullptr) return;
433 
434  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_SFX_TEXTFILE), BaseSounds::GetUsedSet(), STR_CONTENT_TYPE_BASE_SOUNDS);
435  return;
436  }
437  if (widget >= WID_GO_BASE_MUSIC_TEXTFILE && widget < WID_GO_BASE_MUSIC_TEXTFILE + TFT_END) {
438  if (BaseMusic::GetUsedSet() == nullptr) return;
439 
440  ShowBaseSetTextfileWindow((TextfileType)(widget - WID_GO_BASE_MUSIC_TEXTFILE), BaseMusic::GetUsedSet(), STR_CONTENT_TYPE_BASE_MUSIC);
441  return;
442  }
443  switch (widget) {
444  case WID_GO_FULLSCREEN_BUTTON: // Click fullscreen on/off
445  /* try to toggle full-screen on/off */
446  if (!ToggleFullScreen(!_fullscreen)) {
447  ShowErrorMessage(STR_ERROR_FULLSCREEN_FAILED, INVALID_STRING_ID, WL_ERROR);
448  }
451  break;
452 
455  ShowErrorMessage(STR_GAME_OPTIONS_VIDEO_ACCELERATION_RESTART, INVALID_STRING_ID, WL_INFO);
458 #ifndef __APPLE__
461 #endif
462  break;
463 
465  if (!_video_hw_accel) break;
466 
469 
472  break;
473 
477  if (ClickVolumeSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, vol)) {
479  this->SetWidgetDirty(widget);
481  }
482 
483  if (click_count > 0) this->mouse_capture_widget = widget;
484  break;
485  }
486 
487  default: {
488  int selected;
489  DropDownList list = this->BuildDropDownList(widget, &selected);
490  if (!list.empty()) {
491  ShowDropDownList(this, std::move(list), selected, widget);
492  } else {
493  if (widget == WID_GO_RESOLUTION_DROPDOWN) ShowErrorMessage(STR_ERROR_RESOLUTION_LIST_FAILED, INVALID_STRING_ID, WL_ERROR);
494  }
495  break;
496  }
497  }
498  }
499 
505  template <class T>
506  void SetMediaSet(int index)
507  {
508  if (_game_mode == GM_MENU) {
509  auto name = T::GetSet(index)->name;
510 
511  T::ini_set = name;
512 
513  T::SetSet(name);
514  this->reload = true;
515  this->InvalidateData();
516  }
517  }
518 
519  void OnDropdownSelect(int widget, int index) override
520  {
521  switch (widget) {
522  case WID_GO_CURRENCY_DROPDOWN: // Currency
523  if (index == CURRENCY_CUSTOM) ShowCustCurrency();
524  this->opt->locale.currency = index;
525  ReInitAllWindows(false);
526  break;
527 
528  case WID_GO_AUTOSAVE_DROPDOWN: // Autosave options
529  _settings_client.gui.autosave = index;
530  this->SetDirty();
531  break;
532 
533  case WID_GO_LANG_DROPDOWN: // Change interface language
534  ReadLanguagePack(&_languages[index]);
537  ClearAllCachedNames();
539  CheckBlitter();
540  ReInitAllWindows(false);
541  break;
542 
543  case WID_GO_RESOLUTION_DROPDOWN: // Change resolution
544  if ((uint)index < _resolutions.size() && ChangeResInGame(_resolutions[index].width, _resolutions[index].height)) {
545  this->SetDirty();
546  }
547  break;
548 
550  _settings_client.gui.refresh_rate = *std::next(_refresh_rates.begin(), index);
551  if (_settings_client.gui.refresh_rate > 60) {
552  /* Show warning to the user that this refresh rate might not be suitable on
553  * larger maps with many NewGRFs and vehicles. */
554  ShowErrorMessage(STR_GAME_OPTIONS_REFRESH_RATE_WARNING, INVALID_STRING_ID, WL_INFO);
555  }
556  break;
557  }
558 
560  int8 new_zoom = index > 0 ? ZOOM_LVL_OUT_4X - index + 1 : ZOOM_LVL_CFG_AUTO;
561  if (new_zoom != _gui_zoom_cfg) {
563  _gui_zoom_cfg = new_zoom;
564  UpdateGUIZoom();
567  FixTitleGameZoom();
568  ReInitAllWindows(true);
569  }
570  break;
571  }
572 
574  int8 new_zoom = index > 0 ? ZOOM_LVL_OUT_4X - index + 1 : ZOOM_LVL_CFG_AUTO;
575  if (new_zoom != _font_zoom_cfg) {
577  _font_zoom_cfg = new_zoom;
578  UpdateGUIZoom();
579  ClearFontCache();
582  ReInitAllWindows(true);
583  }
584  break;
585  }
586 
588  this->SetMediaSet<BaseGraphics>(index);
589  break;
590 
592  this->SetMediaSet<BaseSounds>(index);
593  break;
594 
596  ChangeMusicSet(index);
597  break;
598  }
599  }
600 
606  void OnInvalidateData(int data = 0, bool gui_scope = true) override
607  {
608  if (!gui_scope) return;
611 
612 #ifndef __APPLE__
615 #endif
616 
617  bool missing_files = BaseGraphics::GetUsedSet()->GetNumMissing() == 0;
618  this->GetWidget<NWidgetCore>(WID_GO_BASE_GRF_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_GRF_STATUS, STR_NULL);
619 
620  for (TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
624  }
625 
626  missing_files = BaseMusic::GetUsedSet()->GetNumInvalid() == 0;
627  this->GetWidget<NWidgetCore>(WID_GO_BASE_MUSIC_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_MUSIC_STATUS, STR_NULL);
628  }
629 };
630 
631 static const NWidgetPart _nested_game_options_widgets[] = {
633  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
634  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
635  EndContainer(),
636  NWidget(WWT_PANEL, COLOUR_GREY, WID_GO_BACKGROUND), SetPIP(6, 6, 10),
637  NWidget(NWID_HORIZONTAL), SetPIP(10, 10, 10),
638  NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
639  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_AUTOSAVE_FRAME, STR_NULL),
640  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_AUTOSAVE_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_TOOLTIP), SetFill(1, 0),
641  EndContainer(),
642  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_GUI_ZOOM_FRAME, STR_NULL),
643  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_GUI_ZOOM_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_TOOLTIP), SetFill(1, 0),
644  EndContainer(),
645  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_CURRENCY_UNITS_FRAME, STR_NULL),
646  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_CURRENCY_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_CURRENCY_UNITS_DROPDOWN_TOOLTIP), SetFill(1, 0),
647  EndContainer(),
648  EndContainer(),
649 
650  NWidget(NWID_VERTICAL), SetPIP(0, 6, 0),
651  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_LANGUAGE, STR_NULL),
652  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_LANG_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_LANGUAGE_TOOLTIP), SetFill(1, 0),
653  EndContainer(),
654  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_FONT_ZOOM, STR_NULL),
655  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_FONT_ZOOM_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_TOOLTIP), SetFill(1, 0),
656  EndContainer(),
657  EndContainer(),
658  EndContainer(),
659 
660  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_GRAPHICS, STR_NULL), SetPadding(0, 10, 0, 10),
662  NWidget(NWID_VERTICAL), SetPIP(0, 2, 0),
664  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12),SetDataTip(STR_GAME_OPTIONS_RESOLUTION, STR_NULL),
665  NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetFill(1, 0),
666  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_RESOLUTION_DROPDOWN), SetMinimalSize(200, 12), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_RESOLUTION_TOOLTIP),
667  EndContainer(),
669  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetDataTip(STR_GAME_OPTIONS_REFRESH_RATE, STR_NULL),
670  NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetFill(1, 0),
671  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_REFRESH_RATE_DROPDOWN), SetMinimalSize(200, 12), SetDataTip(STR_GAME_OPTIONS_REFRESH_RATE_ITEM, STR_GAME_OPTIONS_REFRESH_RATE_TOOLTIP),
672  EndContainer(),
674  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetDataTip(STR_GAME_OPTIONS_FULLSCREEN, STR_NULL),
675  NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetFill(1, 0),
676  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GO_FULLSCREEN_BUTTON), SetMinimalSize(21, 9), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_FULLSCREEN_TOOLTIP),
677  EndContainer(),
679  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetDataTip(STR_GAME_OPTIONS_VIDEO_ACCELERATION, STR_NULL),
680  NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetFill(1, 0),
681  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GO_VIDEO_ACCEL_BUTTON), SetMinimalSize(21, 9), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_VIDEO_ACCELERATION_TOOLTIP),
682  EndContainer(),
683 #ifndef __APPLE__
685  NWidget(WWT_TEXT, COLOUR_GREY), SetMinimalSize(0, 12), SetDataTip(STR_GAME_OPTIONS_VIDEO_VSYNC, STR_NULL),
686  NWidget(NWID_SPACER), SetMinimalSize(1, 0), SetFill(1, 0),
687  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GO_VIDEO_VSYNC_BUTTON), SetMinimalSize(21, 9), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_VIDEO_VSYNC_TOOLTIP),
688  EndContainer(),
689 #endif
690  EndContainer(),
691  EndContainer(),
692  EndContainer(),
693 
694  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_GRF, STR_NULL), SetPadding(0, 10, 0, 10),
695  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 0),
696  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_GRF_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_GRF_TOOLTIP),
697  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
698  EndContainer(),
699  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_GRF_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_GRF_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
701  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
702  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
703  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_GRF_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
704  EndContainer(),
705  EndContainer(),
706 
707  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_SFX, STR_NULL), SetPadding(0, 10, 0, 10),
708  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 7),
709  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_SFX_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_SFX_TOOLTIP),
710  NWidget(NWID_SPACER), SetMinimalSize(150, 12), SetFill(1, 0),
711  NWidget(WWT_EMPTY, COLOUR_GREY, WID_GO_BASE_SFX_VOLUME), SetMinimalSize(67, 12), SetFill(0, 0), SetDataTip(0x0, STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
712  EndContainer(),
713  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_SFX_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_SFX_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
715  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
716  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
717  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_SFX_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
718  EndContainer(),
719  EndContainer(),
720 
721  NWidget(WWT_FRAME, COLOUR_GREY), SetDataTip(STR_GAME_OPTIONS_BASE_MUSIC, STR_NULL), SetPadding(0, 10, 0, 10),
722  NWidget(NWID_HORIZONTAL), SetPIP(0, 30, 7),
723  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GO_BASE_MUSIC_DROPDOWN), SetMinimalSize(150, 12), SetDataTip(STR_BLACK_RAW_STRING, STR_GAME_OPTIONS_BASE_MUSIC_TOOLTIP),
724  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_STATUS), SetMinimalSize(150, 12), SetDataTip(STR_EMPTY, STR_NULL), SetFill(1, 0),
725  NWidget(WWT_EMPTY, COLOUR_GREY, WID_GO_BASE_MUSIC_VOLUME), SetMinimalSize(67, 12), SetFill(0, 0), SetDataTip(0x0, STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
726  EndContainer(),
727  NWidget(WWT_TEXT, COLOUR_GREY, WID_GO_BASE_MUSIC_DESCRIPTION), SetMinimalSize(330, 0), SetDataTip(STR_EMPTY, STR_GAME_OPTIONS_BASE_MUSIC_DESCRIPTION_TOOLTIP), SetFill(1, 0), SetPadding(6, 0, 6, 0),
729  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_README), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_README, STR_NULL),
730  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_CHANGELOG), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_NULL),
731  NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GO_BASE_MUSIC_TEXTFILE + TFT_LICENSE), SetFill(1, 0), SetResize(1, 0), SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_NULL),
732  EndContainer(),
733  EndContainer(),
734  EndContainer(),
735 };
736 
737 static WindowDesc _game_options_desc(
738  WDP_CENTER, "settings_game", 0, 0,
740  0,
741  _nested_game_options_widgets, lengthof(_nested_game_options_widgets)
742 );
743 
746 {
748  new GameOptionsWindow(&_game_options_desc);
749 }
750 
751 static int SETTING_HEIGHT = 11;
752 static const int LEVEL_WIDTH = 15;
753 
762 
763  SEF_LAST_FIELD = 0x04,
764  SEF_FILTERED = 0x08,
765 };
766 
775 };
777 
778 
782  bool type_hides;
785 };
786 
789  byte flags;
790  byte level;
791 
792  BaseSettingEntry() : flags(0), level(0) {}
793  virtual ~BaseSettingEntry() {}
794 
795  virtual void Init(byte level = 0);
796  virtual void FoldAll() {}
797  virtual void UnFoldAll() {}
798  virtual void ResetAll() = 0;
799 
804  void SetLastField(bool last_field) { if (last_field) SETBITS(this->flags, SEF_LAST_FIELD); else CLRBITS(this->flags, SEF_LAST_FIELD); }
805 
806  virtual uint Length() const = 0;
807  virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const {}
808  virtual bool IsVisible(const BaseSettingEntry *item) const;
809  virtual BaseSettingEntry *FindEntry(uint row, uint *cur_row);
810  virtual uint GetMaxHelpHeight(int maxw) { return 0; }
811 
816  bool IsFiltered() const { return (this->flags & SEF_FILTERED) != 0; }
817 
818  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible) = 0;
819 
820  virtual 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;
821 
822 protected:
823  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const = 0;
824 };
825 
828  const char *name;
830 
831  SettingEntry(const char *name);
832 
833  virtual void Init(byte level = 0);
834  virtual void ResetAll();
835  virtual uint Length() const;
836  virtual uint GetMaxHelpHeight(int maxw);
837  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible);
838 
839  void SetButtons(byte new_val);
840 
845  inline StringID GetHelpText() const
846  {
847  return this->setting->str_help;
848  }
849 
850  void SetValueDParams(uint first_param, int32 value) const;
851 
852 protected:
853  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const;
854 
855 private:
857 };
858 
861  typedef std::vector<BaseSettingEntry*> EntryVector;
862  EntryVector entries;
863 
864  template<typename T>
865  T *Add(T *item)
866  {
867  this->entries.push_back(item);
868  return item;
869  }
870 
871  void Init(byte level = 0);
872  void ResetAll();
873  void FoldAll();
874  void UnFoldAll();
875 
876  uint Length() const;
877  void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
878  bool IsVisible(const BaseSettingEntry *item) const;
879  BaseSettingEntry *FindEntry(uint row, uint *cur_row);
880  uint GetMaxHelpHeight(int maxw);
881 
882  bool UpdateFilterState(SettingFilter &filter, bool force_visible);
883 
884  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;
885 };
886 
890  bool folded;
891 
893 
894  virtual void Init(byte level = 0);
895  virtual void ResetAll();
896  virtual void FoldAll();
897  virtual void UnFoldAll();
898 
899  virtual uint Length() const;
900  virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const;
901  virtual bool IsVisible(const BaseSettingEntry *item) const;
902  virtual BaseSettingEntry *FindEntry(uint row, uint *cur_row);
903  virtual uint GetMaxHelpHeight(int maxw) { return SettingsContainer::GetMaxHelpHeight(maxw); }
904 
905  virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible);
906 
907  virtual 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;
908 
909 protected:
910  virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const;
911 };
912 
913 /* == BaseSettingEntry methods == */
914 
919 void BaseSettingEntry::Init(byte level)
920 {
921  this->level = level;
922 }
923 
931 {
932  if (this->IsFiltered()) return false;
933  return this == item;
934 }
935 
942 BaseSettingEntry *BaseSettingEntry::FindEntry(uint row_num, uint *cur_row)
943 {
944  if (this->IsFiltered()) return nullptr;
945  if (row_num == *cur_row) return this;
946  (*cur_row)++;
947  return nullptr;
948 }
949 
979 uint BaseSettingEntry::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
980 {
981  if (this->IsFiltered()) return cur_row;
982  if (cur_row >= max_row) return cur_row;
983 
984  bool rtl = _current_text_dir == TD_RTL;
985  int offset = rtl ? -4 : 4;
986  int level_width = rtl ? -LEVEL_WIDTH : LEVEL_WIDTH;
987 
988  int x = rtl ? right : left;
989  if (cur_row >= first_row) {
990  int colour = _colour_gradient[COLOUR_ORANGE][4];
991  y += (cur_row - first_row) * SETTING_HEIGHT; // Compute correct y start position
992 
993  /* Draw vertical for parent nesting levels */
994  for (uint lvl = 0; lvl < this->level; lvl++) {
995  if (!HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y + SETTING_HEIGHT - 1, colour);
996  x += level_width;
997  }
998  /* draw own |- prefix */
999  int halfway_y = y + SETTING_HEIGHT / 2;
1000  int bottom_y = (flags & SEF_LAST_FIELD) ? halfway_y : y + SETTING_HEIGHT - 1;
1001  GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
1002  /* Small horizontal line from the last vertical line */
1003  GfxDrawLine(x + offset, halfway_y, x + level_width - offset, halfway_y, colour);
1004  x += level_width;
1005 
1006  this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y, this == selected);
1007  }
1008  cur_row++;
1009 
1010  return cur_row;
1011 }
1012 
1013 /* == SettingEntry methods == */
1014 
1020 {
1021  this->name = name;
1022  this->setting = nullptr;
1023 }
1024 
1029 void SettingEntry::Init(byte level)
1030 {
1032  this->setting = GetSettingFromName(this->name)->AsIntSetting();
1033 }
1034 
1035 /* Sets the given setting entry to its default value */
1036 void SettingEntry::ResetAll()
1037 {
1038  SetSettingValue(this->setting, this->setting->def);
1039 }
1040 
1046 void SettingEntry::SetButtons(byte new_val)
1047 {
1048  assert((new_val & ~SEF_BUTTONS_MASK) == 0); // Should not touch any flags outside the buttons
1049  this->flags = (this->flags & ~SEF_BUTTONS_MASK) | new_val;
1050 }
1051 
1054 {
1055  return this->IsFiltered() ? 0 : 1;
1056 }
1057 
1064 {
1065  return GetStringHeight(this->GetHelpText(), maxw);
1066 }
1067 
1074 {
1075  /* There shall not be any restriction, i.e. all settings shall be visible. */
1076  if (mode == RM_ALL) return true;
1077 
1078  const IntSettingDesc *sd = this->setting;
1079 
1080  if (mode == RM_BASIC) return (this->setting->cat & SC_BASIC_LIST) != 0;
1081  if (mode == RM_ADVANCED) return (this->setting->cat & SC_ADVANCED_LIST) != 0;
1082 
1083  /* Read the current value. */
1084  const void *object = ResolveObject(&GetGameSettings(), sd);
1085  int64 current_value = sd->Read(object);
1086  int64 filter_value;
1087 
1088  if (mode == RM_CHANGED_AGAINST_DEFAULT) {
1089  /* This entry shall only be visible, if the value deviates from its default value. */
1090 
1091  /* Read the default value. */
1092  filter_value = sd->def;
1093  } else {
1094  assert(mode == RM_CHANGED_AGAINST_NEW);
1095  /* This entry shall only be visible, if the value deviates from
1096  * its value is used when starting a new game. */
1097 
1098  /* Make sure we're not comparing the new game settings against itself. */
1099  assert(&GetGameSettings() != &_settings_newgame);
1100 
1101  /* Read the new game's value. */
1102  filter_value = sd->Read(ResolveObject(&_settings_newgame, sd));
1103  }
1104 
1105  return current_value != filter_value;
1106 }
1107 
1114 bool SettingEntry::UpdateFilterState(SettingFilter &filter, bool force_visible)
1115 {
1116  CLRBITS(this->flags, SEF_FILTERED);
1117 
1118  bool visible = true;
1119 
1120  const IntSettingDesc *sd = this->setting;
1121  if (!force_visible && !filter.string.IsEmpty()) {
1122  /* Process the search text filter for this item. */
1123  filter.string.ResetState();
1124 
1125  SetDParam(0, STR_EMPTY);
1126  filter.string.AddLine(sd->str);
1127  filter.string.AddLine(this->GetHelpText());
1128 
1129  visible = filter.string.GetState();
1130  }
1131 
1132  if (visible) {
1133  if (filter.type != ST_ALL && sd->GetType() != filter.type) {
1134  filter.type_hides = true;
1135  visible = false;
1136  }
1137  if (!this->IsVisibleByRestrictionMode(filter.mode)) {
1138  while (filter.min_cat < RM_ALL && (filter.min_cat == filter.mode || !this->IsVisibleByRestrictionMode(filter.min_cat))) filter.min_cat++;
1139  visible = false;
1140  }
1141  }
1142 
1143  if (!visible) SETBITS(this->flags, SEF_FILTERED);
1144  return visible;
1145 }
1146 
1147 static const void *ResolveObject(const GameSettings *settings_ptr, const IntSettingDesc *sd)
1148 {
1149  if ((sd->flags & SF_PER_COMPANY) != 0) {
1150  if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
1151  return &Company::Get(_local_company)->settings;
1152  }
1153  return &_settings_client.company;
1154  }
1155  return settings_ptr;
1156 }
1157 
1163 void SettingEntry::SetValueDParams(uint first_param, int32 value) const
1164 {
1165  if (this->setting->IsBoolSetting()) {
1166  SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
1167  } else {
1168  if ((this->setting->flags & SF_GUI_DROPDOWN) != 0) {
1169  SetDParam(first_param++, this->setting->str_val - this->setting->min + value);
1170  } else if ((this->setting->flags & SF_GUI_NEGATIVE_IS_SPECIAL) != 0) {
1171  SetDParam(first_param++, this->setting->str_val + ((value >= 0) ? 1 : 0));
1172  value = abs(value);
1173  } else {
1174  SetDParam(first_param++, this->setting->str_val + ((value == 0 && (this->setting->flags & SF_GUI_0_IS_SPECIAL) != 0) ? 1 : 0));
1175  }
1176  SetDParam(first_param++, value);
1177  }
1178 }
1179 
1188 void SettingEntry::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
1189 {
1190  const IntSettingDesc *sd = this->setting;
1191  int state = this->flags & SEF_BUTTONS_MASK;
1192 
1193  bool rtl = _current_text_dir == TD_RTL;
1194  uint buttons_left = rtl ? right + 1 - SETTING_BUTTON_WIDTH : left;
1195  uint text_left = left + (rtl ? 0 : SETTING_BUTTON_WIDTH + 5);
1196  uint text_right = right - (rtl ? SETTING_BUTTON_WIDTH + 5 : 0);
1197  uint button_y = y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
1198 
1199  /* We do not allow changes of some items when we are a client in a networkgame */
1200  bool editable = sd->IsEditable();
1201 
1202  SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
1203  int32 value = sd->Read(ResolveObject(settings_ptr, sd));
1204  if (sd->IsBoolSetting()) {
1205  /* Draw checkbox for boolean-value either on/off */
1206  DrawBoolButton(buttons_left, button_y, value != 0, editable);
1207  } else if ((sd->flags & SF_GUI_DROPDOWN) != 0) {
1208  /* Draw [v] button for settings of an enum-type */
1209  DrawDropDownButton(buttons_left, button_y, COLOUR_YELLOW, state != 0, editable);
1210  } else {
1211  /* Draw [<][>] boxes for settings of an integer-type */
1212  DrawArrowButtons(buttons_left, button_y, COLOUR_YELLOW, state,
1213  editable && value != (sd->flags & SF_GUI_0_IS_SPECIAL ? 0 : sd->min), editable && (uint32)value != sd->max);
1214  }
1215  this->SetValueDParams(1, value);
1216  DrawString(text_left, text_right, y + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) / 2, sd->str, highlight ? TC_WHITE : TC_LIGHT_BLUE);
1217 }
1218 
1219 /* == SettingsContainer methods == */
1220 
1225 void SettingsContainer::Init(byte level)
1226 {
1227  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1228  (*it)->Init(level);
1229  }
1230 }
1231 
1234 {
1235  for (auto settings_entry : this->entries) {
1236  settings_entry->ResetAll();
1237  }
1238 }
1239 
1242 {
1243  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1244  (*it)->FoldAll();
1245  }
1246 }
1247 
1250 {
1251  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1252  (*it)->UnFoldAll();
1253  }
1254 }
1255 
1261 void SettingsContainer::GetFoldingState(bool &all_folded, bool &all_unfolded) const
1262 {
1263  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1264  (*it)->GetFoldingState(all_folded, all_unfolded);
1265  }
1266 }
1267 
1274 bool SettingsContainer::UpdateFilterState(SettingFilter &filter, bool force_visible)
1275 {
1276  bool visible = false;
1277  bool first_visible = true;
1278  for (EntryVector::reverse_iterator it = this->entries.rbegin(); it != this->entries.rend(); ++it) {
1279  visible |= (*it)->UpdateFilterState(filter, force_visible);
1280  (*it)->SetLastField(first_visible);
1281  if (visible && first_visible) first_visible = false;
1282  }
1283  return visible;
1284 }
1285 
1286 
1294 {
1295  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1296  if ((*it)->IsVisible(item)) return true;
1297  }
1298  return false;
1299 }
1300 
1303 {
1304  uint length = 0;
1305  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1306  length += (*it)->Length();
1307  }
1308  return length;
1309 }
1310 
1317 BaseSettingEntry *SettingsContainer::FindEntry(uint row_num, uint *cur_row)
1318 {
1319  BaseSettingEntry *pe = nullptr;
1320  for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1321  pe = (*it)->FindEntry(row_num, cur_row);
1322  if (pe != nullptr) {
1323  break;
1324  }
1325  }
1326  return pe;
1327 }
1328 
1335 {
1336  uint biggest = 0;
1337  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1338  biggest = std::max(biggest, (*it)->GetMaxHelpHeight(maxw));
1339  }
1340  return biggest;
1341 }
1342 
1343 
1358 uint SettingsContainer::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
1359 {
1360  for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1361  cur_row = (*it)->Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1362  if (cur_row >= max_row) {
1363  break;
1364  }
1365  }
1366  return cur_row;
1367 }
1368 
1369 /* == SettingsPage methods == */
1370 
1376 {
1377  this->title = title;
1378  this->folded = true;
1379 }
1380 
1385 void SettingsPage::Init(byte level)
1386 {
1389 }
1390 
1393 {
1394  for (auto settings_entry : this->entries) {
1395  settings_entry->ResetAll();
1396  }
1397 }
1398 
1401 {
1402  if (this->IsFiltered()) return;
1403  this->folded = true;
1404 
1406 }
1407 
1410 {
1411  if (this->IsFiltered()) return;
1412  this->folded = false;
1413 
1415 }
1416 
1422 void SettingsPage::GetFoldingState(bool &all_folded, bool &all_unfolded) const
1423 {
1424  if (this->IsFiltered()) return;
1425 
1426  if (this->folded) {
1427  all_unfolded = false;
1428  } else {
1429  all_folded = false;
1430  }
1431 
1432  SettingsContainer::GetFoldingState(all_folded, all_unfolded);
1433 }
1434 
1441 bool SettingsPage::UpdateFilterState(SettingFilter &filter, bool force_visible)
1442 {
1443  if (!force_visible && !filter.string.IsEmpty()) {
1444  filter.string.ResetState();
1445  filter.string.AddLine(this->title);
1446  force_visible = filter.string.GetState();
1447  }
1448 
1449  bool visible = SettingsContainer::UpdateFilterState(filter, force_visible);
1450  if (visible) {
1451  CLRBITS(this->flags, SEF_FILTERED);
1452  } else {
1453  SETBITS(this->flags, SEF_FILTERED);
1454  }
1455  return visible;
1456 }
1457 
1465 {
1466  if (this->IsFiltered()) return false;
1467  if (this == item) return true;
1468  if (this->folded) return false;
1469 
1470  return SettingsContainer::IsVisible(item);
1471 }
1472 
1475 {
1476  if (this->IsFiltered()) return 0;
1477  if (this->folded) return 1; // Only displaying the title
1478 
1479  return 1 + SettingsContainer::Length();
1480 }
1481 
1488 BaseSettingEntry *SettingsPage::FindEntry(uint row_num, uint *cur_row)
1489 {
1490  if (this->IsFiltered()) return nullptr;
1491  if (row_num == *cur_row) return this;
1492  (*cur_row)++;
1493  if (this->folded) return nullptr;
1494 
1495  return SettingsContainer::FindEntry(row_num, cur_row);
1496 }
1497 
1512 uint SettingsPage::Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row, uint parent_last) const
1513 {
1514  if (this->IsFiltered()) return cur_row;
1515  if (cur_row >= max_row) return cur_row;
1516 
1517  cur_row = BaseSettingEntry::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1518 
1519  if (!this->folded) {
1520  if (this->flags & SEF_LAST_FIELD) {
1521  assert(this->level < 8 * sizeof(parent_last));
1522  SetBit(parent_last, this->level); // Add own last-field state
1523  }
1524 
1525  cur_row = SettingsContainer::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1526  }
1527 
1528  return cur_row;
1529 }
1530 
1539 void SettingsPage::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
1540 {
1541  bool rtl = _current_text_dir == TD_RTL;
1542  DrawSprite((this->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? right - _circle_size.width : left, y + (SETTING_HEIGHT - _circle_size.height) / 2);
1543  DrawString(rtl ? left : left + _circle_size.width + 2, rtl ? right - _circle_size.width - 2 : right, y + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) / 2, this->title);
1544 }
1545 
1548 {
1549  static SettingsContainer *main = nullptr;
1550 
1551  if (main == nullptr)
1552  {
1553  /* Build up the dynamic settings-array only once per OpenTTD session */
1554  main = new SettingsContainer();
1555 
1556  SettingsPage *localisation = main->Add(new SettingsPage(STR_CONFIG_SETTING_LOCALISATION));
1557  {
1558  localisation->Add(new SettingEntry("locale.units_velocity"));
1559  localisation->Add(new SettingEntry("locale.units_power"));
1560  localisation->Add(new SettingEntry("locale.units_weight"));
1561  localisation->Add(new SettingEntry("locale.units_volume"));
1562  localisation->Add(new SettingEntry("locale.units_force"));
1563  localisation->Add(new SettingEntry("locale.units_height"));
1564  localisation->Add(new SettingEntry("gui.date_format_in_default_names"));
1565  }
1566 
1567  SettingsPage *graphics = main->Add(new SettingsPage(STR_CONFIG_SETTING_GRAPHICS));
1568  {
1569  graphics->Add(new SettingEntry("gui.zoom_min"));
1570  graphics->Add(new SettingEntry("gui.zoom_max"));
1571  graphics->Add(new SettingEntry("gui.sprite_zoom_min"));
1572  graphics->Add(new SettingEntry("gui.smallmap_land_colour"));
1573  graphics->Add(new SettingEntry("gui.graph_line_thickness"));
1574  }
1575 
1576  SettingsPage *sound = main->Add(new SettingsPage(STR_CONFIG_SETTING_SOUND));
1577  {
1578  sound->Add(new SettingEntry("sound.click_beep"));
1579  sound->Add(new SettingEntry("sound.confirm"));
1580  sound->Add(new SettingEntry("sound.news_ticker"));
1581  sound->Add(new SettingEntry("sound.news_full"));
1582  sound->Add(new SettingEntry("sound.new_year"));
1583  sound->Add(new SettingEntry("sound.disaster"));
1584  sound->Add(new SettingEntry("sound.vehicle"));
1585  sound->Add(new SettingEntry("sound.ambient"));
1586  }
1587 
1588  SettingsPage *interface = main->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE));
1589  {
1590  SettingsPage *general = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_GENERAL));
1591  {
1592  general->Add(new SettingEntry("gui.osk_activation"));
1593  general->Add(new SettingEntry("gui.hover_delay_ms"));
1594  general->Add(new SettingEntry("gui.errmsg_duration"));
1595  general->Add(new SettingEntry("gui.window_snap_radius"));
1596  general->Add(new SettingEntry("gui.window_soft_limit"));
1597  general->Add(new SettingEntry("gui.right_mouse_wnd_close"));
1598  }
1599 
1600  SettingsPage *viewports = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_VIEWPORTS));
1601  {
1602  viewports->Add(new SettingEntry("gui.auto_scrolling"));
1603  viewports->Add(new SettingEntry("gui.scroll_mode"));
1604  viewports->Add(new SettingEntry("gui.smooth_scroll"));
1605  /* While the horizontal scrollwheel scrolling is written as general code, only
1606  * the cocoa (OSX) driver generates input for it.
1607  * Since it's also able to completely disable the scrollwheel will we display it on all platforms anyway */
1608  viewports->Add(new SettingEntry("gui.scrollwheel_scrolling"));
1609  viewports->Add(new SettingEntry("gui.scrollwheel_multiplier"));
1610 #ifdef __APPLE__
1611  /* We might need to emulate a right mouse button on mac */
1612  viewports->Add(new SettingEntry("gui.right_mouse_btn_emulation"));
1613 #endif
1614  viewports->Add(new SettingEntry("gui.population_in_label"));
1615  viewports->Add(new SettingEntry("gui.liveries"));
1616  viewports->Add(new SettingEntry("construction.train_signal_side"));
1617  viewports->Add(new SettingEntry("gui.measure_tooltip"));
1618  viewports->Add(new SettingEntry("gui.loading_indicators"));
1619  viewports->Add(new SettingEntry("gui.show_track_reservation"));
1620  }
1621 
1622  SettingsPage *construction = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_CONSTRUCTION));
1623  {
1624  construction->Add(new SettingEntry("gui.link_terraform_toolbar"));
1625  construction->Add(new SettingEntry("gui.enable_signal_gui"));
1626  construction->Add(new SettingEntry("gui.persistent_buildingtools"));
1627  construction->Add(new SettingEntry("gui.quick_goto"));
1628  construction->Add(new SettingEntry("gui.default_rail_type"));
1629  }
1630 
1631  interface->Add(new SettingEntry("gui.fast_forward_speed_limit"));
1632  interface->Add(new SettingEntry("gui.autosave"));
1633  interface->Add(new SettingEntry("gui.toolbar_pos"));
1634  interface->Add(new SettingEntry("gui.statusbar_pos"));
1635  interface->Add(new SettingEntry("gui.prefer_teamchat"));
1636  interface->Add(new SettingEntry("gui.advanced_vehicle_list"));
1637  interface->Add(new SettingEntry("gui.timetable_in_ticks"));
1638  interface->Add(new SettingEntry("gui.timetable_arrival_departure"));
1639  interface->Add(new SettingEntry("gui.expenses_layout"));
1640  interface->Add(new SettingEntry("gui.show_newgrf_name"));
1641  }
1642 
1643  SettingsPage *advisors = main->Add(new SettingsPage(STR_CONFIG_SETTING_ADVISORS));
1644  {
1645  advisors->Add(new SettingEntry("gui.coloured_news_year"));
1646  advisors->Add(new SettingEntry("news_display.general"));
1647  advisors->Add(new SettingEntry("news_display.new_vehicles"));
1648  advisors->Add(new SettingEntry("news_display.accident"));
1649  advisors->Add(new SettingEntry("news_display.company_info"));
1650  advisors->Add(new SettingEntry("news_display.acceptance"));
1651  advisors->Add(new SettingEntry("news_display.arrival_player"));
1652  advisors->Add(new SettingEntry("news_display.arrival_other"));
1653  advisors->Add(new SettingEntry("news_display.advice"));
1654  advisors->Add(new SettingEntry("gui.order_review_system"));
1655  advisors->Add(new SettingEntry("gui.vehicle_income_warn"));
1656  advisors->Add(new SettingEntry("gui.lost_vehicle_warn"));
1657  advisors->Add(new SettingEntry("gui.show_finances"));
1658  advisors->Add(new SettingEntry("news_display.economy"));
1659  advisors->Add(new SettingEntry("news_display.subsidies"));
1660  advisors->Add(new SettingEntry("news_display.open"));
1661  advisors->Add(new SettingEntry("news_display.close"));
1662  advisors->Add(new SettingEntry("news_display.production_player"));
1663  advisors->Add(new SettingEntry("news_display.production_other"));
1664  advisors->Add(new SettingEntry("news_display.production_nobody"));
1665  }
1666 
1667  SettingsPage *company = main->Add(new SettingsPage(STR_CONFIG_SETTING_COMPANY));
1668  {
1669  company->Add(new SettingEntry("gui.semaphore_build_before"));
1670  company->Add(new SettingEntry("gui.default_signal_type"));
1671  company->Add(new SettingEntry("gui.cycle_signal_types"));
1672  company->Add(new SettingEntry("gui.drag_signals_fixed_distance"));
1673  company->Add(new SettingEntry("gui.auto_remove_signals"));
1674  company->Add(new SettingEntry("gui.new_nonstop"));
1675  company->Add(new SettingEntry("gui.stop_location"));
1676  company->Add(new SettingEntry("gui.starting_colour"));
1677  company->Add(new SettingEntry("company.engine_renew"));
1678  company->Add(new SettingEntry("company.engine_renew_months"));
1679  company->Add(new SettingEntry("company.engine_renew_money"));
1680  company->Add(new SettingEntry("vehicle.servint_ispercent"));
1681  company->Add(new SettingEntry("vehicle.servint_trains"));
1682  company->Add(new SettingEntry("vehicle.servint_roadveh"));
1683  company->Add(new SettingEntry("vehicle.servint_ships"));
1684  company->Add(new SettingEntry("vehicle.servint_aircraft"));
1685  }
1686 
1687  SettingsPage *accounting = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCOUNTING));
1688  {
1689  accounting->Add(new SettingEntry("economy.inflation"));
1690  accounting->Add(new SettingEntry("difficulty.initial_interest"));
1691  accounting->Add(new SettingEntry("difficulty.max_loan"));
1692  accounting->Add(new SettingEntry("difficulty.subsidy_multiplier"));
1693  accounting->Add(new SettingEntry("difficulty.subsidy_duration"));
1694  accounting->Add(new SettingEntry("economy.feeder_payment_share"));
1695  accounting->Add(new SettingEntry("economy.infrastructure_maintenance"));
1696  accounting->Add(new SettingEntry("difficulty.vehicle_costs"));
1697  accounting->Add(new SettingEntry("difficulty.construction_cost"));
1698  }
1699 
1700  SettingsPage *vehicles = main->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES));
1701  {
1702  SettingsPage *physics = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_PHYSICS));
1703  {
1704  physics->Add(new SettingEntry("vehicle.train_acceleration_model"));
1705  physics->Add(new SettingEntry("vehicle.train_slope_steepness"));
1706  physics->Add(new SettingEntry("vehicle.wagon_speed_limits"));
1707  physics->Add(new SettingEntry("vehicle.freight_trains"));
1708  physics->Add(new SettingEntry("vehicle.roadveh_acceleration_model"));
1709  physics->Add(new SettingEntry("vehicle.roadveh_slope_steepness"));
1710  physics->Add(new SettingEntry("vehicle.smoke_amount"));
1711  physics->Add(new SettingEntry("vehicle.plane_speed"));
1712  }
1713 
1714  SettingsPage *routing = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_ROUTING));
1715  {
1716  routing->Add(new SettingEntry("pf.pathfinder_for_trains"));
1717  routing->Add(new SettingEntry("difficulty.line_reverse_mode"));
1718  routing->Add(new SettingEntry("pf.reverse_at_signals"));
1719  routing->Add(new SettingEntry("pf.forbid_90_deg"));
1720  routing->Add(new SettingEntry("pf.pathfinder_for_roadvehs"));
1721  routing->Add(new SettingEntry("pf.pathfinder_for_ships"));
1722  }
1723 
1724  vehicles->Add(new SettingEntry("order.no_servicing_if_no_breakdowns"));
1725  vehicles->Add(new SettingEntry("order.serviceathelipad"));
1726  }
1727 
1728  SettingsPage *limitations = main->Add(new SettingsPage(STR_CONFIG_SETTING_LIMITATIONS));
1729  {
1730  limitations->Add(new SettingEntry("construction.command_pause_level"));
1731  limitations->Add(new SettingEntry("construction.autoslope"));
1732  limitations->Add(new SettingEntry("construction.extra_dynamite"));
1733  limitations->Add(new SettingEntry("construction.map_height_limit"));
1734  limitations->Add(new SettingEntry("construction.max_bridge_length"));
1735  limitations->Add(new SettingEntry("construction.max_bridge_height"));
1736  limitations->Add(new SettingEntry("construction.max_tunnel_length"));
1737  limitations->Add(new SettingEntry("station.never_expire_airports"));
1738  limitations->Add(new SettingEntry("vehicle.never_expire_vehicles"));
1739  limitations->Add(new SettingEntry("vehicle.max_trains"));
1740  limitations->Add(new SettingEntry("vehicle.max_roadveh"));
1741  limitations->Add(new SettingEntry("vehicle.max_aircraft"));
1742  limitations->Add(new SettingEntry("vehicle.max_ships"));
1743  limitations->Add(new SettingEntry("vehicle.max_train_length"));
1744  limitations->Add(new SettingEntry("station.station_spread"));
1745  limitations->Add(new SettingEntry("station.distant_join_stations"));
1746  limitations->Add(new SettingEntry("construction.road_stop_on_town_road"));
1747  limitations->Add(new SettingEntry("construction.road_stop_on_competitor_road"));
1748  limitations->Add(new SettingEntry("vehicle.disable_elrails"));
1749  }
1750 
1751  SettingsPage *disasters = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCIDENTS));
1752  {
1753  disasters->Add(new SettingEntry("difficulty.disasters"));
1754  disasters->Add(new SettingEntry("difficulty.economy"));
1755  disasters->Add(new SettingEntry("difficulty.vehicle_breakdowns"));
1756  disasters->Add(new SettingEntry("vehicle.plane_crashes"));
1757  }
1758 
1759  SettingsPage *genworld = main->Add(new SettingsPage(STR_CONFIG_SETTING_GENWORLD));
1760  {
1761  genworld->Add(new SettingEntry("game_creation.landscape"));
1762  genworld->Add(new SettingEntry("game_creation.land_generator"));
1763  genworld->Add(new SettingEntry("difficulty.terrain_type"));
1764  genworld->Add(new SettingEntry("game_creation.tgen_smoothness"));
1765  genworld->Add(new SettingEntry("game_creation.variety"));
1766  genworld->Add(new SettingEntry("game_creation.snow_coverage"));
1767  genworld->Add(new SettingEntry("game_creation.snow_line_height"));
1768  genworld->Add(new SettingEntry("game_creation.desert_coverage"));
1769  genworld->Add(new SettingEntry("game_creation.amount_of_rivers"));
1770  genworld->Add(new SettingEntry("game_creation.tree_placer"));
1771  genworld->Add(new SettingEntry("vehicle.road_side"));
1772  genworld->Add(new SettingEntry("economy.larger_towns"));
1773  genworld->Add(new SettingEntry("economy.initial_city_size"));
1774  genworld->Add(new SettingEntry("economy.town_layout"));
1775  genworld->Add(new SettingEntry("difficulty.industry_density"));
1776  genworld->Add(new SettingEntry("gui.pause_on_newgame"));
1777  genworld->Add(new SettingEntry("game_creation.ending_year"));
1778  }
1779 
1780  SettingsPage *environment = main->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT));
1781  {
1782  SettingsPage *authorities = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_AUTHORITIES));
1783  {
1784  authorities->Add(new SettingEntry("difficulty.town_council_tolerance"));
1785  authorities->Add(new SettingEntry("economy.bribe"));
1786  authorities->Add(new SettingEntry("economy.exclusive_rights"));
1787  authorities->Add(new SettingEntry("economy.fund_roads"));
1788  authorities->Add(new SettingEntry("economy.fund_buildings"));
1789  authorities->Add(new SettingEntry("economy.station_noise_level"));
1790  }
1791 
1792  SettingsPage *towns = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TOWNS));
1793  {
1794  towns->Add(new SettingEntry("economy.town_growth_rate"));
1795  towns->Add(new SettingEntry("economy.allow_town_roads"));
1796  towns->Add(new SettingEntry("economy.allow_town_level_crossings"));
1797  towns->Add(new SettingEntry("economy.found_town"));
1798  towns->Add(new SettingEntry("economy.town_cargogen_mode"));
1799  }
1800 
1801  SettingsPage *industries = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_INDUSTRIES));
1802  {
1803  industries->Add(new SettingEntry("construction.raw_industry_construction"));
1804  industries->Add(new SettingEntry("construction.industry_platform"));
1805  industries->Add(new SettingEntry("economy.multiple_industry_per_town"));
1806  industries->Add(new SettingEntry("game_creation.oil_refinery_limit"));
1807  industries->Add(new SettingEntry("economy.type"));
1808  industries->Add(new SettingEntry("station.serve_neutral_industries"));
1809  }
1810 
1811  SettingsPage *cdist = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_CARGODIST));
1812  {
1813  cdist->Add(new SettingEntry("linkgraph.recalc_time"));
1814  cdist->Add(new SettingEntry("linkgraph.recalc_interval"));
1815  cdist->Add(new SettingEntry("linkgraph.distribution_pax"));
1816  cdist->Add(new SettingEntry("linkgraph.distribution_mail"));
1817  cdist->Add(new SettingEntry("linkgraph.distribution_armoured"));
1818  cdist->Add(new SettingEntry("linkgraph.distribution_default"));
1819  cdist->Add(new SettingEntry("linkgraph.accuracy"));
1820  cdist->Add(new SettingEntry("linkgraph.demand_distance"));
1821  cdist->Add(new SettingEntry("linkgraph.demand_size"));
1822  cdist->Add(new SettingEntry("linkgraph.short_path_saturation"));
1823  }
1824 
1825  environment->Add(new SettingEntry("station.modified_catchment"));
1826  environment->Add(new SettingEntry("construction.extra_tree_placement"));
1827  }
1828 
1829  SettingsPage *ai = main->Add(new SettingsPage(STR_CONFIG_SETTING_AI));
1830  {
1831  SettingsPage *npc = ai->Add(new SettingsPage(STR_CONFIG_SETTING_AI_NPC));
1832  {
1833  npc->Add(new SettingEntry("script.settings_profile"));
1834  npc->Add(new SettingEntry("script.script_max_opcode_till_suspend"));
1835  npc->Add(new SettingEntry("script.script_max_memory_megabytes"));
1836  npc->Add(new SettingEntry("difficulty.competitor_speed"));
1837  npc->Add(new SettingEntry("ai.ai_in_multiplayer"));
1838  npc->Add(new SettingEntry("ai.ai_disable_veh_train"));
1839  npc->Add(new SettingEntry("ai.ai_disable_veh_roadveh"));
1840  npc->Add(new SettingEntry("ai.ai_disable_veh_aircraft"));
1841  npc->Add(new SettingEntry("ai.ai_disable_veh_ship"));
1842  }
1843 
1844  ai->Add(new SettingEntry("economy.give_money"));
1845  ai->Add(new SettingEntry("economy.allow_shares"));
1846  ai->Add(new SettingEntry("economy.min_years_for_shares"));
1847  }
1848 
1849  SettingsPage *network = main->Add(new SettingsPage(STR_CONFIG_SETTING_NETWORK));
1850  {
1851  network->Add(new SettingEntry("network.use_relay_service"));
1852  }
1853 
1854  main->Init();
1855  }
1856  return *main;
1857 }
1858 
1859 static const StringID _game_settings_restrict_dropdown[] = {
1860  STR_CONFIG_SETTING_RESTRICT_BASIC, // RM_BASIC
1861  STR_CONFIG_SETTING_RESTRICT_ADVANCED, // RM_ADVANCED
1862  STR_CONFIG_SETTING_RESTRICT_ALL, // RM_ALL
1863  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT, // RM_CHANGED_AGAINST_DEFAULT
1864  STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW, // RM_CHANGED_AGAINST_NEW
1865 };
1866 static_assert(lengthof(_game_settings_restrict_dropdown) == RM_END);
1867 
1874 };
1875 
1881 static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
1882 {
1883  if (confirmed) {
1886  w->InvalidateData();
1887  }
1888 }
1889 
1892  static const int SETTINGTREE_LEFT_OFFSET = 5;
1893  static const int SETTINGTREE_RIGHT_OFFSET = 5;
1894  static const int SETTINGTREE_TOP_OFFSET = 5;
1895  static const int SETTINGTREE_BOTTOM_OFFSET = 5;
1896 
1898 
1904 
1910 
1911  Scrollbar *vscroll;
1912 
1914  {
1915  this->warn_missing = WHR_NONE;
1916  this->warn_lines = 0;
1918  this->filter.min_cat = RM_ALL;
1919  this->filter.type = ST_ALL;
1920  this->filter.type_hides = false;
1921  this->settings_ptr = &GetGameSettings();
1922 
1923  _circle_size = maxdim(GetSpriteSize(SPR_CIRCLE_FOLDED), GetSpriteSize(SPR_CIRCLE_UNFOLDED));
1924  GetSettingsTree().FoldAll(); // Close all sub-pages
1925 
1926  this->valuewindow_entry = nullptr; // No setting entry for which a entry window is opened
1927  this->clicked_entry = nullptr; // No numeric setting buttons are depressed
1928  this->last_clicked = nullptr;
1929  this->valuedropdown_entry = nullptr;
1930  this->closing_dropdown = false;
1931  this->manually_changed_folding = false;
1932 
1933  this->CreateNestedTree();
1934  this->vscroll = this->GetScrollbar(WID_GS_SCROLLBAR);
1936 
1937  this->querystrings[WID_GS_FILTER] = &this->filter_editbox;
1938  this->filter_editbox.cancel_button = QueryString::ACTION_CLEAR;
1940 
1941  this->InvalidateData();
1942  }
1943 
1944  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1945  {
1946  switch (widget) {
1947  case WID_GS_OPTIONSPANEL:
1948  resize->height = SETTING_HEIGHT = std::max({(int)_circle_size.height, SETTING_BUTTON_HEIGHT, FONT_HEIGHT_NORMAL}) + 1;
1949  resize->width = 1;
1950 
1951  size->height = 5 * resize->height + SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET;
1952  break;
1953 
1954  case WID_GS_HELP_TEXT: {
1955  static const StringID setting_types[] = {
1956  STR_CONFIG_SETTING_TYPE_CLIENT,
1957  STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
1958  STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
1959  };
1960  for (uint i = 0; i < lengthof(setting_types); i++) {
1961  SetDParam(0, setting_types[i]);
1962  size->width = std::max(size->width, GetStringBoundingBox(STR_CONFIG_SETTING_TYPE).width);
1963  }
1964  size->height = 2 * FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL +
1965  std::max(size->height, GetSettingsTree().GetMaxHelpHeight(size->width));
1966  break;
1967  }
1968 
1970  case WID_GS_RESTRICT_TYPE:
1971  size->width = std::max(GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_CATEGORY).width, GetStringBoundingBox(STR_CONFIG_SETTING_RESTRICT_TYPE).width);
1972  break;
1973 
1974  default:
1975  break;
1976  }
1977  }
1978 
1979  void OnPaint() override
1980  {
1981  if (this->closing_dropdown) {
1982  this->closing_dropdown = false;
1983  assert(this->valuedropdown_entry != nullptr);
1984  this->valuedropdown_entry->SetButtons(0);
1985  this->valuedropdown_entry = nullptr;
1986  }
1987 
1988  /* Reserve the correct number of lines for the 'some search results are hidden' notice in the central settings display panel. */
1989  const NWidgetBase *panel = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
1990  StringID warn_str = STR_CONFIG_SETTING_CATEGORY_HIDES - 1 + this->warn_missing;
1991  int new_warn_lines;
1992  if (this->warn_missing == WHR_NONE) {
1993  new_warn_lines = 0;
1994  } else {
1995  SetDParam(0, _game_settings_restrict_dropdown[this->filter.min_cat]);
1996  new_warn_lines = GetStringLineCount(warn_str, panel->current_x);
1997  }
1998  if (this->warn_lines != new_warn_lines) {
1999  this->vscroll->SetCount(this->vscroll->GetCount() - this->warn_lines + new_warn_lines);
2000  this->warn_lines = new_warn_lines;
2001  }
2002 
2003  this->DrawWidgets();
2004 
2005  /* Draw the 'some search results are hidden' notice. */
2006  if (this->warn_missing != WHR_NONE) {
2007  const int left = panel->pos_x;
2008  const int right = left + panel->current_x - 1;
2009  const int top = panel->pos_y + WD_FRAMETEXT_TOP + (SETTING_HEIGHT - FONT_HEIGHT_NORMAL) * this->warn_lines / 2;
2010  SetDParam(0, _game_settings_restrict_dropdown[this->filter.min_cat]);
2011  if (this->warn_lines == 1) {
2012  /* If the warning fits at one line, center it. */
2013  DrawString(left + WD_FRAMETEXT_LEFT, right - WD_FRAMETEXT_RIGHT, top, warn_str, TC_FROMSTRING, SA_HOR_CENTER);
2014  } else {
2015  DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, INT32_MAX, warn_str, TC_FROMSTRING, SA_HOR_CENTER);
2016  }
2017  }
2018  }
2019 
2020  void SetStringParameters(int widget) const override
2021  {
2022  switch (widget) {
2024  SetDParam(0, _game_settings_restrict_dropdown[this->filter.mode]);
2025  break;
2026 
2027  case WID_GS_TYPE_DROPDOWN:
2028  switch (this->filter.type) {
2029  case ST_GAME: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME); break;
2030  case ST_COMPANY: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME); break;
2031  case ST_CLIENT: SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT); break;
2032  default: SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL); break;
2033  }
2034  break;
2035  }
2036  }
2037 
2038  DropDownList BuildDropDownList(int widget) const
2039  {
2040  DropDownList list;
2041  switch (widget) {
2043  for (int mode = 0; mode != RM_END; mode++) {
2044  /* If we are in adv. settings screen for the new game's settings,
2045  * we don't want to allow comparing with new game's settings. */
2046  bool disabled = mode == RM_CHANGED_AGAINST_NEW && settings_ptr == &_settings_newgame;
2047 
2048  list.emplace_back(new DropDownListStringItem(_game_settings_restrict_dropdown[mode], mode, disabled));
2049  }
2050  break;
2051 
2052  case WID_GS_TYPE_DROPDOWN:
2053  list.emplace_back(new DropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL, ST_ALL, false));
2054  list.emplace_back(new DropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME, ST_GAME, false));
2055  list.emplace_back(new DropDownListStringItem(_game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME, ST_COMPANY, false));
2056  list.emplace_back(new DropDownListStringItem(STR_CONFIG_SETTING_TYPE_DROPDOWN_CLIENT, ST_CLIENT, false));
2057  break;
2058  }
2059  return list;
2060  }
2061 
2062  void DrawWidget(const Rect &r, int widget) const override
2063  {
2064  switch (widget) {
2065  case WID_GS_OPTIONSPANEL: {
2066  int top_pos = r.top + SETTINGTREE_TOP_OFFSET + 1 + this->warn_lines * SETTING_HEIGHT;
2067  uint last_row = this->vscroll->GetPosition() + this->vscroll->GetCapacity() - this->warn_lines;
2068  int next_row = GetSettingsTree().Draw(settings_ptr, r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos,
2069  this->vscroll->GetPosition(), last_row, this->last_clicked);
2070  if (next_row == 0) DrawString(r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos, STR_CONFIG_SETTINGS_NONE);
2071  break;
2072  }
2073 
2074  case WID_GS_HELP_TEXT:
2075  if (this->last_clicked != nullptr) {
2076  const IntSettingDesc *sd = this->last_clicked->setting;
2077 
2078  int y = r.top;
2079  switch (sd->GetType()) {
2080  case ST_COMPANY: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME); break;
2081  case ST_CLIENT: SetDParam(0, STR_CONFIG_SETTING_TYPE_CLIENT); break;
2082  case ST_GAME: SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME); break;
2083  default: NOT_REACHED();
2084  }
2085  DrawString(r.left, r.right, y, STR_CONFIG_SETTING_TYPE);
2086  y += FONT_HEIGHT_NORMAL;
2087 
2088  this->last_clicked->SetValueDParams(0, sd->def);
2089  DrawString(r.left, r.right, y, STR_CONFIG_SETTING_DEFAULT_VALUE);
2091 
2092  DrawStringMultiLine(r.left, r.right, y, r.bottom, this->last_clicked->GetHelpText(), TC_WHITE);
2093  }
2094  break;
2095 
2096  default:
2097  break;
2098  }
2099  }
2100 
2106  {
2107  if (this->last_clicked != pe) this->SetDirty();
2108  this->last_clicked = pe;
2109  }
2110 
2111  void OnClick(Point pt, int widget, int click_count) override
2112  {
2113  switch (widget) {
2114  case WID_GS_EXPAND_ALL:
2115  this->manually_changed_folding = true;
2117  this->InvalidateData();
2118  break;
2119 
2120  case WID_GS_COLLAPSE_ALL:
2121  this->manually_changed_folding = true;
2123  this->InvalidateData();
2124  break;
2125 
2126  case WID_GS_RESET_ALL:
2127  ShowQuery(
2128  STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_CAPTION,
2129  STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_TEXT,
2130  this,
2132  );
2133  break;
2134 
2135  case WID_GS_RESTRICT_DROPDOWN: {
2136  DropDownList list = this->BuildDropDownList(widget);
2137  if (!list.empty()) {
2138  ShowDropDownList(this, std::move(list), this->filter.mode, widget);
2139  }
2140  break;
2141  }
2142 
2143  case WID_GS_TYPE_DROPDOWN: {
2144  DropDownList list = this->BuildDropDownList(widget);
2145  if (!list.empty()) {
2146  ShowDropDownList(this, std::move(list), this->filter.type, widget);
2147  }
2148  break;
2149  }
2150  }
2151 
2152  if (widget != WID_GS_OPTIONSPANEL) return;
2153 
2154  uint btn = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_GS_OPTIONSPANEL, SETTINGTREE_TOP_OFFSET);
2155  if (btn == INT_MAX || (int)btn < this->warn_lines) return;
2156  btn -= this->warn_lines;
2157 
2158  uint cur_row = 0;
2160 
2161  if (clicked_entry == nullptr) return; // Clicked below the last setting of the page
2162 
2163  int x = (_current_text_dir == TD_RTL ? this->width - 1 - pt.x : pt.x) - SETTINGTREE_LEFT_OFFSET - (clicked_entry->level + 1) * LEVEL_WIDTH; // Shift x coordinate
2164  if (x < 0) return; // Clicked left of the entry
2165 
2166  SettingsPage *clicked_page = dynamic_cast<SettingsPage*>(clicked_entry);
2167  if (clicked_page != nullptr) {
2168  this->SetDisplayedHelpText(nullptr);
2169  clicked_page->folded = !clicked_page->folded; // Flip 'folded'-ness of the sub-page
2170 
2171  this->manually_changed_folding = true;
2172 
2173  this->InvalidateData();
2174  return;
2175  }
2176 
2177  SettingEntry *pe = dynamic_cast<SettingEntry*>(clicked_entry);
2178  assert(pe != nullptr);
2179  const IntSettingDesc *sd = pe->setting;
2180 
2181  /* return if action is only active in network, or only settable by server */
2182  if (!sd->IsEditable()) {
2183  this->SetDisplayedHelpText(pe);
2184  return;
2185  }
2186 
2187  int32 value = sd->Read(ResolveObject(settings_ptr, sd));
2188 
2189  /* clicked on the icon on the left side. Either scroller, bool on/off or dropdown */
2190  if (x < SETTING_BUTTON_WIDTH && (sd->flags & SF_GUI_DROPDOWN)) {
2191  this->SetDisplayedHelpText(pe);
2192 
2193  if (this->valuedropdown_entry == pe) {
2194  /* unclick the dropdown */
2195  HideDropDownMenu(this);
2196  this->closing_dropdown = false;
2197  this->valuedropdown_entry->SetButtons(0);
2198  this->valuedropdown_entry = nullptr;
2199  } else {
2200  if (this->valuedropdown_entry != nullptr) this->valuedropdown_entry->SetButtons(0);
2201  this->closing_dropdown = false;
2202 
2203  const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_GS_OPTIONSPANEL);
2204  int rel_y = (pt.y - (int)wid->pos_y - SETTINGTREE_TOP_OFFSET) % wid->resize_y;
2205 
2206  Rect wi_rect;
2207  wi_rect.left = pt.x - (_current_text_dir == TD_RTL ? SETTING_BUTTON_WIDTH - 1 - x : x);
2208  wi_rect.right = wi_rect.left + SETTING_BUTTON_WIDTH - 1;
2209  wi_rect.top = pt.y - rel_y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
2210  wi_rect.bottom = wi_rect.top + SETTING_BUTTON_HEIGHT - 1;
2211 
2212  /* For dropdowns we also have to check the y position thoroughly, the mouse may not above the just opening dropdown */
2213  if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
2214  this->valuedropdown_entry = pe;
2215  this->valuedropdown_entry->SetButtons(SEF_LEFT_DEPRESSED);
2216 
2217  DropDownList list;
2218  for (int i = sd->min; i <= (int)sd->max; i++) {
2219  list.emplace_back(new DropDownListStringItem(sd->str_val + i - sd->min, i, false));
2220  }
2221 
2222  ShowDropDownListAt(this, std::move(list), value, -1, wi_rect, COLOUR_ORANGE, true);
2223  }
2224  }
2225  this->SetDirty();
2226  } else if (x < SETTING_BUTTON_WIDTH) {
2227  this->SetDisplayedHelpText(pe);
2228  int32 oldvalue = value;
2229 
2230  if (sd->IsBoolSetting()) {
2231  value ^= 1;
2232  } else {
2233  /* Add a dynamic step-size to the scroller. In a maximum of
2234  * 50-steps you should be able to get from min to max,
2235  * unless specified otherwise in the 'interval' variable
2236  * of the current setting. */
2237  uint32 step = (sd->interval == 0) ? ((sd->max - sd->min) / 50) : sd->interval;
2238  if (step == 0) step = 1;
2239 
2240  /* don't allow too fast scrolling */
2241  if ((this->flags & WF_TIMEOUT) && this->timeout_timer > 1) {
2242  _left_button_clicked = false;
2243  return;
2244  }
2245 
2246  /* Increase or decrease the value and clamp it to extremes */
2247  if (x >= SETTING_BUTTON_WIDTH / 2) {
2248  value += step;
2249  if (sd->min < 0) {
2250  assert((int32)sd->max >= 0);
2251  if (value > (int32)sd->max) value = (int32)sd->max;
2252  } else {
2253  if ((uint32)value > sd->max) value = (int32)sd->max;
2254  }
2255  if (value < sd->min) value = sd->min; // skip between "disabled" and minimum
2256  } else {
2257  value -= step;
2258  if (value < sd->min) value = (sd->flags & SF_GUI_0_IS_SPECIAL) ? 0 : sd->min;
2259  }
2260 
2261  /* Set up scroller timeout for numeric values */
2262  if (value != oldvalue) {
2263  if (this->clicked_entry != nullptr) { // Release previous buttons if any
2264  this->clicked_entry->SetButtons(0);
2265  }
2266  this->clicked_entry = pe;
2267  this->clicked_entry->SetButtons((x >= SETTING_BUTTON_WIDTH / 2) != (_current_text_dir == TD_RTL) ? SEF_RIGHT_DEPRESSED : SEF_LEFT_DEPRESSED);
2268  this->SetTimeout();
2269  _left_button_clicked = false;
2270  }
2271  }
2272 
2273  if (value != oldvalue) {
2274  SetSettingValue(sd, value);
2275  this->SetDirty();
2276  }
2277  } else {
2278  /* Only open editbox if clicked for the second time, and only for types where it is sensible for. */
2279  if (this->last_clicked == pe && !sd->IsBoolSetting() && !(sd->flags & SF_GUI_DROPDOWN)) {
2280  int64 value64 = value;
2281  /* Show the correct currency-translated value */
2282  if (sd->flags & SF_GUI_CURRENCY) value64 *= _currency->rate;
2283 
2284  this->valuewindow_entry = pe;
2285  SetDParam(0, value64);
2286  /* Limit string length to 14 so that MAX_INT32 * max currency rate doesn't exceed MAX_INT64. */
2287  ShowQueryString(STR_JUST_INT, STR_CONFIG_SETTING_QUERY_CAPTION, 15, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
2288  }
2289  this->SetDisplayedHelpText(pe);
2290  }
2291  }
2292 
2293  void OnTimeout() override
2294  {
2295  if (this->clicked_entry != nullptr) { // On timeout, release any depressed buttons
2296  this->clicked_entry->SetButtons(0);
2297  this->clicked_entry = nullptr;
2298  this->SetDirty();
2299  }
2300  }
2301 
2302  void OnQueryTextFinished(char *str) override
2303  {
2304  /* The user pressed cancel */
2305  if (str == nullptr) return;
2306 
2307  assert(this->valuewindow_entry != nullptr);
2308  const IntSettingDesc *sd = this->valuewindow_entry->setting;
2309 
2310  int32 value;
2311  if (!StrEmpty(str)) {
2312  long long llvalue = atoll(str);
2313 
2314  /* Save the correct currency-translated value */
2315  if (sd->flags & SF_GUI_CURRENCY) llvalue /= _currency->rate;
2316 
2317  value = (int32)ClampToI32(llvalue);
2318  } else {
2319  value = sd->def;
2320  }
2321 
2322  SetSettingValue(this->valuewindow_entry->setting, value);
2323  this->SetDirty();
2324  }
2325 
2326  void OnDropdownSelect(int widget, int index) override
2327  {
2328  switch (widget) {
2330  this->filter.mode = (RestrictionMode)index;
2331  if (this->filter.mode == RM_CHANGED_AGAINST_DEFAULT ||
2332  this->filter.mode == RM_CHANGED_AGAINST_NEW) {
2333 
2334  if (!this->manually_changed_folding) {
2335  /* Expand all when selecting 'changes'. Update the filter state first, in case it becomes less restrictive in some cases. */
2336  GetSettingsTree().UpdateFilterState(this->filter, false);
2338  }
2339  } else {
2340  /* Non-'changes' filter. Save as default. */
2342  }
2343  this->InvalidateData();
2344  break;
2345 
2346  case WID_GS_TYPE_DROPDOWN:
2347  this->filter.type = (SettingType)index;
2348  this->InvalidateData();
2349  break;
2350 
2351  default:
2352  if (widget < 0) {
2353  /* Deal with drop down boxes on the panel. */
2354  assert(this->valuedropdown_entry != nullptr);
2355  const IntSettingDesc *sd = this->valuedropdown_entry->setting;
2356  assert(sd->flags & SF_GUI_DROPDOWN);
2357 
2358  SetSettingValue(sd, index);
2359  this->SetDirty();
2360  }
2361  break;
2362  }
2363  }
2364 
2365  void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
2366  {
2367  if (widget >= 0) {
2368  /* Normally the default implementation of OnDropdownClose() takes care of
2369  * a few things. We want that behaviour here too, but only for
2370  * "normal" dropdown boxes. The special dropdown boxes added for every
2371  * setting that needs one can't have this call. */
2372  Window::OnDropdownClose(pt, widget, index, instant_close);
2373  } else {
2374  /* We cannot raise the dropdown button just yet. OnClick needs some hint, whether
2375  * the same dropdown button was clicked again, and then not open the dropdown again.
2376  * So, we only remember that it was closed, and process it on the next OnPaint, which is
2377  * after OnClick. */
2378  assert(this->valuedropdown_entry != nullptr);
2379  this->closing_dropdown = true;
2380  this->SetDirty();
2381  }
2382  }
2383 
2384  void OnInvalidateData(int data = 0, bool gui_scope = true) override
2385  {
2386  if (!gui_scope) return;
2387 
2388  /* Update which settings are to be visible. */
2389  RestrictionMode min_level = (this->filter.mode <= RM_ALL) ? this->filter.mode : RM_BASIC;
2390  this->filter.min_cat = min_level;
2391  this->filter.type_hides = false;
2392  GetSettingsTree().UpdateFilterState(this->filter, false);
2393 
2394  if (this->filter.string.IsEmpty()) {
2395  this->warn_missing = WHR_NONE;
2396  } else if (min_level < this->filter.min_cat) {
2397  this->warn_missing = this->filter.type_hides ? WHR_CATEGORY_TYPE : WHR_CATEGORY;
2398  } else {
2399  this->warn_missing = this->filter.type_hides ? WHR_TYPE : WHR_NONE;
2400  }
2401  this->vscroll->SetCount(GetSettingsTree().Length() + this->warn_lines);
2402 
2403  if (this->last_clicked != nullptr && !GetSettingsTree().IsVisible(this->last_clicked)) {
2404  this->SetDisplayedHelpText(nullptr);
2405  }
2406 
2407  bool all_folded = true;
2408  bool all_unfolded = true;
2409  GetSettingsTree().GetFoldingState(all_folded, all_unfolded);
2410  this->SetWidgetDisabledState(WID_GS_EXPAND_ALL, all_unfolded);
2411  this->SetWidgetDisabledState(WID_GS_COLLAPSE_ALL, all_folded);
2412  }
2413 
2414  void OnEditboxChanged(int wid) override
2415  {
2416  if (wid == WID_GS_FILTER) {
2417  this->filter.string.SetFilterTerm(this->filter_editbox.text.buf);
2418  if (!this->filter.string.IsEmpty() && !this->manually_changed_folding) {
2419  /* User never expanded/collapsed single pages and entered a filter term.
2420  * Expand everything, to save weird expand clicks, */
2422  }
2423  this->InvalidateData();
2424  }
2425  }
2426 
2427  void OnResize() override
2428  {
2430  }
2431 };
2432 
2434 
2435 static const NWidgetPart _nested_settings_selection_widgets[] = {
2437  NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
2438  NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_CONFIG_SETTING_TREE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2439  NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
2440  EndContainer(),
2441  NWidget(WWT_PANEL, COLOUR_MAUVE),
2444  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_CATEGORY), SetDataTip(STR_CONFIG_SETTING_RESTRICT_CATEGORY, STR_NULL),
2445  NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_GS_RESTRICT_DROPDOWN), SetMinimalSize(100, 12), SetDataTip(STR_BLACK_STRING, STR_CONFIG_SETTING_RESTRICT_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
2446  EndContainer(),
2448  NWidget(WWT_TEXT, COLOUR_MAUVE, WID_GS_RESTRICT_TYPE), SetDataTip(STR_CONFIG_SETTING_RESTRICT_TYPE, STR_NULL),
2449  NWidget(WWT_DROPDOWN, COLOUR_MAUVE, WID_GS_TYPE_DROPDOWN), SetMinimalSize(100, 12), SetDataTip(STR_BLACK_STRING, STR_CONFIG_SETTING_TYPE_DROPDOWN_HELPTEXT), SetFill(1, 0), SetResize(1, 0),
2450  EndContainer(),
2451  EndContainer(),
2454  NWidget(WWT_TEXT, COLOUR_MAUVE), SetFill(0, 1), SetDataTip(STR_CONFIG_SETTING_FILTER_TITLE, STR_NULL),
2455  NWidget(WWT_EDITBOX, COLOUR_MAUVE, WID_GS_FILTER), SetFill(1, 0), SetMinimalSize(50, 12), SetResize(1, 0),
2456  SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
2457  EndContainer(),
2458  EndContainer(),
2461  NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_GS_SCROLLBAR),
2462  EndContainer(),
2463  NWidget(WWT_PANEL, COLOUR_MAUVE), SetMinimalSize(400, 40),
2464  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GS_HELP_TEXT), SetMinimalSize(300, 25), SetFill(1, 1), SetResize(1, 0),
2466  EndContainer(),
2468  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_EXPAND_ALL), SetDataTip(STR_CONFIG_SETTING_EXPAND_ALL, STR_NULL),
2469  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_COLLAPSE_ALL), SetDataTip(STR_CONFIG_SETTING_COLLAPSE_ALL, STR_NULL),
2470  NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_GS_RESET_ALL), SetDataTip(STR_CONFIG_SETTING_RESET_ALL, STR_NULL),
2471  NWidget(WWT_PANEL, COLOUR_MAUVE), SetFill(1, 0), SetResize(1, 0),
2472  EndContainer(),
2473  NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
2474  EndContainer(),
2475 };
2476 
2477 static WindowDesc _settings_selection_desc(
2478  WDP_CENTER, "settings", 510, 450,
2480  0,
2481  _nested_settings_selection_widgets, lengthof(_nested_settings_selection_widgets)
2482 );
2483 
2486 {
2488  new GameSettingsWindow(&_settings_selection_desc);
2489 }
2490 
2491 
2501 void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
2502 {
2503  int colour = _colour_gradient[button_colour][2];
2504  Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
2505 
2506  DrawFrameRect(x, y, x + dim.width - 1, y + dim.height - 1, button_colour, (state == 1) ? FR_LOWERED : FR_NONE);
2507  DrawFrameRect(x + dim.width, y, x + dim.width + dim.width - 1, y + dim.height - 1, button_colour, (state == 2) ? FR_LOWERED : FR_NONE);
2508  DrawSprite(SPR_ARROW_LEFT, PAL_NONE, x + WD_IMGBTN_LEFT, y + WD_IMGBTN_TOP);
2509  DrawSprite(SPR_ARROW_RIGHT, PAL_NONE, x + WD_IMGBTN_LEFT + dim.width, y + WD_IMGBTN_TOP);
2510 
2511  /* Grey out the buttons that aren't clickable */
2512  bool rtl = _current_text_dir == TD_RTL;
2513  if (rtl ? !clickable_right : !clickable_left) {
2514  GfxFillRect(x + 1, y, x + dim.width - 1, y + dim.height - 2, colour, FILLRECT_CHECKER);
2515  }
2516  if (rtl ? !clickable_left : !clickable_right) {
2517  GfxFillRect(x + dim.width + 1, y, x + dim.width + dim.width - 1, y + dim.height - 2, colour, FILLRECT_CHECKER);
2518  }
2519 }
2520 
2529 void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
2530 {
2531  int colour = _colour_gradient[button_colour][2];
2532 
2533  DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, button_colour, state ? FR_LOWERED : FR_NONE);
2534  DrawSprite(SPR_ARROW_DOWN, PAL_NONE, x + (SETTING_BUTTON_WIDTH - NWidgetScrollbar::GetVerticalDimension().width) / 2 + state, y + 2 + state);
2535 
2536  if (!clickable) {
2537  GfxFillRect(x + 1, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 2, colour, FILLRECT_CHECKER);
2538  }
2539 }
2540 
2548 void DrawBoolButton(int x, int y, bool state, bool clickable)
2549 {
2550  static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
2551  DrawFrameRect(x, y, x + SETTING_BUTTON_WIDTH - 1, y + SETTING_BUTTON_HEIGHT - 1, _bool_ctabs[state][clickable], state ? FR_LOWERED : FR_NONE);
2552 }
2553 
2555  int query_widget;
2556 
2557  CustomCurrencyWindow(WindowDesc *desc) : Window(desc)
2558  {
2559  this->InitNested();
2560 
2561  SetButtonState();
2562  }
2563 
2564  void SetButtonState()
2565  {
2566  this->SetWidgetDisabledState(WID_CC_RATE_DOWN, _custom_currency.rate == 1);
2567  this->SetWidgetDisabledState(WID_CC_RATE_UP, _custom_currency.rate == UINT16_MAX);
2568  this->SetWidgetDisabledState(WID_CC_YEAR_DOWN, _custom_currency.to_euro == CF_NOEURO);
2569  this->SetWidgetDisabledState(WID_CC_YEAR_UP, _custom_currency.to_euro == MAX_YEAR);
2570  }
2571 
2572  void SetStringParameters(int widget) const override
2573  {
2574  switch (widget) {
2575  case WID_CC_RATE: SetDParam(0, 1); SetDParam(1, 1); break;
2576  case WID_CC_SEPARATOR: SetDParamStr(0, _custom_currency.separator); break;
2577  case WID_CC_PREFIX: SetDParamStr(0, _custom_currency.prefix); break;
2578  case WID_CC_SUFFIX: SetDParamStr(0, _custom_currency.suffix); break;
2579  case WID_CC_YEAR:
2580  SetDParam(0, (_custom_currency.to_euro != CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
2581  SetDParam(1, _custom_currency.to_euro);
2582  break;
2583 
2584  case WID_CC_PREVIEW:
2585  SetDParam(0, 10000);
2586  break;
2587  }
2588  }
2589 
2590  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
2591  {
2592  switch (widget) {
2593  /* Set the appropriate width for the edit 'buttons' */
2594  case WID_CC_SEPARATOR_EDIT:
2595  case WID_CC_PREFIX_EDIT:
2596  case WID_CC_SUFFIX_EDIT:
2597  size->width = this->GetWidget<NWidgetBase>(WID_CC_RATE_DOWN)->smallest_x + this->GetWidget<NWidgetBase>(WID_CC_RATE_UP)->smallest_x;
2598  break;
2599 
2600  /* Make sure the window is wide enough for the widest exchange rate */
2601  case WID_CC_RATE:
2602  SetDParam(0, 1);
2603  SetDParam(1, INT32_MAX);
2604  *size = GetStringBoundingBox(STR_CURRENCY_EXCHANGE_RATE);
2605  break;
2606  }
2607  }
2608 
2609  void OnClick(Point pt, int widget, int click_count) override
2610  {
2611  int line = 0;
2612  int len = 0;
2613  StringID str = 0;
2614  CharSetFilter afilter = CS_ALPHANUMERAL;
2615 
2616  switch (widget) {
2617  case WID_CC_RATE_DOWN:
2618  if (_custom_currency.rate > 1) _custom_currency.rate--;
2619  if (_custom_currency.rate == 1) this->DisableWidget(WID_CC_RATE_DOWN);
2621  break;
2622 
2623  case WID_CC_RATE_UP:
2624  if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
2625  if (_custom_currency.rate == UINT16_MAX) this->DisableWidget(WID_CC_RATE_UP);
2627  break;
2628 
2629  case WID_CC_RATE:
2630  SetDParam(0, _custom_currency.rate);
2631  str = STR_JUST_INT;
2632  len = 5;
2633  line = WID_CC_RATE;
2634  afilter = CS_NUMERAL;
2635  break;
2636 
2637  case WID_CC_SEPARATOR_EDIT:
2638  case WID_CC_SEPARATOR:
2639  SetDParamStr(0, _custom_currency.separator);
2640  str = STR_JUST_RAW_STRING;
2641  len = 7;
2642  line = WID_CC_SEPARATOR;
2643  break;
2644 
2645  case WID_CC_PREFIX_EDIT:
2646  case WID_CC_PREFIX:
2647  SetDParamStr(0, _custom_currency.prefix);
2648  str = STR_JUST_RAW_STRING;
2649  len = 15;
2650  line = WID_CC_PREFIX;
2651  break;
2652 
2653  case WID_CC_SUFFIX_EDIT:
2654  case WID_CC_SUFFIX:
2655  SetDParamStr(0, _custom_currency.suffix);
2656  str = STR_JUST_RAW_STRING;
2657  len = 15;
2658  line = WID_CC_SUFFIX;
2659  break;
2660 
2661  case WID_CC_YEAR_DOWN:
2662  _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ? CF_NOEURO : _custom_currency.to_euro - 1;
2663  if (_custom_currency.to_euro == CF_NOEURO) this->DisableWidget(WID_CC_YEAR_DOWN);
2665  break;
2666 
2667  case WID_CC_YEAR_UP:
2668  _custom_currency.to_euro = Clamp(_custom_currency.to_euro + 1, 2000, MAX_YEAR);
2669  if (_custom_currency.to_euro == MAX_YEAR) this->DisableWidget(WID_CC_YEAR_UP);
2671  break;
2672 
2673  case WID_CC_YEAR:
2674  SetDParam(0, _custom_currency.to_euro);
2675  str = STR_JUST_INT;
2676  len = 7;
2677  line = WID_CC_YEAR;
2678  afilter = CS_NUMERAL;
2679  break;
2680  }
2681 
2682  if (len != 0) {
2683  this->query_widget = line;
2684  ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1, this, afilter, QSF_NONE);
2685  }
2686 
2687  this->SetTimeout();
2688  this->SetDirty();
2689  }
2690 
2691  void OnQueryTextFinished(char *str) override
2692  {
2693  if (str == nullptr) return;
2694 
2695  switch (this->query_widget) {
2696  case WID_CC_RATE:
2697  _custom_currency.rate = Clamp(atoi(str), 1, UINT16_MAX);
2698  break;
2699 
2700  case WID_CC_SEPARATOR: // Thousands separator
2701  _custom_currency.separator = str;
2702  break;
2703 
2704  case WID_CC_PREFIX:
2705  _custom_currency.prefix = str;
2706  break;
2707 
2708  case WID_CC_SUFFIX:
2709  _custom_currency.suffix = str;
2710  break;
2711 
2712  case WID_CC_YEAR: { // Year to switch to euro
2713  int val = atoi(str);
2714 
2715  _custom_currency.to_euro = (val < 2000 ? CF_NOEURO : std::min(val, MAX_YEAR));
2716  break;
2717  }
2718  }
2720  SetButtonState();
2721  }
2722 
2723  void OnTimeout() override
2724  {
2725  this->SetDirty();
2726  }
2727 };
2728 
2729 static const NWidgetPart _nested_cust_currency_widgets[] = {
2731  NWidget(WWT_CLOSEBOX, COLOUR_GREY),
2732  NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_CURRENCY_WINDOW, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
2733  EndContainer(),
2734  NWidget(WWT_PANEL, COLOUR_GREY),
2736  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2737  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_EXCHANGE_RATE_TOOLTIP),
2738  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_RATE_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_EXCHANGE_RATE_TOOLTIP),
2740  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_RATE), SetDataTip(STR_CURRENCY_EXCHANGE_RATE, STR_CURRENCY_SET_EXCHANGE_RATE_TOOLTIP), SetFill(1, 0),
2741  EndContainer(),
2742  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2743  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SEPARATOR_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(0, 1),
2745  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SEPARATOR), SetDataTip(STR_CURRENCY_SEPARATOR, STR_CURRENCY_SET_CUSTOM_CURRENCY_SEPARATOR_TOOLTIP), SetFill(1, 0),
2746  EndContainer(),
2747  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2748  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_PREFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(0, 1),
2750  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_PREFIX), SetDataTip(STR_CURRENCY_PREFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_PREFIX_TOOLTIP), SetFill(1, 0),
2751  EndContainer(),
2752  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2753  NWidget(WWT_PUSHBTN, COLOUR_DARK_BLUE, WID_CC_SUFFIX_EDIT), SetDataTip(0x0, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(0, 1),
2755  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_SUFFIX), SetDataTip(STR_CURRENCY_SUFFIX, STR_CURRENCY_SET_CUSTOM_CURRENCY_SUFFIX_TOOLTIP), SetFill(1, 0),
2756  EndContainer(),
2757  NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 5),
2758  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_DOWN), SetDataTip(AWV_DECREASE, STR_CURRENCY_DECREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2759  NWidget(WWT_PUSHARROWBTN, COLOUR_YELLOW, WID_CC_YEAR_UP), SetDataTip(AWV_INCREASE, STR_CURRENCY_INCREASE_CUSTOM_CURRENCY_TO_EURO_TOOLTIP),
2761  NWidget(WWT_TEXT, COLOUR_BLUE, WID_CC_YEAR), SetDataTip(STR_JUST_STRING, STR_CURRENCY_SET_CUSTOM_CURRENCY_TO_EURO_TOOLTIP), SetFill(1, 0),
2762  EndContainer(),
2763  EndContainer(),
2764  NWidget(WWT_LABEL, COLOUR_BLUE, WID_CC_PREVIEW),
2765  SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP), SetPadding(15, 1, 18, 2),
2766  EndContainer(),
2767 };
2768 
2769 static WindowDesc _cust_currency_desc(
2770  WDP_CENTER, nullptr, 0, 0,
2772  0,
2773  _nested_cust_currency_widgets, lengthof(_nested_cust_currency_widgets)
2774 );
2775 
2777 static void ShowCustCurrency()
2778 {
2780  new CustomCurrencyWindow(&_cust_currency_desc);
2781 }
WID_GO_REFRESH_RATE_DROPDOWN
@ WID_GO_REFRESH_RATE_DROPDOWN
Dropdown for all available refresh rates.
Definition: settings_widget.h:39
LoadStringWidthTable
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1368
SettingEntry::Length
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
Definition: settings_gui.cpp:1053
WC_CUSTOM_CURRENCY
@ WC_CUSTOM_CURRENCY
Custom currency; Window numbers:
Definition: window_type.h:610
SEF_RIGHT_DEPRESSED
@ SEF_RIGHT_DEPRESSED
Of a numeric setting entry, the right button is depressed.
Definition: settings_gui.cpp:760
WID_GO_FULLSCREEN_BUTTON
@ WID_GO_FULLSCREEN_BUTTON
Toggle fullscreen.
Definition: settings_widget.h:21
Window::SetTimeout
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
Definition: window_gui.h:360
SettingEntry::UpdateFilterState
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:1114
CustomCurrencyWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: settings_gui.cpp:2723
CF_NOEURO
static const int CF_NOEURO
Currency never switches to the Euro (as far as known).
Definition: currency.h:17
SF_PER_COMPANY
@ SF_PER_COMPANY
This setting can be different for each company (saved in company struct).
Definition: settings_internal.h:27
ClampToI32
static int32 ClampToI32(const int64 a)
Reduce a signed 64-bit int to a signed 32-bit one.
Definition: math_func.hpp:141
factory.hpp
GUISettings::refresh_rate
uint16 refresh_rate
How often we refresh the screen (time between draw-ticks).
Definition: settings_type.h:171
WID_GO_FONT_ZOOM_DROPDOWN
@ WID_GO_FONT_ZOOM_DROPDOWN
Dropdown for the font zoom level.
Definition: settings_widget.h:36
SF_GUI_0_IS_SPECIAL
@ SF_GUI_0_IS_SPECIAL
A value of zero is possible and has a custom string (the one after "strval").
Definition: settings_internal.h:18
TextfileWindow::LoadTextfile
virtual void LoadTextfile(const char *textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
Definition: textfile_gui.cpp:340
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
WID_GO_AUTOSAVE_DROPDOWN
@ WID_GO_AUTOSAVE_DROPDOWN
Dropdown to say how often to autosave.
Definition: settings_widget.h:18
SEF_LEFT_DEPRESSED
@ SEF_LEFT_DEPRESSED
Of a numeric setting entry, the left button is depressed.
Definition: settings_gui.cpp:759
Window::timeout_timer
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Definition: window_gui.h:309
querystring_gui.h
DropDownListParamStringItem
String list item with parameters.
Definition: dropdown_type.h:56
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
GetCurrentLanguageIsoCode
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
Definition: strings.cpp:2003
SEF_BUTTONS_MASK
@ SEF_BUTTONS_MASK
Bit-mask for button flags.
Definition: settings_gui.cpp:761
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:662
WID_GS_OPTIONSPANEL
@ WID_GS_OPTIONSPANEL
Panel widget containing the option lists.
Definition: settings_widget.h:45
command_func.h
BaseSetTextfileWindow::baseset
const TBaseSet * baseset
View the textfile of this BaseSet.
Definition: settings_gui.cpp:113
WID_GS_COLLAPSE_ALL
@ WID_GS_COLLAPSE_ALL
Collapse all button.
Definition: settings_widget.h:49
WID_GS_HELP_TEXT
@ WID_GS_HELP_TEXT
Information area to display help text of the selected option.
Definition: settings_widget.h:47
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1139
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
BaseSetTextfileWindow::content_type
StringID content_type
STR_CONTENT_TYPE_xxx for title.
Definition: settings_gui.cpp:114
dropdown_func.h
GetSettingFromName
static const SettingDesc * GetSettingFromName(const std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
Definition: settings.cpp:1392
WID_GO_BASE_GRF_STATUS
@ WID_GO_BASE_GRF_STATUS
Info about missing files etc.
Definition: settings_widget.h:24
GameSettingsWindow
Window to edit settings of the game.
Definition: settings_gui.cpp:1891
StringFilter::IsEmpty
bool IsEmpty() const
Check whether any filter words were entered.
Definition: stringfilter_type.h:59
CustomCurrencyWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:2609
SettingsPage::DrawSetting
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
Definition: settings_gui.cpp:1539
company_base.h
WID_CC_SEPARATOR_EDIT
@ WID_CC_SEPARATOR_EDIT
Separator edit button.
Definition: settings_widget.h:62
GameSettingsWindow::settings_ptr
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
Definition: settings_gui.cpp:1897
IntSettingDesc::cat
SettingCategory cat
assigned categories of the setting
Definition: settings_internal.h:167
StringFilter::SetFilterTerm
void SetFilterTerm(const char *str)
Set the term to filter on.
Definition: stringfilter.cpp:27
WID_GO_BASE_SFX_TEXTFILE
@ WID_GO_BASE_SFX_TEXTFILE
Open base SFX readme, changelog (+1) or license (+2).
Definition: settings_widget.h:29
DrawVolumeSliderWidget
void DrawVolumeSliderWidget(Rect r, byte value)
Draw a volume slider widget with know at given value.
Definition: slider.cpp:26
IntSettingDesc::min
int32 min
minimum values
Definition: settings_internal.h:161
WID_GS_RESET_ALL
@ WID_GS_RESET_ALL
Reset all button.
Definition: settings_widget.h:50
SettingFilter::type
SettingType type
Filter based on type.
Definition: settings_gui.cpp:784
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
BASESET_DIR
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
Definition: fileio_type.h:116
currency.h
MusicDriver::SetVolume
virtual void SetVolume(byte vol)=0
Set the volume, if possible.
ST_GAME
@ ST_GAME
Game setting.
Definition: settings_internal.h:62
WID_GO_GUI_ZOOM_DROPDOWN
@ WID_GO_GUI_ZOOM_DROPDOWN
Dropdown for the GUI zoom level.
Definition: settings_widget.h:22
SettingEntry::setting
const IntSettingDesc * setting
Setting description of the setting.
Definition: settings_gui.cpp:829
WWT_LABEL
@ WWT_LABEL
Centered label.
Definition: widget_type.h:55
DropDownList
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Definition: dropdown_type.h:99
WID_CC_YEAR
@ WID_CC_YEAR
Year of introduction.
Definition: settings_widget.h:70
SettingDesc::GetType
SettingType GetType() const
Return the type of the setting.
Definition: settings.cpp:817
SettingsPage::Init
virtual void Init(byte level=0)
Initialization of an entire setting page.
Definition: settings_gui.cpp:1385
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
SettingsPage::Length
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
Definition: settings_gui.cpp:1474
SettingDesc::IsEditable
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
Definition: settings.cpp:801
WID_GO_BASE_GRF_DESCRIPTION
@ WID_GO_BASE_GRF_DESCRIPTION
Description of selected base GRF.
Definition: settings_widget.h:26
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
GameSettingsWindow::OnDropdownClose
void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
Definition: settings_gui.cpp:2365
DropDownListCharStringItem
List item containing a C char string.
Definition: dropdown_type.h:70
SettingsContainer::GetMaxHelpHeight
uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help texts, if the width is at least maxw.
Definition: settings_gui.cpp:1334
GameSettingsWindow::filter_editbox
QueryString filter_editbox
Filter editbox;.
Definition: settings_gui.cpp:1906
ST_CLIENT
@ ST_CLIENT
Client setting.
Definition: settings_internal.h:64
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
BaseSettingEntry::SetLastField
void SetLastField(bool last_field)
Set whether this is the last visible entry of the parent node.
Definition: settings_gui.cpp:804
WID_CC_RATE
@ WID_CC_RATE
Rate of currency.
Definition: settings_widget.h:61
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
BaseSetTextfileWindow
Window for displaying the textfile of a BaseSet.
Definition: settings_gui.cpp:112
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:710
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
SettingFilter::string
StringFilter string
Filter string.
Definition: settings_gui.cpp:780
_font_zoom_cfg
int8 _font_zoom_cfg
Font zoom level in config.
Definition: gfx.cpp:65
SettingEntry::Init
virtual void Init(byte level=0)
Initialization of a setting entry.
Definition: settings_gui.cpp:1029
GameOptionsWindow
Definition: settings_gui.cpp:160
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
zoom_func.h
ST_COMPANY
@ ST_COMPANY
Company setting.
Definition: settings_internal.h:63
WD_FRAMETEXT_TOP
@ WD_FRAMETEXT_TOP
Top offset of the text of the frame.
Definition: window_gui.h:74
WID_GS_EXPAND_ALL
@ WID_GS_EXPAND_ALL
Expand all button.
Definition: settings_widget.h:48
base_media_base.h
DropDownListItem
Base list item class from which others are derived.
Definition: dropdown_type.h:22
SettingsContainer::entries
EntryVector entries
Settings on this page.
Definition: settings_gui.cpp:862
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
GameSettingsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:1944
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:642
GameSettingsWindow::last_clicked
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
Definition: settings_gui.cpp:1901
GUISettings::autosave
byte autosave
how often should we do autosaves?
Definition: settings_type.h:132
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
town.h
WWT_PUSHARROWBTN
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:106
WID_GO_BASE_MUSIC_VOLUME
@ WID_GO_BASE_MUSIC_VOLUME
Change music volume.
Definition: settings_widget.h:32
WID_GS_FILTER
@ WID_GS_FILTER
Text filter.
Definition: settings_widget.h:44
StringFilter::AddLine
void AddLine(const char *str)
Pass another text line from the current item to the filter.
Definition: stringfilter.cpp:104
GameSettingsWindow::SETTINGTREE_TOP_OFFSET
static const int SETTINGTREE_TOP_OFFSET
Position of top edge of setting values.
Definition: settings_gui.cpp:1894
Window::OnDropdownClose
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Definition: window.cpp:293
FR_LOWERED
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
Definition: window_gui.h:31
settings_internal.h
WID_CC_PREFIX
@ WID_CC_PREFIX
Current prefix.
Definition: settings_widget.h:65
SettingDesc::flags
SettingFlag flags
Handles how a setting would show up in the GUI (text/currency, etc.).
Definition: settings_internal.h:77
SEF_FILTERED
@ SEF_FILTERED
Entry is hidden by the string filter.
Definition: settings_gui.cpp:764
WID_GO_BASE_MUSIC_DROPDOWN
@ WID_GO_BASE_MUSIC_DROPDOWN
Use to select a base music set.
Definition: settings_widget.h:31
WC_MUSIC_WINDOW
@ WC_MUSIC_WINDOW
Music window; Window numbers:
Definition: window_type.h:588
GameSettingsWindow::SETTINGTREE_LEFT_OFFSET
static const int SETTINGTREE_LEFT_OFFSET
Position of left edge of setting values.
Definition: settings_gui.cpp:1892
_gui_zoom
ZoomLevel _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:61
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2098
SettingEntry::IsVisibleByRestrictionMode
bool IsVisibleByRestrictionMode(RestrictionMode mode) const
Checks whether an entry shall be made visible based on the restriction mode.
Definition: settings_gui.cpp:1073
SettingsPage::SettingsPage
SettingsPage(StringID title)
Constructor for a sub-page in the 'advanced settings' window.
Definition: settings_gui.cpp:1375
BaseSettingEntry::Init
virtual void Init(byte level=0)
Initialization of a setting entry.
Definition: settings_gui.cpp:919
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
SettingsPage
Data structure describing one page of settings in the settings window.
Definition: settings_gui.cpp:888
WD_FRAMETEXT_LEFT
@ WD_FRAMETEXT_LEFT
Left offset of the text of the frame.
Definition: window_gui.h:72
TextfileWindow::file_type
TextfileType file_type
Type of textfile to view.
Definition: textfile_gui.h:30
TFT_CHANGELOG
@ TFT_CHANGELOG
NewGRF changelog.
Definition: textfile_type.h:18
SettingsContainer::UpdateFilterState
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:1274
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1799
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
CustomCurrencyWindow
Definition: settings_gui.cpp:2554
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
textfile_gui.h
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
QueryString
Data stored about a string that can be modified in the GUI.
Definition: querystring_gui.h:20
SETBITS
#define SETBITS(x, y)
Sets several bits in a variable.
Definition: bitmath_func.hpp:136
GameSettingsWindow::OnTimeout
void OnTimeout() override
Called when this window's timeout has been reached.
Definition: settings_gui.cpp:2293
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:888
GameOptionsWindow::Close
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
Definition: settings_gui.cpp:175
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:738
textbuf_gui.h
Textbuf::buf
char *const buf
buffer in which text is saved
Definition: textbuf_type.h:32
Window::querystrings
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
Definition: window_gui.h:323
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:383
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:787
GameOptionsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:300
SettingEntry::GetMaxHelpHeight
virtual uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help text(s), if the width is at least maxw.
Definition: settings_gui.cpp:1063
BuildCurrencyDropdown
StringID * BuildCurrencyDropdown()
Build a list of currency names StringIDs to use in a dropdown list.
Definition: currency.cpp:169
ai.hpp
WID_CC_SEPARATOR
@ WID_CC_SEPARATOR
Current separator.
Definition: settings_widget.h:63
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1758
GetGameSettings
static GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
Definition: settings_type.h:617
WN_GAME_OPTIONS_GAME_OPTIONS
@ WN_GAME_OPTIONS_GAME_OPTIONS
Game options.
Definition: window_type.h:18
WindowDesc
High level window description.
Definition: window_gui.h:168
GameSettingsWindow::warn_missing
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
Definition: settings_gui.cpp:1908
BaseSettingEntry::level
byte level
Nesting level of this setting entry.
Definition: settings_gui.cpp:790
SettingType
SettingType
Type of settings for filtering.
Definition: settings_internal.h:61
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
SettingsPage::title
StringID title
Title of the sub-page.
Definition: settings_gui.cpp:889
SettingFilter::min_cat
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL).
Definition: settings_gui.cpp:781
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:463
WC_QUERY_STRING
@ WC_QUERY_STRING
Query string window; Window numbers:
Definition: window_type.h:115
GameOptionsWindow::BuildDropDownList
DropDownList BuildDropDownList(int widget, int *selected_index) const
Build the dropdown list for a specific widget.
Definition: settings_gui.cpp:189
DrawDropDownButton
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
Definition: settings_gui.cpp:2529
IntSettingDesc::str_val
StringID str_val
(Translated) first string describing the value.
Definition: settings_internal.h:166
WWT_PUSHBTN
@ WWT_PUSHBTN
Normal push-button (no toggle button) with custom drawing.
Definition: widget_type.h:103
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
WID_GS_RESTRICT_CATEGORY
@ WID_GS_RESTRICT_CATEGORY
Label upfront to the category drop-down box to restrict the list of settings to show.
Definition: settings_widget.h:51
GameSettingsWindow::warn_lines
int warn_lines
Number of lines used for warning about missing search results.
Definition: settings_gui.cpp:1909
ResetAllSettingsConfirmationCallback
static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
Callback function for the reset all settings button.
Definition: settings_gui.cpp:1881
VideoDriver::GetListOfMonitorRefreshRates
virtual std::vector< int > GetListOfMonitorRefreshRates()
Get a list of refresh rates of each available monitor.
Definition: video_driver.hpp:164
Scrollbar::GetCount
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:653
SETTING_HEIGHT
static int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
Definition: settings_gui.cpp:751
Window::EnableWidget
void EnableWidget(byte widget_index)
Sets a widget to Enabled.
Definition: window_gui.h:405
MusicDriver::GetInstance
static MusicDriver * GetInstance()
Get the currently active instance of the music driver.
Definition: music_driver.hpp:46
RestrictionMode
RestrictionMode
How the list of advanced settings is filtered.
Definition: settings_gui.cpp:768
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1789
WWT_EDITBOX
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:69
GameSettingsWindow::valuewindow_entry
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
Definition: settings_gui.cpp:1899
ReInitAllWindows
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition: window.cpp:3331
GfxClearSpriteCache
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information.
Definition: spritecache.cpp:1006
SettingEntry::DrawSetting
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
Definition: settings_gui.cpp:1188
WHR_TYPE
@ WHR_TYPE
Type setting filtered matches away.
Definition: settings_gui.cpp:1872
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
WID_CC_SUFFIX_EDIT
@ WID_CC_SUFFIX_EDIT
Suffix edit button.
Definition: settings_widget.h:66
IntSettingDesc
Base integer type, including boolean, settings.
Definition: settings_internal.h:136
WID_GO_BASE_MUSIC_DESCRIPTION
@ WID_GO_BASE_MUSIC_DESCRIPTION
Description of selected base music set.
Definition: settings_widget.h:35
CustomCurrencyWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: settings_gui.cpp:2691
GameSettingsWindow::SETTINGTREE_BOTTOM_OFFSET
static const int SETTINGTREE_BOTTOM_OFFSET
Position of bottom edge of setting values.
Definition: settings_gui.cpp:1895
Window::SetDirty
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:993
highscore.h
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
SettingsContainer::ResetAll
void ResetAll()
Resets all settings to their default values.
Definition: settings_gui.cpp:1233
GameSettingsWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: settings_gui.cpp:2326
GUISettings::missing_strings_threshold
byte missing_strings_threshold
the number of missing strings before showing the warning
Definition: settings_type.h:165
VideoDriver::ToggleVsync
virtual void ToggleVsync(bool vsync)
Change the vsync setting.
Definition: video_driver.hpp:75
BaseSettingEntry
Data structure describing a single setting in a tab.
Definition: settings_gui.cpp:788
GameSettingsWindow::OnQueryTextFinished
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
Definition: settings_gui.cpp:2302
WD_PAR_VSEP_NORMAL
@ WD_PAR_VSEP_NORMAL
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:139
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:104
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
WD_FRAMETEXT_BOTTOM
@ WD_FRAMETEXT_BOTTOM
Bottom offset of the text of the frame.
Definition: window_gui.h:75
ShowDropDownList
void ShowDropDownList(Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
Show a drop down list.
Definition: dropdown.cpp:443
GameOptionsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: settings_gui.cpp:329
RM_END
@ RM_END
End for iteration.
Definition: settings_gui.cpp:774
SettingFilter::mode
RestrictionMode mode
Filter based on category.
Definition: settings_gui.cpp:783
dropdown_type.h
SettingEntry::name
const char * name
Name of the setting.
Definition: settings_gui.cpp:828
Window::SetWidgetDisabledState
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:386
WL_INFO
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:22
SettingsPage::FoldAll
virtual void FoldAll()
Recursively close all (filtered) folds of sub-pages.
Definition: settings_gui.cpp:1400
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
_current_language
const LanguageMetadata * _current_language
The currently loaded language.
Definition: strings.cpp:46
SEF_LAST_FIELD
@ SEF_LAST_FIELD
This entry is the last one in a (sub-)page.
Definition: settings_gui.cpp:763
DropDownListStringItem
Common string list item.
Definition: dropdown_type.h:39
safeguards.h
ShowQueryString
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
Definition: misc_gui.cpp:1118
RM_ALL
@ RM_ALL
List all settings regardless of the default/newgame/... values.
Definition: settings_gui.cpp:771
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:312
music_driver.hpp
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:305
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:24
WF_TIMEOUT
@ WF_TIMEOUT
Window timeout counter.
Definition: window_gui.h:234
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:64
GameSettings
All settings together for the game.
Definition: settings_type.h:574
SettingsPage::folded
bool folded
Sub-page is folded (not visible except for its title)
Definition: settings_gui.cpp:890
SF_GUI_NEGATIVE_IS_SPECIAL
@ SF_GUI_NEGATIVE_IS_SPECIAL
A negative value has another string (the one after "strval").
Definition: settings_internal.h:19
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:1041
WID_GO_BASE_GRF_DROPDOWN
@ WID_GO_BASE_GRF_DROPDOWN
Use to select a base GRF.
Definition: settings_widget.h:23
WID_CC_YEAR_UP
@ WID_CC_YEAR_UP
Up button.
Definition: settings_widget.h:69
GameSettingsWindow::valuedropdown_entry
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
Definition: settings_gui.cpp:1902
SettingsContainer::Init
void Init(byte level=0)
Initialization of an entire setting page.
Definition: settings_gui.cpp:1225
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
SF_GUI_CURRENCY
@ SF_GUI_CURRENCY
The number represents money, so when reading value multiply by exchange rate.
Definition: settings_internal.h:21
error.h
CheckBlitter
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
Definition: gfxinit.cpp:334
RM_BASIC
@ RM_BASIC
Display settings associated to the "basic" list.
Definition: settings_gui.cpp:769
WWT_FRAME
@ WWT_FRAME
Frame.
Definition: widget_type.h:58
language.h
AddCustomRefreshRates
static void AddCustomRefreshRates()
Add the refresh rate from the config and the refresh rates from all the monitors to our list of refre...
Definition: settings_gui.cpp:150
WID_CC_YEAR_DOWN
@ WID_CC_YEAR_DOWN
Down button.
Definition: settings_widget.h:68
WHR_CATEGORY
@ WHR_CATEGORY
Category setting filtered matches away.
Definition: settings_gui.cpp:1871
SettingsPage::FindEntry
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
Definition: settings_gui.cpp:1488
BaseSetTextfileWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:122
SETTING_BUTTON_WIDTH
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
Definition: settings_gui.h:17
CustomCurrencyWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:2572
WD_FRAMETEXT_RIGHT
@ WD_FRAMETEXT_RIGHT
Right offset of the text of the frame.
Definition: window_gui.h:73
Window::SetFocusedWidget
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Definition: window.cpp:506
stdafx.h
DrawArrowButtons
void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
Definition: settings_gui.cpp:2501
WID_GO_LANG_DROPDOWN
@ WID_GO_LANG_DROPDOWN
Language dropdown.
Definition: settings_widget.h:19
SettingFilter::type_hides
bool type_hides
Whether the type hides filtered strings.
Definition: settings_gui.cpp:782
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:116
ShowCustCurrency
static void ShowCustCurrency()
Open custom currency window.
Definition: settings_gui.cpp:2777
WID_CC_RATE_DOWN
@ WID_CC_RATE_DOWN
Down button.
Definition: settings_widget.h:59
TFT_README
@ TFT_README
NewGRF readme.
Definition: textfile_type.h:17
LanguagePackHeader::own_name
char own_name[32]
the localized name of this language
Definition: language.h:30
SettingsContainer::Draw
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.
Definition: settings_gui.cpp:1358
WarnHiddenResult
WarnHiddenResult
Warnings about hidden search results.
Definition: settings_gui.cpp:1869
Window::InvalidateData
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition: window.cpp:3158
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:199
CS_ALPHANUMERAL
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition: string_type.h:27
viewport_func.h
Window::mouse_capture_widget
int mouse_capture_widget
Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse captu...
Definition: window_gui.h:330
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:329
WHR_CATEGORY_TYPE
@ WHR_CATEGORY_TYPE
Both category and type settings filtered matches away.
Definition: settings_gui.cpp:1873
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
ShowBaseSetTextfileWindow
void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
Definition: settings_gui.cpp:138
BaseSet::GetNumMissing
int GetNumMissing() const
Get the number of missing files.
Definition: base_media_base.h:88
WID_CC_RATE_UP
@ WID_CC_RATE_UP
Up button.
Definition: settings_widget.h:60
ClickVolumeSliderWidget
bool ClickVolumeSliderWidget(Rect r, Point pt, byte &value)
Handle click on a volume slider widget to change the value.
Definition: slider.cpp:55
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:713
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:976
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
GUISettings::zoom_min
ZoomLevel zoom_min
minimum zoom out level
Definition: settings_type.h:129
GameSettingsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: settings_gui.cpp:2020
WID_GO_BACKGROUND
@ WID_GO_BACKGROUND
Background of the window.
Definition: settings_widget.h:15
_gui_zoom_cfg
int8 _gui_zoom_cfg
GUI zoom level in config.
Definition: gfx.cpp:64
BaseMedia< GraphicsSet >::GetNumSets
static int GetNumSets()
Count the number of available graphics sets.
Definition: base_media_func.h:311
string_func.h
SettingEntry::SetButtons
void SetButtons(byte new_val)
Set the button-depressed flags (SEF_LEFT_DEPRESSED and SEF_RIGHT_DEPRESSED) to a specified value.
Definition: settings_gui.cpp:1046
TFT_LICENSE
@ TFT_LICENSE
NewGRF license.
Definition: textfile_type.h:19
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
_font_zoom
ZoomLevel _font_zoom
Font Zoom level.
Definition: gfx.cpp:62
GameSettingsWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: settings_gui.cpp:2427
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
ShowQuery
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback)
Show a modal confirmation window with standard 'yes' and 'no' buttons The window is aligned to the ce...
Definition: misc_gui.cpp:1267
WID_GS_SCROLLBAR
@ WID_GS_SCROLLBAR
Scrollbar.
Definition: settings_widget.h:46
WID_CC_PREFIX_EDIT
@ WID_CC_PREFIX_EDIT
Prefix edit button.
Definition: settings_widget.h:64
IntSettingDesc::str_help
StringID str_help
(Translated) string with help text; gui only.
Definition: settings_internal.h:165
QueryString::cancel_button
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
Definition: querystring_gui.h:28
rev.h
WC_GAME_OPTIONS
@ WC_GAME_OPTIONS
Game options window; Window numbers:
Definition: window_type.h:604
CURRENCY_END
@ CURRENCY_END
always the last item
Definition: currency.h:68
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
WID_GO_RESOLUTION_DROPDOWN
@ WID_GO_RESOLUTION_DROPDOWN
Dropdown for the resolution.
Definition: settings_widget.h:20
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
main
int CDECL main(int argc, char *argv[])
And the main program (what else?)
Definition: settingsgen.cpp:455
GetTextfile
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
Definition: textfile_gui.cpp:416
NWidgetBase::pos_x
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:189
LocaleSettings::currency
byte currency
currency we currently use
Definition: settings_type.h:228
WID_GO_BASE_SFX_DROPDOWN
@ WID_GO_BASE_SFX_DROPDOWN
Use to select a base SFX.
Definition: settings_widget.h:27
GRFConfig::name
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
Definition: newgrf_config.h:166
WID_GO_BASE_MUSIC_TEXTFILE
@ WID_GO_BASE_MUSIC_TEXTFILE
Open base music readme, changelog (+1) or license (+2).
Definition: settings_widget.h:34
BaseSettingEntry::FindEntry
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
Definition: settings_gui.cpp:942
HideDropDownMenu
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
Definition: dropdown.cpp:498
IntSettingDesc::interval
int32 interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
Definition: settings_internal.h:163
SettingsContainer::UnFoldAll
void UnFoldAll()
Recursively open all folds of sub-pages.
Definition: settings_gui.cpp:1249
WWT_TEXT
@ WWT_TEXT
Pure simple text.
Definition: widget_type.h:56
SettingsContainer::IsVisible
bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:1293
SettingsPage::GetFoldingState
virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the (filtered) tree.
Definition: settings_gui.cpp:1422
SettingsContainer::Length
uint Length() const
Return number of rows needed to display the whole page.
Definition: settings_gui.cpp:1302
WID_GS_RESTRICT_TYPE
@ WID_GS_RESTRICT_TYPE
Label upfront to the type drop-down box to restrict the list of settings to show.
Definition: settings_widget.h:52
SetSettingValue
bool SetSettingValue(const IntSettingDesc *sd, int32 value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
Definition: settings.cpp:1524
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:165
video_driver.hpp
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
GameSettingsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: settings_gui.cpp:2062
RM_CHANGED_AGAINST_DEFAULT
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
Definition: settings_gui.cpp:772
SC_BASIC_LIST
@ SC_BASIC_LIST
Settings displayed in the list of basic settings.
Definition: settings_internal.h:46
WID_GO_BASE_SFX_VOLUME
@ WID_GO_BASE_SFX_VOLUME
Change sound effects volume.
Definition: settings_widget.h:28
geometry_func.hpp
CloseWindowByClass
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
Definition: window.cpp:1188
IntSettingDesc::str
StringID str
(translated) string with descriptive text; gui and console
Definition: settings_internal.h:164
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
GameSettingsWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: settings_gui.cpp:1979
UpdateAllVirtCoords
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
Definition: afterload.cpp:217
StringFilter::ResetState
void ResetState()
Reset the matching state to process a new item.
Definition: stringfilter.cpp:88
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
SettingsPage::UpdateFilterState
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
Definition: settings_gui.cpp:1441
_video_hw_accel
bool _video_hw_accel
Whether to consider hardware accelerated video drivers.
Definition: video_driver.cpp:23
NWidgetBase::resize_y
uint resize_y
Vertical resize step (0 means not resizable).
Definition: widget_type.h:179
IntSettingDesc::IsBoolSetting
virtual bool IsBoolSetting() const
Check whether this setting is a boolean type setting.
Definition: settings_internal.h:175
SettingsContainer::FindEntry
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
Definition: settings_gui.cpp:1317
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:671
CustomCurrencyWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:2590
StringFilter::GetState
bool GetState() const
Get the matching state of the current item.
Definition: stringfilter_type.h:69
WD_IMGBTN_TOP
@ WD_IMGBTN_TOP
Top offset of image in the button.
Definition: window_gui.h:42
WID_GO_BASE_MUSIC_STATUS
@ WID_GO_BASE_MUSIC_STATUS
Info about corrupted files etc.
Definition: settings_widget.h:33
SF_GUI_DROPDOWN
@ SF_GUI_DROPDOWN
The value represents a limited number of string-options (internally integer) presented as dropdown.
Definition: settings_internal.h:20
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
WID_GS_RESTRICT_DROPDOWN
@ WID_GS_RESTRICT_DROPDOWN
The drop down box to restrict the list of settings.
Definition: settings_widget.h:53
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
WID_GO_VIDEO_VSYNC_BUTTON
@ WID_GO_VIDEO_VSYNC_BUTTON
Toggle for video vsync.
Definition: settings_widget.h:38
GameSettingsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: settings_gui.cpp:2384
IntSettingDesc::Read
int32 Read(const void *object) const
Read the integer from the the actual setting.
Definition: settings.cpp:513
company_func.h
WL_ERROR
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:24
SM_MENU
@ SM_MENU
Switch to game intro menu.
Definition: openttd.h:32
GetCurrentResolutionIndex
static uint GetCurrentResolutionIndex()
Get index of the current screen resolution.
Definition: settings_gui.cpp:83
QueryString::ACTION_CLEAR
static const int ACTION_CLEAR
Clear editbox.
Definition: querystring_gui.h:24
SettingsPage::Draw
virtual 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.
Definition: settings_gui.cpp:1512
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:313
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
WID_GO_BASE_GRF_TEXTFILE
@ WID_GO_BASE_GRF_TEXTFILE
Open base GRF readme, changelog (+1) or license (+2).
Definition: settings_widget.h:25
LEVEL_WIDTH
static const int LEVEL_WIDTH
Indenting width of a sub-page in pixels.
Definition: settings_gui.cpp:752
GameOptionsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:423
SettingEntry::SetValueDParams
void SetValueDParams(uint first_param, int32 value) const
Set the DParams for drawing the value of a setting.
Definition: settings_gui.cpp:1163
DrawFrameRect
void DrawFrameRect(int left, int top, int right, int bottom, Colours colour, FrameFlags flags)
Draw frame rectangle.
Definition: widget.cpp:209
network.h
SettingsPage::IsVisible
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:1464
SettingsContainer::FoldAll
void FoldAll()
Recursively close all folds of sub-pages.
Definition: settings_gui.cpp:1241
IntSettingDesc::max
uint32 max
maximum values
Definition: settings_internal.h:162
ShowDropDownListAt
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, int button, Rect wi_rect, Colours wi_colour, bool auto_width, bool instant_close)
Show a drop down list.
Definition: dropdown.cpp:356
_video_vsync
bool _video_vsync
Whether we should use vsync (only if _video_hw_accel is enabled).
Definition: video_driver.cpp:24
GUISettings::settings_restriction_mode
uint8 settings_restriction_mode
selected restriction mode in adv. settings GUI.
Definition: settings_type.h:189
window_func.h
CheckForMissingGlyphs
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
Definition: strings.cpp:2110
GameSettingsWindow::filter
SettingFilter filter
Filter for the list.
Definition: settings_gui.cpp:1905
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
BaseMedia< GraphicsSet >::GetSet
static const GraphicsSet * GetSet(int index)
Get the name of the graphics set at the specified index.
Definition: base_media_func.h:342
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
MusicSettings::effect_vol
byte effect_vol
The requested effects volume.
Definition: settings_type.h:219
stringfilter_type.h
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:2172
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1689
GameSettings::locale
LocaleSettings locale
settings related to used currency/unit system in the current game
Definition: settings_type.h:588
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1169
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
NWidgetBase::pos_y
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:190
BaseSettingEntry::IsVisible
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
Definition: settings_gui.cpp:930
SettingEntry::SettingEntry
SettingEntry(const char *name)
Constructor for a single setting in the 'advanced settings' window.
Definition: settings_gui.cpp:1019
WID_GO_VIDEO_ACCEL_BUTTON
@ WID_GO_VIDEO_ACCEL_BUTTON
Toggle for video acceleration.
Definition: settings_widget.h:37
GameSettingsWindow::SETTINGTREE_RIGHT_OFFSET
static const int SETTINGTREE_RIGHT_OFFSET
Position of right edge of setting values.
Definition: settings_gui.cpp:1893
SettingFilter
Filter for settings list.
Definition: settings_gui.cpp:779
fontcache.h
RM_CHANGED_AGAINST_NEW
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
Definition: settings_gui.cpp:773
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
TextfileWindow
Window for displaying a textfile.
Definition: textfile_gui.h:21
WID_CC_PREVIEW
@ WID_CC_PREVIEW
Preview.
Definition: settings_widget.h:71
GameOptionsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: settings_gui.cpp:606
GetSettingsTree
static SettingsContainer & GetSettingsTree()
Construct settings tree.
Definition: settings_gui.cpp:1547
ST_ALL
@ ST_ALL
Used in setting filter to match all types.
Definition: settings_internal.h:66
ClientSettings::company
CompanySettings company
default values for per-company settings
Definition: settings_type.h:595
SettingsContainer
Containers for BaseSettingEntry.
Definition: settings_gui.cpp:860
GameSettingsWindow::closing_dropdown
bool closing_dropdown
True, if the dropdown list is currently closing.
Definition: settings_gui.cpp:1903
BaseSettingEntry::flags
byte flags
Flags of the setting entry.
Definition: settings_gui.cpp:789
Window
Data structure for an opened window.
Definition: window_gui.h:279
TextfileType
TextfileType
Additional text files accompanying Tar archives.
Definition: textfile_type.h:14
WID_GO_BASE_SFX_DESCRIPTION
@ WID_GO_BASE_SFX_DESCRIPTION
Description of selected base SFX.
Definition: settings_widget.h:30
SC_ADVANCED_LIST
@ SC_ADVANCED_LIST
Settings displayed in the list of advanced settings.
Definition: settings_internal.h:47
SettingEntry
Standard setting.
Definition: settings_gui.cpp:827
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
SettingsPage::ResetAll
virtual void ResetAll()
Resets all settings to their default values.
Definition: settings_gui.cpp:1392
BaseMedia< GraphicsSet >::GetUsedSet
static const GraphicsSet * GetUsedSet()
Return the used set.
Definition: base_media_func.h:357
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:636
ZOOM_LVL_OUT_4X
@ ZOOM_LVL_OUT_4X
Zoomed 4 times out.
Definition: zoom_type.h:26
ShowGameSettings
void ShowGameSettings()
Open advanced settings window.
Definition: settings_gui.cpp:2485
DrawBoolButton
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
Definition: settings_gui.cpp:2548
settings_gui.h
WD_IMGBTN_LEFT
@ WD_IMGBTN_LEFT
Left offset of the image in the button.
Definition: window_gui.h:40
WID_TF_CAPTION
@ WID_TF_CAPTION
The caption of the window.
Definition: misc_widget.h:51
SettingEntry::GetHelpText
StringID GetHelpText() const
Get the help text of a single setting.
Definition: settings_gui.cpp:845
Window::SetWidgetDirty
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
Definition: window.cpp:608
WID_GO_CURRENCY_DROPDOWN
@ WID_GO_CURRENCY_DROPDOWN
Currency dropdown.
Definition: settings_widget.h:16
_languages
LanguageList _languages
The actual list of language meta data.
Definition: strings.cpp:45
GetMaskOfAllowedCurrencies
uint64 GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Definition: currency.cpp:122
BaseSet::GetNumInvalid
int GetNumInvalid() const
Get the number of invalid files.
Definition: base_media_base.h:98
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
GameSettingsWindow::manually_changed_folding
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
Definition: settings_gui.cpp:1907
BaseSettingEntry::Draw
virtual 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.
Definition: settings_gui.cpp:979
GameSettingsWindow::SetDisplayedHelpText
void SetDisplayedHelpText(SettingEntry *pe)
Set the entry that should have its help text displayed, and mark the window dirty so it gets repainte...
Definition: settings_gui.cpp:2105
AWV_INCREASE
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:36
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3146
QSF_ENABLE_DEFAULT
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
Definition: textbuf_gui.h:21
ClientSettings::music
MusicSettings music
settings related to music/sound
Definition: settings_type.h:597
Window::DisableWidget
void DisableWidget(byte widget_index)
Sets a widget to disabled.
Definition: window_gui.h:396
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
NWidgetBase::current_x
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:186
WC_TEXTFILE
@ WC_TEXTFILE
textfile; Window numbers:
Definition: window_type.h:179
WHR_NONE
@ WHR_NONE
Nothing was filtering matches away.
Definition: settings_gui.cpp:1870
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition: gfx.cpp:1962
SettingsContainer::GetFoldingState
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
Definition: settings_gui.cpp:1261
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:157
ChangeMusicSet
void ChangeMusicSet(int index)
Change the configured music set and reset playback.
Definition: music_gui.cpp:432
Window::SetWidgetLoweredState
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:447
SETTING_BUTTON_HEIGHT
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
Definition: settings_gui.h:19
GameSettingsWindow::clicked_entry
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button).
Definition: settings_gui.cpp:1900
ReadLanguagePack
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
Definition: strings.cpp:1736
MusicSettings::music_vol
byte music_vol
The requested music volume.
Definition: settings_type.h:218
GameOptionsWindow::OnDropdownSelect
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
Definition: settings_gui.cpp:519
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
GameSettingsWindow::OnEditboxChanged
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
Definition: settings_gui.cpp:2414
_circle_size
static Dimension _circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
Definition: settings_gui.cpp:75
CS_NUMERAL
@ CS_NUMERAL
Only numeric ones.
Definition: string_type.h:28
SettingsPage::UnFoldAll
virtual void UnFoldAll()
Recursively open all (filtered) folds of sub-pages.
Definition: settings_gui.cpp:1409
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
_currency_specs
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Definition: currency.cpp:74
IntSettingDesc::def
int32 def
default value given when none is present
Definition: settings_internal.h:160
GameSettingsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: settings_gui.cpp:2111
WD_TEXTPANEL_BOTTOM
@ WD_TEXTPANEL_BOTTOM
Offset at bottom to draw below the text.
Definition: window_gui.h:69
StringFilter
String filter and state.
Definition: stringfilter_type.h:31
GameOptionsWindow::SetMediaSet
void SetMediaSet(int index)
Set the base media set.
Definition: settings_gui.cpp:506
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
CURRENCY_CUSTOM
@ CURRENCY_CUSTOM
Custom currency.
Definition: currency.h:57
_settings_newgame
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition: settings.cpp:54
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
WID_GS_TYPE_DROPDOWN
@ WID_GS_TYPE_DROPDOWN
The drop down box to choose client/game/company/all settings.
Definition: settings_widget.h:54
GameOptionsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: settings_gui.cpp:357
AWV_DECREASE
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:35
WWT_DROPDOWN
@ WWT_DROPDOWN
Drop down list.
Definition: widget_type.h:68
SettingDesc::AsIntSetting
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
Definition: settings.cpp:827
WD_TEXTPANEL_TOP
@ WD_TEXTPANEL_TOP
Offset at top to draw above the text.
Definition: window_gui.h:68
WID_CC_SUFFIX
@ WID_CC_SUFFIX
Current suffix.
Definition: settings_widget.h:67
BaseSettingEntry::IsFiltered
bool IsFiltered() const
Check whether an entry is hidden due to filters.
Definition: settings_gui.cpp:816
MAX_YEAR
static const Year MAX_YEAR
MAX_YEAR, nicely rounded value of the number of years that can be encoded in a single 32 bits date,...
Definition: date_type.h:95
RM_ADVANCED
@ RM_ADVANCED
Display settings associated to the "advanced" list.
Definition: settings_gui.cpp:770
WN_GAME_OPTIONS_GAME_SETTINGS
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
Definition: window_type.h:19
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092
ShowGameOptions
void ShowGameOptions()
Open the game options window.
Definition: settings_gui.cpp:745
SettingEntryFlags
SettingEntryFlags
Flags for SettingEntry.
Definition: settings_gui.cpp:758
DropDownListStringItem::NatSortFunc
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().
Definition: dropdown.cpp:52