OpenTTD Source 15.0-beta2
settingentry_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 "company_base.h"
12#include "company_func.h"
13#include "settingentry_gui.h"
14#include "settings_gui.h"
15#include "settings_internal.h"
16#include "stringfilter_type.h"
17#include "strings_func.h"
18
19#include "table/sprites.h"
20#include "table/strings.h"
21
22#include "safeguards.h"
23
24
25/* == BaseSettingEntry methods == */
26
31void BaseSettingEntry::Init(uint8_t level)
32{
33 this->level = level;
34}
35
43{
44 if (this->IsFiltered()) return false;
45 return this == item;
46}
47
54BaseSettingEntry *BaseSettingEntry::FindEntry(uint row_num, uint *cur_row)
55{
56 if (this->IsFiltered()) return nullptr;
57 if (row_num == *cur_row) return this;
58 (*cur_row)++;
59 return nullptr;
60}
61
91uint 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
92{
93 if (this->IsFiltered()) return cur_row;
94 if (cur_row >= max_row) return cur_row;
95
96 bool rtl = _current_text_dir == TD_RTL;
97 int offset = (rtl ? -(int)_setting_circle_size.width : (int)_setting_circle_size.width) / 2;
99
100 int x = rtl ? right : left;
101 if (cur_row >= first_row) {
102 int colour = GetColourGradient(COLOUR_ORANGE, SHADE_NORMAL);
103 y += (cur_row - first_row) * SETTING_HEIGHT; // Compute correct y start position
104
105 /* Draw vertical for parent nesting levels */
106 for (uint lvl = 0; lvl < this->level; lvl++) {
107 if (!HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y + SETTING_HEIGHT - 1, colour);
108 x += level_width;
109 }
110 /* draw own |- prefix */
111 int halfway_y = y + SETTING_HEIGHT / 2;
112 int bottom_y = flags.Test(SettingEntryFlag::LastField) ? halfway_y : y + SETTING_HEIGHT - 1;
113 GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
114 /* Small horizontal line from the last vertical line */
115 GfxDrawLine(x + offset, halfway_y, x + level_width - (rtl ? -WidgetDimensions::scaled.hsep_normal : WidgetDimensions::scaled.hsep_normal), halfway_y, colour);
116 x += level_width;
117
118 this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y, this == selected);
119 }
120 cur_row++;
121
122 return cur_row;
123}
124
125/* == SettingEntry methods == */
126
132{
133 this->name = name;
134 this->setting = nullptr;
135}
136
141void SettingEntry::Init(uint8_t level)
142{
145}
146
147/* Sets the given setting entry to its default value */
148void SettingEntry::ResetAll()
149{
151}
152
159{
160 assert((new_val & SEF_BUTTONS_MASK) == new_val); // Should not touch any flags outside the buttons
163}
164
167{
168 return this->IsFiltered() ? 0 : 1;
169}
170
177{
178 return GetStringHeight(this->setting->GetHelp(), maxw);
179}
180
187{
188 /* There shall not be any restriction, i.e. all settings shall be visible. */
189 if (mode == RM_ALL) return true;
190
191 const IntSettingDesc *sd = this->setting;
192
193 if (mode == RM_BASIC) return (this->setting->cat & SC_BASIC_LIST) != 0;
194 if (mode == RM_ADVANCED) return (this->setting->cat & SC_ADVANCED_LIST) != 0;
195
196 /* Read the current value. */
197 const void *object = ResolveObject(&GetGameSettings(), sd);
198 int64_t current_value = sd->Read(object);
199 int64_t filter_value;
200
201 if (mode == RM_CHANGED_AGAINST_DEFAULT) {
202 /* This entry shall only be visible, if the value deviates from its default value. */
203
204 /* Read the default value. */
205 filter_value = sd->GetDefaultValue();
206 } else {
207 assert(mode == RM_CHANGED_AGAINST_NEW);
208 /* This entry shall only be visible, if the value deviates from
209 * its value is used when starting a new game. */
210
211 /* Make sure we're not comparing the new game settings against itself. */
212 assert(&GetGameSettings() != &_settings_newgame);
213
214 /* Read the new game's value. */
215 filter_value = sd->Read(ResolveObject(&_settings_newgame, sd));
216 }
217
218 return current_value != filter_value;
219}
220
227bool SettingEntry::UpdateFilterState(SettingFilter &filter, bool force_visible)
228{
230
231 bool visible = true;
232
233 const IntSettingDesc *sd = this->setting;
234 if (!force_visible && !filter.string.IsEmpty()) {
235 /* Process the search text filter for this item. */
236 filter.string.ResetState();
237
238 filter.string.AddLine(GetString(sd->GetTitle(), STR_EMPTY));
239 filter.string.AddLine(GetString(sd->GetHelp()));
240
241 visible = filter.string.GetState();
242 }
243
244 if (visible) {
245 if (filter.type != ST_ALL && sd->GetType() != filter.type) {
246 filter.type_hides = true;
247 visible = false;
248 }
249 if (!this->IsVisibleByRestrictionMode(filter.mode)) {
250 while (filter.min_cat < RM_ALL && (filter.min_cat == filter.mode || !this->IsVisibleByRestrictionMode(filter.min_cat))) filter.min_cat++;
251 visible = false;
252 }
253 }
254
255 if (!visible) this->flags.Set(SettingEntryFlag::Filtered);
256 return visible;
257}
258
259const void *ResolveObject(const GameSettings *settings_ptr, const IntSettingDesc *sd)
260{
262 if (Company::IsValidID(_local_company) && _game_mode != GM_MENU) {
263 return &Company::Get(_local_company)->settings;
264 }
266 }
267 return settings_ptr;
268}
269
278void SettingEntry::DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
279{
280 const IntSettingDesc *sd = this->setting;
281 int state = (this->flags & SEF_BUTTONS_MASK).base();
282
283 bool rtl = _current_text_dir == TD_RTL;
284 uint buttons_left = rtl ? right + 1 - SETTING_BUTTON_WIDTH : left;
285 uint text_left = left + (rtl ? 0 : SETTING_BUTTON_WIDTH + WidgetDimensions::scaled.hsep_wide);
286 uint text_right = right - (rtl ? SETTING_BUTTON_WIDTH + WidgetDimensions::scaled.hsep_wide : 0);
287 uint button_y = y + (SETTING_HEIGHT - SETTING_BUTTON_HEIGHT) / 2;
288
289 /* We do not allow changes of some items when we are a client in a networkgame */
290 bool editable = sd->IsEditable();
291
292 auto [min_val, max_val] = sd->GetRange();
293 int32_t value = sd->Read(ResolveObject(settings_ptr, sd));
294 if (sd->IsBoolSetting()) {
295 /* Draw checkbox for boolean-value either on/off */
296 DrawBoolButton(buttons_left, button_y, value != 0, editable);
297 } else if (sd->flags.Test(SettingFlag::GuiDropdown)) {
298 /* Draw [v] button for settings of an enum-type */
299 DrawDropDownButton(buttons_left, button_y, COLOUR_YELLOW, state != 0, editable);
300 } else {
301 /* Draw [<][>] boxes for settings of an integer-type */
302 DrawArrowButtons(buttons_left, button_y, COLOUR_YELLOW, state,
303 editable && value != (sd->flags.Test(SettingFlag::GuiZeroIsSpecial) ? 0 : min_val), editable && static_cast<uint32_t>(value) != max_val);
304 }
305 auto [param1, param2] = sd->GetValueParams(value);
306 DrawString(text_left, text_right, y + (SETTING_HEIGHT - GetCharacterHeight(FS_NORMAL)) / 2, GetString(sd->GetTitle(), STR_CONFIG_SETTING_VALUE, param1, param2), highlight ? TC_WHITE : TC_LIGHT_BLUE);
307}
308
309/* == SettingsContainer methods == */
310
315void SettingsContainer::Init(uint8_t level)
316{
317 for (auto &it : this->entries) {
318 it->Init(level);
319 }
320}
321
324{
325 for (auto settings_entry : this->entries) {
326 settings_entry->ResetAll();
327 }
328}
329
332{
333 for (auto &it : this->entries) {
334 it->FoldAll();
335 }
336}
337
340{
341 for (auto &it : this->entries) {
342 it->UnFoldAll();
343 }
344}
345
351void SettingsContainer::GetFoldingState(bool &all_folded, bool &all_unfolded) const
352{
353 for (auto &it : this->entries) {
354 it->GetFoldingState(all_folded, all_unfolded);
355 }
356}
357
365{
366 bool visible = false;
367 bool first_visible = true;
368 for (EntryVector::reverse_iterator it = this->entries.rbegin(); it != this->entries.rend(); ++it) {
369 visible |= (*it)->UpdateFilterState(filter, force_visible);
370 (*it)->SetLastField(first_visible);
371 if (visible && first_visible) first_visible = false;
372 }
373 return visible;
374}
375
376
384{
385 for (const auto &it : this->entries) {
386 if (it->IsVisible(item)) return true;
387 }
388 return false;
389}
390
393{
394 uint length = 0;
395 for (const auto &it : this->entries) {
396 length += it->Length();
397 }
398 return length;
399}
400
408{
409 BaseSettingEntry *pe = nullptr;
410 for (const auto &it : this->entries) {
411 pe = it->FindEntry(row_num, cur_row);
412 if (pe != nullptr) {
413 break;
414 }
415 }
416 return pe;
417}
418
425{
426 uint biggest = 0;
427 for (const auto &it : this->entries) {
428 biggest = std::max(biggest, it->GetMaxHelpHeight(maxw));
429 }
430 return biggest;
431}
432
433
448uint 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
449{
450 for (const auto &it : this->entries) {
451 cur_row = it->Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
452 if (cur_row >= max_row) break;
453 }
454 return cur_row;
455}
456
457/* == SettingsPage methods == */
458
464{
465 this->title = title;
466 this->folded = true;
467}
468
478
481{
482 for (auto settings_entry : this->entries) {
483 settings_entry->ResetAll();
484 }
485}
486
489{
490 if (this->IsFiltered()) return;
491 this->folded = true;
492
494}
495
498{
499 if (this->IsFiltered()) return;
500 this->folded = false;
501
503}
504
510void SettingsPage::GetFoldingState(bool &all_folded, bool &all_unfolded) const
511{
512 if (this->IsFiltered()) return;
513
514 if (this->folded) {
515 all_unfolded = false;
516 } else {
517 all_folded = false;
518 }
519
520 SettingsContainer::GetFoldingState(all_folded, all_unfolded);
521}
522
529bool SettingsPage::UpdateFilterState(SettingFilter &filter, bool force_visible)
530{
531 if (!force_visible && !filter.string.IsEmpty()) {
532 filter.string.ResetState();
533 filter.string.AddLine(GetString(this->title));
534 force_visible = filter.string.GetState();
535 }
536
537 bool visible = SettingsContainer::UpdateFilterState(filter, force_visible);
538 this->flags.Set(SettingEntryFlag::Filtered, !visible);
539 return visible;
540}
541
549{
550 if (this->IsFiltered()) return false;
551 if (this == item) return true;
552 if (this->folded) return false;
553
554 return SettingsContainer::IsVisible(item);
555}
556
559{
560 if (this->IsFiltered()) return 0;
561 if (this->folded) return 1; // Only displaying the title
562
563 return 1 + SettingsContainer::Length();
564}
565
572BaseSettingEntry *SettingsPage::FindEntry(uint row_num, uint *cur_row)
573{
574 if (this->IsFiltered()) return nullptr;
575 if (row_num == *cur_row) return this;
576 (*cur_row)++;
577 if (this->folded) return nullptr;
578
579 return SettingsContainer::FindEntry(row_num, cur_row);
580}
581
596uint 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
597{
598 if (this->IsFiltered()) return cur_row;
599 if (cur_row >= max_row) return cur_row;
600
601 cur_row = BaseSettingEntry::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
602
603 if (!this->folded) {
605 assert(this->level < 8 * sizeof(parent_last));
606 SetBit(parent_last, this->level); // Add own last-field state
607 }
608
609 cur_row = SettingsContainer::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
610 }
611
612 return cur_row;
613}
614
621void SettingsPage::DrawSetting(GameSettings *, int left, int right, int y, bool) const
622{
623 bool rtl = _current_text_dir == TD_RTL;
624 DrawSprite((this->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? right - _setting_circle_size.width : left, y + (SETTING_HEIGHT - _setting_circle_size.height) / 2);
626}
627
630{
631 static SettingsContainer *main = nullptr;
632
633 if (main == nullptr)
634 {
635 /* Build up the dynamic settings-array only once per OpenTTD session */
636 main = new SettingsContainer();
637
638 SettingsPage *localisation = main->Add(new SettingsPage(STR_CONFIG_SETTING_LOCALISATION));
639 {
640 localisation->Add(new SettingEntry("locale.units_velocity"));
641 localisation->Add(new SettingEntry("locale.units_velocity_nautical"));
642 localisation->Add(new SettingEntry("locale.units_power"));
643 localisation->Add(new SettingEntry("locale.units_weight"));
644 localisation->Add(new SettingEntry("locale.units_volume"));
645 localisation->Add(new SettingEntry("locale.units_force"));
646 localisation->Add(new SettingEntry("locale.units_height"));
647 localisation->Add(new SettingEntry("gui.date_format_in_default_names"));
648 }
649
650 SettingsPage *graphics = main->Add(new SettingsPage(STR_CONFIG_SETTING_GRAPHICS));
651 {
652 graphics->Add(new SettingEntry("gui.zoom_min"));
653 graphics->Add(new SettingEntry("gui.zoom_max"));
654 graphics->Add(new SettingEntry("gui.sprite_zoom_min"));
655 graphics->Add(new SettingEntry("gui.smallmap_land_colour"));
656 graphics->Add(new SettingEntry("gui.linkgraph_colours"));
657 graphics->Add(new SettingEntry("gui.graph_line_thickness"));
658 }
659
660 SettingsPage *sound = main->Add(new SettingsPage(STR_CONFIG_SETTING_SOUND));
661 {
662 sound->Add(new SettingEntry("sound.click_beep"));
663 sound->Add(new SettingEntry("sound.confirm"));
664 sound->Add(new SettingEntry("sound.news_ticker"));
665 sound->Add(new SettingEntry("sound.news_full"));
666 sound->Add(new SettingEntry("sound.new_year"));
667 sound->Add(new SettingEntry("sound.disaster"));
668 sound->Add(new SettingEntry("sound.vehicle"));
669 sound->Add(new SettingEntry("sound.ambient"));
670 }
671
672 SettingsPage *interface = main->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE));
673 {
674 SettingsPage *general = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_GENERAL));
675 {
676 general->Add(new SettingEntry("gui.osk_activation"));
677 general->Add(new SettingEntry("gui.hover_delay_ms"));
678 general->Add(new SettingEntry("gui.errmsg_duration"));
679 general->Add(new SettingEntry("gui.window_snap_radius"));
680 general->Add(new SettingEntry("gui.window_soft_limit"));
681 general->Add(new SettingEntry("gui.right_click_wnd_close"));
682 }
683
684 SettingsPage *viewports = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_VIEWPORTS));
685 {
686 viewports->Add(new SettingEntry("gui.auto_scrolling"));
687 viewports->Add(new SettingEntry("gui.scroll_mode"));
688 viewports->Add(new SettingEntry("gui.smooth_scroll"));
689 /* While the horizontal scrollwheel scrolling is written as general code, only
690 * the cocoa (OSX) driver generates input for it.
691 * Since it's also able to completely disable the scrollwheel will we display it on all platforms anyway */
692 viewports->Add(new SettingEntry("gui.scrollwheel_scrolling"));
693 viewports->Add(new SettingEntry("gui.scrollwheel_multiplier"));
694#ifdef __APPLE__
695 /* We might need to emulate a right mouse button on mac */
696 viewports->Add(new SettingEntry("gui.right_mouse_btn_emulation"));
697#endif
698 viewports->Add(new SettingEntry("gui.population_in_label"));
699 viewports->Add(new SettingEntry("gui.liveries"));
700 viewports->Add(new SettingEntry("construction.train_signal_side"));
701 viewports->Add(new SettingEntry("gui.measure_tooltip"));
702 viewports->Add(new SettingEntry("gui.loading_indicators"));
703 viewports->Add(new SettingEntry("gui.show_track_reservation"));
704 }
705
706 SettingsPage *construction = interface->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE_CONSTRUCTION));
707 {
708 construction->Add(new SettingEntry("gui.link_terraform_toolbar"));
709 construction->Add(new SettingEntry("gui.persistent_buildingtools"));
710 construction->Add(new SettingEntry("gui.default_rail_type"));
711 construction->Add(new SettingEntry("gui.semaphore_build_before"));
712 construction->Add(new SettingEntry("gui.signal_gui_mode"));
713 construction->Add(new SettingEntry("gui.cycle_signal_types"));
714 construction->Add(new SettingEntry("gui.drag_signals_fixed_distance"));
715 construction->Add(new SettingEntry("gui.auto_remove_signals"));
716 }
717
718 interface->Add(new SettingEntry("gui.toolbar_pos"));
719 interface->Add(new SettingEntry("gui.statusbar_pos"));
720 interface->Add(new SettingEntry("gui.prefer_teamchat"));
721 interface->Add(new SettingEntry("gui.advanced_vehicle_list"));
722 interface->Add(new SettingEntry("gui.timetable_mode"));
723 interface->Add(new SettingEntry("gui.timetable_arrival_departure"));
724 interface->Add(new SettingEntry("gui.show_newgrf_name"));
725 interface->Add(new SettingEntry("gui.show_cargo_in_vehicle_lists"));
726 }
727
728 SettingsPage *advisors = main->Add(new SettingsPage(STR_CONFIG_SETTING_ADVISORS));
729 {
730 advisors->Add(new SettingEntry("gui.coloured_news_year"));
731 advisors->Add(new SettingEntry("news_display.general"));
732 advisors->Add(new SettingEntry("news_display.new_vehicles"));
733 advisors->Add(new SettingEntry("news_display.accident"));
734 advisors->Add(new SettingEntry("news_display.accident_other"));
735 advisors->Add(new SettingEntry("news_display.company_info"));
736 advisors->Add(new SettingEntry("news_display.acceptance"));
737 advisors->Add(new SettingEntry("news_display.arrival_player"));
738 advisors->Add(new SettingEntry("news_display.arrival_other"));
739 advisors->Add(new SettingEntry("news_display.advice"));
740 advisors->Add(new SettingEntry("gui.order_review_system"));
741 advisors->Add(new SettingEntry("gui.vehicle_income_warn"));
742 advisors->Add(new SettingEntry("gui.lost_vehicle_warn"));
743 advisors->Add(new SettingEntry("gui.old_vehicle_warn"));
744 advisors->Add(new SettingEntry("gui.show_finances"));
745 advisors->Add(new SettingEntry("news_display.economy"));
746 advisors->Add(new SettingEntry("news_display.subsidies"));
747 advisors->Add(new SettingEntry("news_display.open"));
748 advisors->Add(new SettingEntry("news_display.close"));
749 advisors->Add(new SettingEntry("news_display.production_player"));
750 advisors->Add(new SettingEntry("news_display.production_other"));
751 advisors->Add(new SettingEntry("news_display.production_nobody"));
752 }
753
754 SettingsPage *company = main->Add(new SettingsPage(STR_CONFIG_SETTING_COMPANY));
755 {
756 company->Add(new SettingEntry("gui.starting_colour"));
757 company->Add(new SettingEntry("gui.starting_colour_secondary"));
758 company->Add(new SettingEntry("company.engine_renew"));
759 company->Add(new SettingEntry("company.engine_renew_months"));
760 company->Add(new SettingEntry("company.engine_renew_money"));
761 company->Add(new SettingEntry("vehicle.servint_ispercent"));
762 company->Add(new SettingEntry("vehicle.servint_trains"));
763 company->Add(new SettingEntry("vehicle.servint_roadveh"));
764 company->Add(new SettingEntry("vehicle.servint_ships"));
765 company->Add(new SettingEntry("vehicle.servint_aircraft"));
766 }
767
768 SettingsPage *accounting = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCOUNTING));
769 {
770 accounting->Add(new SettingEntry("difficulty.infinite_money"));
771 accounting->Add(new SettingEntry("economy.inflation"));
772 accounting->Add(new SettingEntry("difficulty.initial_interest"));
773 accounting->Add(new SettingEntry("difficulty.max_loan"));
774 accounting->Add(new SettingEntry("difficulty.subsidy_multiplier"));
775 accounting->Add(new SettingEntry("difficulty.subsidy_duration"));
776 accounting->Add(new SettingEntry("economy.feeder_payment_share"));
777 accounting->Add(new SettingEntry("economy.infrastructure_maintenance"));
778 accounting->Add(new SettingEntry("difficulty.vehicle_costs"));
779 accounting->Add(new SettingEntry("difficulty.construction_cost"));
780 }
781
782 SettingsPage *vehicles = main->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES));
783 {
784 SettingsPage *physics = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_PHYSICS));
785 {
786 physics->Add(new SettingEntry("vehicle.train_acceleration_model"));
787 physics->Add(new SettingEntry("vehicle.train_slope_steepness"));
788 physics->Add(new SettingEntry("vehicle.wagon_speed_limits"));
789 physics->Add(new SettingEntry("vehicle.freight_trains"));
790 physics->Add(new SettingEntry("vehicle.roadveh_acceleration_model"));
791 physics->Add(new SettingEntry("vehicle.roadveh_slope_steepness"));
792 physics->Add(new SettingEntry("vehicle.smoke_amount"));
793 physics->Add(new SettingEntry("vehicle.plane_speed"));
794 }
795
796 SettingsPage *routing = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_ROUTING));
797 {
798 routing->Add(new SettingEntry("vehicle.road_side"));
799 routing->Add(new SettingEntry("difficulty.line_reverse_mode"));
800 routing->Add(new SettingEntry("pf.reverse_at_signals"));
801 routing->Add(new SettingEntry("pf.forbid_90_deg"));
802 }
803
804 SettingsPage *orders = vehicles->Add(new SettingsPage(STR_CONFIG_SETTING_VEHICLES_ORDERS));
805 {
806 orders->Add(new SettingEntry("gui.new_nonstop"));
807 orders->Add(new SettingEntry("gui.quick_goto"));
808 orders->Add(new SettingEntry("gui.stop_location"));
809 }
810 }
811
812 SettingsPage *limitations = main->Add(new SettingsPage(STR_CONFIG_SETTING_LIMITATIONS));
813 {
814 limitations->Add(new SettingEntry("construction.command_pause_level"));
815 limitations->Add(new SettingEntry("construction.autoslope"));
816 limitations->Add(new SettingEntry("construction.extra_dynamite"));
817 limitations->Add(new SettingEntry("construction.map_height_limit"));
818 limitations->Add(new SettingEntry("construction.max_bridge_length"));
819 limitations->Add(new SettingEntry("construction.max_bridge_height"));
820 limitations->Add(new SettingEntry("construction.max_tunnel_length"));
821 limitations->Add(new SettingEntry("station.never_expire_airports"));
822 limitations->Add(new SettingEntry("vehicle.never_expire_vehicles"));
823 limitations->Add(new SettingEntry("vehicle.max_trains"));
824 limitations->Add(new SettingEntry("vehicle.max_roadveh"));
825 limitations->Add(new SettingEntry("vehicle.max_aircraft"));
826 limitations->Add(new SettingEntry("vehicle.max_ships"));
827 limitations->Add(new SettingEntry("vehicle.max_train_length"));
828 limitations->Add(new SettingEntry("station.station_spread"));
829 limitations->Add(new SettingEntry("station.distant_join_stations"));
830 limitations->Add(new SettingEntry("station.modified_catchment"));
831 limitations->Add(new SettingEntry("construction.road_stop_on_town_road"));
832 limitations->Add(new SettingEntry("construction.road_stop_on_competitor_road"));
833 limitations->Add(new SettingEntry("construction.crossing_with_competitor"));
834 limitations->Add(new SettingEntry("vehicle.disable_elrails"));
835 limitations->Add(new SettingEntry("order.station_length_loading_penalty"));
836 }
837
838 SettingsPage *disasters = main->Add(new SettingsPage(STR_CONFIG_SETTING_ACCIDENTS));
839 {
840 disasters->Add(new SettingEntry("difficulty.disasters"));
841 disasters->Add(new SettingEntry("difficulty.economy"));
842 disasters->Add(new SettingEntry("vehicle.plane_crashes"));
843 disasters->Add(new SettingEntry("difficulty.vehicle_breakdowns"));
844 disasters->Add(new SettingEntry("order.no_servicing_if_no_breakdowns"));
845 disasters->Add(new SettingEntry("order.serviceathelipad"));
846 }
847
848 SettingsPage *genworld = main->Add(new SettingsPage(STR_CONFIG_SETTING_GENWORLD));
849 {
850 genworld->Add(new SettingEntry("game_creation.landscape"));
851 genworld->Add(new SettingEntry("game_creation.land_generator"));
852 genworld->Add(new SettingEntry("difficulty.terrain_type"));
853 genworld->Add(new SettingEntry("game_creation.tgen_smoothness"));
854 genworld->Add(new SettingEntry("game_creation.variety"));
855 genworld->Add(new SettingEntry("game_creation.snow_coverage"));
856 genworld->Add(new SettingEntry("game_creation.snow_line_height"));
857 genworld->Add(new SettingEntry("game_creation.desert_coverage"));
858 genworld->Add(new SettingEntry("game_creation.amount_of_rivers"));
859 }
860
861 SettingsPage *environment = main->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT));
862 {
863 SettingsPage *time = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TIME));
864 {
865 time->Add(new SettingEntry("economy.timekeeping_units"));
866 time->Add(new SettingEntry("economy.minutes_per_calendar_year"));
867 time->Add(new SettingEntry("game_creation.ending_year"));
868 time->Add(new SettingEntry("gui.pause_on_newgame"));
869 time->Add(new SettingEntry("gui.fast_forward_speed_limit"));
870 }
871
872 SettingsPage *authorities = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_AUTHORITIES));
873 {
874 authorities->Add(new SettingEntry("difficulty.town_council_tolerance"));
875 authorities->Add(new SettingEntry("economy.bribe"));
876 authorities->Add(new SettingEntry("economy.exclusive_rights"));
877 authorities->Add(new SettingEntry("economy.fund_roads"));
878 authorities->Add(new SettingEntry("economy.fund_buildings"));
879 authorities->Add(new SettingEntry("economy.station_noise_level"));
880 }
881
882 SettingsPage *towns = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TOWNS));
883 {
884 towns->Add(new SettingEntry("economy.town_cargo_scale"));
885 towns->Add(new SettingEntry("economy.town_growth_rate"));
886 towns->Add(new SettingEntry("economy.allow_town_roads"));
887 towns->Add(new SettingEntry("economy.allow_town_level_crossings"));
888 towns->Add(new SettingEntry("economy.found_town"));
889 towns->Add(new SettingEntry("economy.place_houses"));
890 towns->Add(new SettingEntry("economy.town_layout"));
891 towns->Add(new SettingEntry("economy.larger_towns"));
892 towns->Add(new SettingEntry("economy.initial_city_size"));
893 towns->Add(new SettingEntry("economy.town_cargogen_mode"));
894 }
895
896 SettingsPage *industries = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_INDUSTRIES));
897 {
898 industries->Add(new SettingEntry("economy.industry_cargo_scale"));
899 industries->Add(new SettingEntry("difficulty.industry_density"));
900 industries->Add(new SettingEntry("construction.raw_industry_construction"));
901 industries->Add(new SettingEntry("construction.industry_platform"));
902 industries->Add(new SettingEntry("economy.multiple_industry_per_town"));
903 industries->Add(new SettingEntry("game_creation.oil_refinery_limit"));
904 industries->Add(new SettingEntry("economy.type"));
905 industries->Add(new SettingEntry("station.serve_neutral_industries"));
906 }
907
908 SettingsPage *cdist = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_CARGODIST));
909 {
910 cdist->Add(new SettingEntry("linkgraph.recalc_time"));
911 cdist->Add(new SettingEntry("linkgraph.recalc_interval"));
912 cdist->Add(new SettingEntry("linkgraph.distribution_pax"));
913 cdist->Add(new SettingEntry("linkgraph.distribution_mail"));
914 cdist->Add(new SettingEntry("linkgraph.distribution_armoured"));
915 cdist->Add(new SettingEntry("linkgraph.distribution_default"));
916 cdist->Add(new SettingEntry("linkgraph.accuracy"));
917 cdist->Add(new SettingEntry("linkgraph.demand_distance"));
918 cdist->Add(new SettingEntry("linkgraph.demand_size"));
919 cdist->Add(new SettingEntry("linkgraph.short_path_saturation"));
920 }
921
922 SettingsPage *trees = environment->Add(new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TREES));
923 {
924 trees->Add(new SettingEntry("game_creation.tree_placer"));
925 trees->Add(new SettingEntry("construction.extra_tree_placement"));
926 }
927 }
928
929 SettingsPage *ai = main->Add(new SettingsPage(STR_CONFIG_SETTING_AI));
930 {
931 SettingsPage *npc = ai->Add(new SettingsPage(STR_CONFIG_SETTING_AI_NPC));
932 {
933 npc->Add(new SettingEntry("script.script_max_opcode_till_suspend"));
934 npc->Add(new SettingEntry("script.script_max_memory_megabytes"));
935 npc->Add(new SettingEntry("difficulty.competitor_speed"));
936 npc->Add(new SettingEntry("ai.ai_in_multiplayer"));
937 npc->Add(new SettingEntry("ai.ai_disable_veh_train"));
938 npc->Add(new SettingEntry("ai.ai_disable_veh_roadveh"));
939 npc->Add(new SettingEntry("ai.ai_disable_veh_aircraft"));
940 npc->Add(new SettingEntry("ai.ai_disable_veh_ship"));
941 }
942
943 ai->Add(new SettingEntry("economy.give_money"));
944 }
945
946 SettingsPage *network = main->Add(new SettingsPage(STR_CONFIG_SETTING_NETWORK));
947 {
948 network->Add(new SettingEntry("network.use_relay_service"));
949 }
950
951 main->Init();
952 }
953 return *main;
954}
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Set()
Set all bits.
constexpr Timpl & Reset(Tvalue_type value)
Reset the value-th bit.
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:29
int hsep_wide
Wide horizontal spacing.
Definition window_gui.h:62
int hsep_normal
Normal horizontal spacing.
Definition window_gui.h:61
int hsep_indent
Width of indentation for tree layouts.
Definition window_gui.h:63
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition gfx.cpp:705
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:658
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:989
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:245
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:387
A number of safeguards to prevent using unsafe methods.
SettingsContainer & GetSettingsTree()
Construct settings tree.
Declarations of classes for handling display of individual configuration settings.
int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
RestrictionMode
How the list of advanced settings is filtered.
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
@ RM_ADVANCED
Display settings associated to the "advanced" list.
@ RM_ALL
List all settings regardless of the default/newgame/... values.
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
@ RM_BASIC
Display settings associated to the "basic" list.
Dimension _setting_circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
static constexpr SettingEntryFlags SEF_BUTTONS_MASK
Mask for button flags.
@ LeftDepressed
Of a numeric setting entry, the left button is depressed.
@ LastField
This entry is the last one in a (sub-)page.
@ RightDepressed
Of a numeric setting entry, the right button is depressed.
@ Filtered
Entry is hidden by the string filter.
bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
static const SettingDesc * GetSettingFromName(const std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition settings.cpp:60
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:58
void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
Functions for setting GUIs.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
Functions and types used internally for the settings configurations.
@ PerCompany
This setting can be different for each company (saved in company struct).
@ GuiZeroIsSpecial
A value of zero is possible and has a custom string (the one after "strval").
@ GuiDropdown
The value represents a limited number of string-options (internally integer) presented as dropdown.
@ ST_ALL
Used in setting filter to match all types.
@ SC_ADVANCED_LIST
Settings displayed in the list of advanced settings.
@ SC_BASIC_LIST
Settings displayed in the list of basic settings.
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
Searching and filtering using a stringterm.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:57
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
@ TD_RTL
Text is written right-to-left by default.
Data structure describing a single setting in a tab.
bool IsFiltered() const
Check whether an entry is hidden due to filters.
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
virtual void Init(uint8_t level=0)
Initialization of a setting entry.
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.
SettingEntryFlags flags
Flags of the setting entry.
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
uint8_t level
Nesting level of this setting entry.
CompanySettings company
default values for per-company settings
All settings together for the game.
Base integer type, including boolean, settings.
SettingCategory cat
assigned categories of the setting
std::tuple< int32_t, uint32_t > GetRange() const
Get the min/max range for the setting.
Definition settings.cpp:489
StringID GetTitle() const
Get the title of the setting.
Definition settings.cpp:440
int32_t GetDefaultValue() const
Get the default value of the setting.
Definition settings.cpp:480
StringID GetHelp() const
Get the help text of the setting.
Definition settings.cpp:449
virtual bool IsBoolSetting() const
Check whether this setting is a boolean type setting.
std::pair< StringParameter, StringParameter > GetValueParams(int32_t value) const
Get parameters for drawing the value of the setting.
Definition settings.cpp:458
int32_t Read(const void *object) const
Read the integer from the the actual setting.
Definition settings.cpp:580
static Titem * Get(auto index)
Returns Titem with given index.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
Definition settings.cpp:902
SettingFlags flags
Handles how a setting would show up in the GUI (text/currency, etc.).
SettingType GetType() const
Return the type of the setting.
Definition settings.cpp:919
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
Definition settings.cpp:929
Standard setting.
uint Length() const override
Return number of rows needed to display the (filtered) entry.
void SetButtons(SettingEntryFlags new_val)
Set the button-depressed flags (#SettingsEntryFlag::LeftDepressed and #SettingsEntryFlag::RightDepres...
void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const override
Function to draw setting value (button + text + current value)
bool IsVisibleByRestrictionMode(RestrictionMode mode) const
Checks whether an entry shall be made visible based on the restriction mode.
uint GetMaxHelpHeight(int maxw) override
Get the biggest height of the help text(s), if the width is at least maxw.
void Init(uint8_t level=0) override
Initialization of a setting entry.
const IntSettingDesc * setting
Setting description of the setting.
SettingEntry(const char *name)
Constructor for a single setting in the 'advanced settings' window.
bool UpdateFilterState(SettingFilter &filter, bool force_visible) override
Update the filter state.
const char * name
Name of the setting.
Filter for settings list.
SettingType type
Filter based on type.
bool type_hides
Whether the type hides filtered strings.
RestrictionMode mode
Filter based on category.
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL).
StringFilter string
Filter string.
Containers for BaseSettingEntry.
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help texts, if the width is at least maxw.
void ResetAll()
Resets all settings to their default values.
bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
void FoldAll()
Recursively close all folds of sub-pages.
void UnFoldAll()
Recursively open all folds of sub-pages.
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
EntryVector entries
Settings on this page.
uint Length() const
Return number of rows needed to display the whole page.
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.
void Init(uint8_t level=0)
Initialization of an entire setting page.
Data structure describing one page of settings in the settings window.
StringID title
Title of the sub-page.
bool IsVisible(const BaseSettingEntry *item) const override
Check whether an entry is visible and not folded or filtered away.
SettingsPage(StringID title)
Constructor for a sub-page in the 'advanced settings' window.
void UnFoldAll() override
Recursively open all (filtered) folds of sub-pages.
void FoldAll() override
Recursively close all (filtered) folds of sub-pages.
uint Length() const override
Return number of rows needed to display the (filtered) entry.
BaseSettingEntry * FindEntry(uint row, uint *cur_row) override
Find setting entry at row row_num.
uint Draw(GameSettings *settings_ptr, int left, int right, int y, uint first_row, uint max_row, BaseSettingEntry *selected, uint cur_row=0, uint parent_last=0) const override
Draw a row in the settings panel.
void Init(uint8_t level=0) override
Initialization of an entire setting page.
void GetFoldingState(bool &all_folded, bool &all_unfolded) const override
Recursively accumulate the folding state of the (filtered) tree.
void ResetAll() override
Resets all settings to their default values.
bool folded
Sub-page is folded (not visible except for its title)
bool UpdateFilterState(SettingFilter &filter, bool force_visible) override
Update the filter state.
void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const override
Function to draw setting value (button + text + current value)
bool IsEmpty() const
Check whether any filter words were entered.
void ResetState()
Reset the matching state to process a new item.
bool GetState() const
Get the matching state of the current item.