Go to the documentation of this file.
24 #include "widgets/slider_func.h"
52 static const StringID _autosave_dropdown[] = {
53 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
54 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_1_MONTH,
55 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_3_MONTHS,
56 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_6_MONTHS,
57 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_12_MONTHS,
78 static DropDownList BuildSetDropDownList(
int *selected_index,
bool allow_selection)
80 int n = T::GetNumSets();
81 *selected_index = T::GetIndexOfUsedSet();
84 for (
int i = 0; i < n; i++) {
91 DropDownList BuildMusicSetDropDownList(
int *selected_index)
93 return BuildSetDropDownList<BaseMusic>(selected_index,
true);
97 template <
class TBaseSet>
104 const char *textfile = this->baseset->GetTextfile(
file_type);
123 template <
class TBaseSet>
130 std::set<int> _refresh_rates = { 30, 60, 75, 90, 100, 120, 144, 240 };
143 std::copy(monitorRates.begin(), monitorRates.end(), std::inserter(_refresh_rates, _refresh_rates.end()));
146 static const std::map<int, StringID> _scale_labels = {
147 { 100, STR_GAME_OPTIONS_GUI_SCALE_1X },
151 { 200, STR_GAME_OPTIONS_GUI_SCALE_2X },
155 { 300, STR_GAME_OPTIONS_GUI_SCALE_3X },
159 { 400, STR_GAME_OPTIONS_GUI_SCALE_4X },
163 { 500, STR_GAME_OPTIONS_GUI_SCALE_5X },
174 this->reload =
false;
221 const StringID *items = _autosave_dropdown;
229 for (uint i = 0; i <
_languages.size(); i++) {
230 bool hide_language = IsReleasedVersion() && !
_languages[i].IsReasonablyFinished();
231 if (hide_language)
continue;
233 auto item =
new DropDownListParamStringItem(hide_percentage ? STR_JUST_RAW_STRING : STR_GAME_OPTIONS_LANGUAGE_PERCENTAGE, i,
false);
245 item->SetParam(1, (LANGUAGE_TOTAL_STRINGS -
_languages[i].missing) * 100 / LANGUAGE_TOTAL_STRINGS);
246 list.emplace_back(item);
260 list.emplace_back(item);
265 for (
auto it = _refresh_rates.begin(); it != _refresh_rates.end(); it++) {
266 auto i = std::distance(_refresh_rates.begin(), it);
269 item->SetParam(0, *it);
270 list.emplace_back(item);
275 list = BuildSetDropDownList<BaseGraphics>(selected_index, (_game_mode == GM_MENU));
279 list = BuildSetDropDownList<BaseSounds>(selected_index, (_game_mode == GM_MENU));
283 list = BuildMusicSetDropDownList(selected_index);
307 SetDParam(0, STR_GAME_OPTIONS_RESOLUTION_OTHER);
309 SetDParam(0, STR_GAME_OPTIONS_RESOLUTION_ITEM);
337 DrawSliderWidget(r, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, this->gui_scale, _scale_labels);
357 size->height = std::max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
365 if (invalid_files == 0)
continue;
376 size->height = std::max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
384 size->height = std::max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
392 if (invalid_files == 0)
continue;
404 for (
const auto &ddli : list) {
406 int width = ddli->Width();
407 string_dim.width =
width + padding.width;
408 string_dim.height = ddli->Height(
width) + padding.height;
409 *size =
maxdim(*size, string_dim);
439 if (!ToggleFullScreen(!_fullscreen)) {
481 if (
ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE, this->gui_scale)) {
482 if (!
_ctrl_pressed) this->gui_scale = ((this->gui_scale + 12) / 25) * 25;
507 if (
ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, 0, INT8_MAX, vol)) {
511 SetEffectVolume(vol);
560 if (_game_mode == GM_MENU) {
561 auto name = T::GetSet(index)->name;
589 ClearAllCachedNames();
612 this->SetMediaSet<BaseGraphics>(index);
616 this->SetMediaSet<BaseSounds>(index);
632 if (!gui_scope)
return;
646 this->GetWidget<NWidgetCore>(
WID_GO_BASE_GRF_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_GRF_STATUS, STR_NULL);
648 for (
TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
655 this->GetWidget<NWidgetCore>(
WID_GO_BASE_MUSIC_STATUS)->SetDataTip(missing_files ? STR_EMPTY : STR_GAME_OPTIONS_BASE_MUSIC_STATUS, STR_NULL);
659 static const NWidgetPart _nested_game_options_widgets[] = {
681 NWidget(
WWT_EMPTY, COLOUR_GREY,
WID_GO_GUI_SCALE),
SetMinimalSize(67, 0),
SetMinimalTextLines(1, 12 +
WidgetDimensions::unscaled.vsep_normal,
FS_SMALL),
SetFill(0, 0),
SetDataTip(0x0, STR_GAME_OPTIONS_GUI_SCALE_TOOLTIP),
739 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),
753 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),
768 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),
770 NWidget(
WWT_PUSHIMGBTN, COLOUR_GREY,
WID_GO_BASE_MUSIC_JUKEBOX),
SetMinimalSize(22, 22),
SetDataTip(SPR_IMG_MUSIC, STR_TOOLBAR_TOOLTIP_SHOW_SOUND_MUSIC_WINDOW),
SetPadding(6, 0, 6, 0),
786 _nested_game_options_widgets,
lengthof(_nested_game_options_widgets)
840 virtual void FoldAll() {}
841 virtual void UnFoldAll() {}
842 virtual void ResetAll() = 0;
850 virtual uint Length()
const = 0;
851 virtual void GetFoldingState(
bool &all_folded,
bool &all_unfolded)
const {}
854 virtual uint GetMaxHelpHeight(
int maxw) {
return 0; }
862 virtual bool UpdateFilterState(
SettingFilter &filter,
bool force_visible) = 0;
864 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;
867 virtual void DrawSetting(
GameSettings *settings_ptr,
int left,
int right,
int y,
bool highlight)
const = 0;
878 virtual void ResetAll();
879 virtual uint
Length()
const;
905 typedef std::vector<BaseSettingEntry*> EntryVector;
911 this->entries.push_back(item);
915 void Init(
byte level = 0);
928 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;
943 virtual uint
Length()
const;
944 virtual void GetFoldingState(
bool &all_folded,
bool &all_unfolded)
const;
951 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;
989 if (row_num == *cur_row)
return this;
1026 if (cur_row >= max_row)
return cur_row;
1032 int x = rtl ? right : left;
1033 if (cur_row >= first_row) {
1038 for (uint lvl = 0; lvl < this->
level; lvl++) {
1039 if (!
HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y +
SETTING_HEIGHT - 1, colour);
1045 GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
1050 this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y,
this == selected);
1080 void SettingEntry::ResetAll()
1120 if (mode ==
RM_ALL)
return true;
1129 int64 current_value = sd->
Read(
object);
1136 filter_value = sd->
def;
1149 return current_value != filter_value;
1162 bool visible =
true;
1199 return settings_ptr;
1210 SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
1246 SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
1247 int32 value = sd->
Read(ResolveObject(settings_ptr, sd));
1271 for (EntryVector::iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1279 for (
auto settings_entry : this->
entries) {
1280 settings_entry->ResetAll();
1287 for (EntryVector::iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1295 for (EntryVector::iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1307 for (EntryVector::const_iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1308 (*it)->GetFoldingState(all_folded, all_unfolded);
1320 bool visible =
false;
1321 bool first_visible =
true;
1322 for (EntryVector::reverse_iterator it = this->
entries.rbegin(); it != this->entries.rend(); ++it) {
1323 visible |= (*it)->UpdateFilterState(filter, force_visible);
1324 (*it)->SetLastField(first_visible);
1325 if (visible && first_visible) first_visible =
false;
1339 for (EntryVector::const_iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1340 if ((*it)->IsVisible(item))
return true;
1349 for (EntryVector::const_iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1350 length += (*it)->Length();
1364 for (EntryVector::iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1365 pe = (*it)->
FindEntry(row_num, cur_row);
1366 if (pe !=
nullptr) {
1381 for (EntryVector::const_iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1382 biggest = std::max(biggest, (*it)->GetMaxHelpHeight(maxw));
1404 for (EntryVector::const_iterator it = this->
entries.begin(); it != this->entries.end(); ++it) {
1405 cur_row = (*it)->Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1406 if (cur_row >= max_row) {
1421 this->title =
title;
1438 for (
auto settings_entry : this->
entries) {
1439 settings_entry->ResetAll();
1471 all_unfolded =
false;
1511 if (
this == item)
return true;
1512 if (this->
folded)
return false;
1521 if (this->
folded)
return 1;
1535 if (row_num == *cur_row)
return this;
1537 if (this->
folded)
return nullptr;
1559 if (cur_row >= max_row)
return cur_row;
1561 cur_row =
BaseSettingEntry::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1565 assert(this->
level < 8 *
sizeof(parent_last));
1569 cur_row =
SettingsContainer::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1595 if (
main ==
nullptr)
1602 localisation->Add(
new SettingEntry(
"locale.units_velocity"));
1603 localisation->Add(
new SettingEntry(
"locale.units_power"));
1604 localisation->Add(
new SettingEntry(
"locale.units_weight"));
1605 localisation->Add(
new SettingEntry(
"locale.units_volume"));
1606 localisation->Add(
new SettingEntry(
"locale.units_force"));
1607 localisation->Add(
new SettingEntry(
"locale.units_height"));
1608 localisation->Add(
new SettingEntry(
"gui.date_format_in_default_names"));
1615 graphics->Add(
new SettingEntry(
"gui.sprite_zoom_min"));
1616 graphics->Add(
new SettingEntry(
"gui.smallmap_land_colour"));
1617 graphics->Add(
new SettingEntry(
"gui.linkgraph_colours"));
1618 graphics->Add(
new SettingEntry(
"gui.graph_line_thickness"));
1640 general->Add(
new SettingEntry(
"gui.window_snap_radius"));
1641 general->Add(
new SettingEntry(
"gui.window_soft_limit"));
1642 general->Add(
new SettingEntry(
"gui.right_mouse_wnd_close"));
1647 viewports->Add(
new SettingEntry(
"gui.auto_scrolling"));
1653 viewports->Add(
new SettingEntry(
"gui.scrollwheel_scrolling"));
1654 viewports->Add(
new SettingEntry(
"gui.scrollwheel_multiplier"));
1657 viewports->Add(
new SettingEntry(
"gui.right_mouse_btn_emulation"));
1659 viewports->Add(
new SettingEntry(
"gui.population_in_label"));
1661 viewports->Add(
new SettingEntry(
"construction.train_signal_side"));
1662 viewports->Add(
new SettingEntry(
"gui.measure_tooltip"));
1663 viewports->Add(
new SettingEntry(
"gui.loading_indicators"));
1664 viewports->Add(
new SettingEntry(
"gui.show_track_reservation"));
1669 construction->Add(
new SettingEntry(
"gui.link_terraform_toolbar"));
1670 construction->Add(
new SettingEntry(
"gui.persistent_buildingtools"));
1672 construction->Add(
new SettingEntry(
"gui.default_rail_type"));
1675 interface->Add(
new SettingEntry(
"gui.fast_forward_speed_limit"));
1679 interface->Add(
new SettingEntry(
"gui.prefer_teamchat"));
1680 interface->Add(
new SettingEntry(
"gui.advanced_vehicle_list"));
1681 interface->Add(
new SettingEntry(
"gui.timetable_in_ticks"));
1682 interface->Add(
new SettingEntry(
"gui.timetable_arrival_departure"));
1683 interface->Add(
new SettingEntry(
"gui.show_newgrf_name"));
1684 interface->Add(
new SettingEntry(
"gui.show_cargo_in_vehicle_lists"));
1689 advisors->Add(
new SettingEntry(
"gui.coloured_news_year"));
1690 advisors->Add(
new SettingEntry(
"news_display.general"));
1691 advisors->Add(
new SettingEntry(
"news_display.new_vehicles"));
1692 advisors->Add(
new SettingEntry(
"news_display.accident"));
1693 advisors->Add(
new SettingEntry(
"news_display.accident_other"));
1694 advisors->Add(
new SettingEntry(
"news_display.company_info"));
1695 advisors->Add(
new SettingEntry(
"news_display.acceptance"));
1696 advisors->Add(
new SettingEntry(
"news_display.arrival_player"));
1697 advisors->Add(
new SettingEntry(
"news_display.arrival_other"));
1698 advisors->Add(
new SettingEntry(
"news_display.advice"));
1699 advisors->Add(
new SettingEntry(
"gui.order_review_system"));
1700 advisors->Add(
new SettingEntry(
"gui.vehicle_income_warn"));
1701 advisors->Add(
new SettingEntry(
"gui.lost_vehicle_warn"));
1703 advisors->Add(
new SettingEntry(
"news_display.economy"));
1704 advisors->Add(
new SettingEntry(
"news_display.subsidies"));
1707 advisors->Add(
new SettingEntry(
"news_display.production_player"));
1708 advisors->Add(
new SettingEntry(
"news_display.production_other"));
1709 advisors->Add(
new SettingEntry(
"news_display.production_nobody"));
1714 company->Add(
new SettingEntry(
"gui.semaphore_build_before"));
1715 company->Add(
new SettingEntry(
"gui.cycle_signal_types"));
1717 company->Add(
new SettingEntry(
"gui.drag_signals_fixed_distance"));
1718 company->Add(
new SettingEntry(
"gui.auto_remove_signals"));
1722 company->Add(
new SettingEntry(
"company.engine_renew"));
1723 company->Add(
new SettingEntry(
"company.engine_renew_months"));
1724 company->Add(
new SettingEntry(
"company.engine_renew_money"));
1725 company->Add(
new SettingEntry(
"vehicle.servint_ispercent"));
1726 company->Add(
new SettingEntry(
"vehicle.servint_trains"));
1727 company->Add(
new SettingEntry(
"vehicle.servint_roadveh"));
1728 company->Add(
new SettingEntry(
"vehicle.servint_ships"));
1729 company->Add(
new SettingEntry(
"vehicle.servint_aircraft"));
1734 accounting->Add(
new SettingEntry(
"economy.inflation"));
1735 accounting->Add(
new SettingEntry(
"difficulty.initial_interest"));
1736 accounting->Add(
new SettingEntry(
"difficulty.max_loan"));
1737 accounting->Add(
new SettingEntry(
"difficulty.subsidy_multiplier"));
1738 accounting->Add(
new SettingEntry(
"difficulty.subsidy_duration"));
1739 accounting->Add(
new SettingEntry(
"economy.feeder_payment_share"));
1740 accounting->Add(
new SettingEntry(
"economy.infrastructure_maintenance"));
1741 accounting->Add(
new SettingEntry(
"difficulty.vehicle_costs"));
1742 accounting->Add(
new SettingEntry(
"difficulty.construction_cost"));
1749 physics->Add(
new SettingEntry(
"vehicle.train_acceleration_model"));
1750 physics->Add(
new SettingEntry(
"vehicle.train_slope_steepness"));
1751 physics->Add(
new SettingEntry(
"vehicle.wagon_speed_limits"));
1752 physics->Add(
new SettingEntry(
"vehicle.freight_trains"));
1753 physics->Add(
new SettingEntry(
"vehicle.roadveh_acceleration_model"));
1754 physics->Add(
new SettingEntry(
"vehicle.roadveh_slope_steepness"));
1755 physics->Add(
new SettingEntry(
"vehicle.smoke_amount"));
1761 routing->Add(
new SettingEntry(
"pf.pathfinder_for_trains"));
1762 routing->Add(
new SettingEntry(
"difficulty.line_reverse_mode"));
1763 routing->Add(
new SettingEntry(
"pf.reverse_at_signals"));
1765 routing->Add(
new SettingEntry(
"pf.pathfinder_for_roadvehs"));
1766 routing->Add(
new SettingEntry(
"pf.pathfinder_for_ships"));
1769 vehicles->Add(
new SettingEntry(
"order.no_servicing_if_no_breakdowns"));
1770 vehicles->Add(
new SettingEntry(
"order.serviceathelipad"));
1775 limitations->Add(
new SettingEntry(
"construction.command_pause_level"));
1776 limitations->Add(
new SettingEntry(
"construction.autoslope"));
1777 limitations->Add(
new SettingEntry(
"construction.extra_dynamite"));
1778 limitations->Add(
new SettingEntry(
"construction.map_height_limit"));
1779 limitations->Add(
new SettingEntry(
"construction.max_bridge_length"));
1780 limitations->Add(
new SettingEntry(
"construction.max_bridge_height"));
1781 limitations->Add(
new SettingEntry(
"construction.max_tunnel_length"));
1782 limitations->Add(
new SettingEntry(
"station.never_expire_airports"));
1783 limitations->Add(
new SettingEntry(
"vehicle.never_expire_vehicles"));
1784 limitations->Add(
new SettingEntry(
"vehicle.max_trains"));
1785 limitations->Add(
new SettingEntry(
"vehicle.max_roadveh"));
1786 limitations->Add(
new SettingEntry(
"vehicle.max_aircraft"));
1787 limitations->Add(
new SettingEntry(
"vehicle.max_ships"));
1788 limitations->Add(
new SettingEntry(
"vehicle.max_train_length"));
1789 limitations->Add(
new SettingEntry(
"station.station_spread"));
1790 limitations->Add(
new SettingEntry(
"station.distant_join_stations"));
1791 limitations->Add(
new SettingEntry(
"construction.road_stop_on_town_road"));
1792 limitations->Add(
new SettingEntry(
"construction.road_stop_on_competitor_road"));
1793 limitations->Add(
new SettingEntry(
"vehicle.disable_elrails"));
1798 disasters->Add(
new SettingEntry(
"difficulty.disasters"));
1799 disasters->Add(
new SettingEntry(
"difficulty.economy"));
1800 disasters->Add(
new SettingEntry(
"difficulty.vehicle_breakdowns"));
1801 disasters->Add(
new SettingEntry(
"vehicle.plane_crashes"));
1806 genworld->Add(
new SettingEntry(
"game_creation.landscape"));
1807 genworld->Add(
new SettingEntry(
"game_creation.land_generator"));
1808 genworld->Add(
new SettingEntry(
"difficulty.terrain_type"));
1809 genworld->Add(
new SettingEntry(
"game_creation.tgen_smoothness"));
1810 genworld->Add(
new SettingEntry(
"game_creation.variety"));
1811 genworld->Add(
new SettingEntry(
"game_creation.snow_coverage"));
1812 genworld->Add(
new SettingEntry(
"game_creation.snow_line_height"));
1813 genworld->Add(
new SettingEntry(
"game_creation.desert_coverage"));
1814 genworld->Add(
new SettingEntry(
"game_creation.amount_of_rivers"));
1815 genworld->Add(
new SettingEntry(
"game_creation.tree_placer"));
1817 genworld->Add(
new SettingEntry(
"economy.larger_towns"));
1818 genworld->Add(
new SettingEntry(
"economy.initial_city_size"));
1819 genworld->Add(
new SettingEntry(
"economy.town_layout"));
1820 genworld->Add(
new SettingEntry(
"difficulty.industry_density"));
1821 genworld->Add(
new SettingEntry(
"gui.pause_on_newgame"));
1822 genworld->Add(
new SettingEntry(
"game_creation.ending_year"));
1829 authorities->Add(
new SettingEntry(
"difficulty.town_council_tolerance"));
1831 authorities->Add(
new SettingEntry(
"economy.exclusive_rights"));
1832 authorities->Add(
new SettingEntry(
"economy.fund_roads"));
1833 authorities->Add(
new SettingEntry(
"economy.fund_buildings"));
1834 authorities->Add(
new SettingEntry(
"economy.station_noise_level"));
1839 towns->Add(
new SettingEntry(
"economy.town_growth_rate"));
1840 towns->Add(
new SettingEntry(
"economy.allow_town_roads"));
1841 towns->Add(
new SettingEntry(
"economy.allow_town_level_crossings"));
1843 towns->Add(
new SettingEntry(
"economy.town_cargogen_mode"));
1848 industries->Add(
new SettingEntry(
"construction.raw_industry_construction"));
1849 industries->Add(
new SettingEntry(
"construction.industry_platform"));
1850 industries->Add(
new SettingEntry(
"economy.multiple_industry_per_town"));
1851 industries->Add(
new SettingEntry(
"game_creation.oil_refinery_limit"));
1853 industries->Add(
new SettingEntry(
"station.serve_neutral_industries"));
1859 cdist->Add(
new SettingEntry(
"linkgraph.recalc_interval"));
1860 cdist->Add(
new SettingEntry(
"linkgraph.distribution_pax"));
1861 cdist->Add(
new SettingEntry(
"linkgraph.distribution_mail"));
1862 cdist->Add(
new SettingEntry(
"linkgraph.distribution_armoured"));
1863 cdist->Add(
new SettingEntry(
"linkgraph.distribution_default"));
1865 cdist->Add(
new SettingEntry(
"linkgraph.demand_distance"));
1867 cdist->Add(
new SettingEntry(
"linkgraph.short_path_saturation"));
1870 environment->Add(
new SettingEntry(
"station.modified_catchment"));
1871 environment->Add(
new SettingEntry(
"construction.extra_tree_placement"));
1879 npc->Add(
new SettingEntry(
"script.script_max_opcode_till_suspend"));
1880 npc->Add(
new SettingEntry(
"script.script_max_memory_megabytes"));
1881 npc->Add(
new SettingEntry(
"difficulty.competitor_speed"));
1884 npc->Add(
new SettingEntry(
"ai.ai_disable_veh_roadveh"));
1885 npc->Add(
new SettingEntry(
"ai.ai_disable_veh_aircraft"));
1891 ai->Add(
new SettingEntry(
"economy.min_years_for_shares"));
1896 network->Add(
new SettingEntry(
"network.use_relay_service"));
1904 static const StringID _game_settings_restrict_dropdown[] = {
1905 STR_CONFIG_SETTING_RESTRICT_BASIC,
1906 STR_CONFIG_SETTING_RESTRICT_ADVANCED,
1907 STR_CONFIG_SETTING_RESTRICT_ALL,
1908 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,
1909 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,
1911 static_assert(
lengthof(_game_settings_restrict_dropdown) ==
RM_END);
1956 this->warn_lines = 0;
1958 this->filter.min_cat =
RM_ALL;
1959 this->filter.type =
ST_ALL;
1960 this->filter.type_hides =
false;
1965 this->valuewindow_entry =
nullptr;
1966 this->clicked_entry =
nullptr;
1967 this->last_clicked =
nullptr;
1968 this->valuedropdown_entry =
nullptr;
1969 this->closing_dropdown =
false;
1970 this->manually_changed_folding =
false;
1999 static const StringID setting_types[] = {
2000 STR_CONFIG_SETTING_TYPE_CLIENT,
2001 STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
2002 STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
2004 for (uint i = 0; i <
lengthof(setting_types); i++) {
2009 std::max(size->height,
GetSettingsTree().GetMaxHelpHeight(size->width));
2025 if (this->closing_dropdown) {
2026 this->closing_dropdown =
false;
2027 assert(this->valuedropdown_entry !=
nullptr);
2029 this->valuedropdown_entry =
nullptr;
2036 if (this->warn_missing ==
WHR_NONE) {
2042 if (this->warn_lines != new_warn_lines) {
2043 this->vscroll->
SetCount(this->vscroll->
GetCount() - this->warn_lines + new_warn_lines);
2044 this->warn_lines = new_warn_lines;
2050 if (this->warn_missing !=
WHR_NONE) {
2060 SetDParam(0, _game_settings_restrict_dropdown[this->filter.
mode]);
2064 switch (this->filter.
type) {
2065 case ST_GAME:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME);
break;
2066 case ST_COMPANY:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME);
break;
2068 default:
SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL);
break;
2079 for (
int mode = 0; mode !=
RM_END; mode++) {
2090 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));
2091 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));
2106 this->vscroll->GetPosition(), last_row, this->last_clicked);
2107 if (next_row == 0)
DrawString(tr, STR_CONFIG_SETTINGS_NONE);
2112 if (this->last_clicked !=
nullptr) {
2117 case ST_COMPANY:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME);
break;
2119 case ST_GAME:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME);
break;
2120 default: NOT_REACHED();
2126 DrawString(tr, STR_CONFIG_SETTING_DEFAULT_VALUE);
2144 if (this->last_clicked != pe) this->
SetDirty();
2145 this->last_clicked = pe;
2152 this->manually_changed_folding =
true;
2158 this->manually_changed_folding =
true;
2165 STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_CAPTION,
2166 STR_CONFIG_SETTING_RESET_ALL_CONFIRMATION_DIALOG_TEXT,
2174 if (!list.empty()) {
2182 if (!list.empty()) {
2192 if (btn == INT_MAX || (
int)btn < this->
warn_lines)
return;
2204 if (clicked_page !=
nullptr) {
2208 this->manually_changed_folding =
true;
2215 assert(pe !=
nullptr);
2230 if (this->valuedropdown_entry == pe) {
2233 this->closing_dropdown =
false;
2235 this->valuedropdown_entry =
nullptr;
2237 if (this->valuedropdown_entry !=
nullptr) this->valuedropdown_entry->
SetButtons(0);
2238 this->closing_dropdown =
false;
2250 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
2251 this->valuedropdown_entry = pe;
2255 for (
int i = sd->
min; i <= (
int)sd->
max; i++) {
2265 int32 oldvalue = value;
2275 if (step == 0) step = 1;
2287 assert((int32)sd->
max >= 0);
2288 if (value > (int32)sd->
max) value = (int32)sd->
max;
2290 if ((uint32)value > sd->
max) value = (int32)sd->
max;
2292 if (value < sd->min) value = sd->
min;
2299 if (value != oldvalue) {
2300 if (this->clicked_entry !=
nullptr) {
2301 this->clicked_entry->SetButtons(0);
2303 this->clicked_entry = pe;
2310 if (value != oldvalue) {
2317 int64 value64 = value;
2324 this->valuewindow_entry = pe;
2335 if (this->clicked_entry !=
nullptr) {
2337 this->clicked_entry =
nullptr;
2345 if (str ==
nullptr)
return;
2347 assert(this->valuewindow_entry !=
nullptr);
2352 long long llvalue = atoll(str);
2374 if (!this->manually_changed_folding) {
2394 assert(this->valuedropdown_entry !=
nullptr);
2418 assert(this->valuedropdown_entry !=
nullptr);
2419 this->closing_dropdown =
true;
2426 if (!gui_scope)
return;
2430 this->filter.min_cat = min_level;
2431 this->filter.type_hides =
false;
2447 bool all_folded =
true;
2448 bool all_unfolded =
true;
2458 if (!this->filter.
string.
IsEmpty() && !this->manually_changed_folding) {
2475 static const NWidgetPart _nested_settings_selection_widgets[] = {
2485 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),
2489 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),
2493 NWidget(
WWT_EDITBOX, COLOUR_MAUVE,
WID_GS_FILTER),
SetMinimalSize(50, 12),
SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
SetFill(1, 0),
SetResize(1, 0),
2519 _nested_settings_selection_widgets,
lengthof(_nested_settings_selection_widgets)
2539 void DrawArrowButtons(
int x,
int y, Colours button_colour,
byte state,
bool clickable_left,
bool clickable_right)
2542 Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
2544 Rect lr = {x, y, x + (int)dim.width - 1, y + (
int)dim.height - 1};
2545 Rect rr = {x + (int)dim.width, y, x + (
int)dim.width * 2 - 1, y + (int)dim.height - 1};
2549 DrawSpriteIgnorePadding(SPR_ARROW_LEFT, PAL_NONE, lr, (state == 1),
SA_CENTER);
2550 DrawSpriteIgnorePadding(SPR_ARROW_RIGHT, PAL_NONE, rr, (state == 2),
SA_CENTER);
2554 if (rtl ? !clickable_right : !clickable_left) {
2557 if (rtl ? !clickable_left : !clickable_right) {
2577 DrawSpriteIgnorePadding(SPR_ARROW_DOWN, PAL_NONE, r, state,
SA_CENTER);
2593 static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
2609 void SetButtonState()
2625 SetDParam(0, (_custom_currency.to_euro !=
CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
2663 if (_custom_currency.rate > 1) _custom_currency.rate--;
2669 if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
2685 str = STR_JUST_RAW_STRING;
2693 str = STR_JUST_RAW_STRING;
2701 str = STR_JUST_RAW_STRING;
2707 _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ?
CF_NOEURO : _custom_currency.to_euro - 1;
2713 _custom_currency.to_euro =
Clamp(_custom_currency.to_euro + 1, 2000,
MAX_YEAR);
2728 this->query_widget = line;
2729 ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1,
this, afilter, QSF_NONE);
2738 if (str ==
nullptr)
return;
2740 switch (this->query_widget) {
2742 _custom_currency.rate =
Clamp(atoi(str), 1, UINT16_MAX);
2746 _custom_currency.separator = str;
2750 _custom_currency.prefix = str;
2754 _custom_currency.suffix = str;
2758 int val = atoi(str);
2774 static const NWidgetPart _nested_cust_currency_widgets[] = {
2810 SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP),
SetPadding(15, 1, 18, 2),
2818 _nested_cust_currency_widgets,
lengthof(_nested_cust_currency_widgets)
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
@ WC_CUSTOM_CURRENCY
Custom currency; Window numbers:
@ SEF_RIGHT_DEPRESSED
Of a numeric setting entry, the right button is depressed.
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
void OnTimeout() override
Called when this window's timeout has been reached.
static const int CF_NOEURO
Currency never switches to the Euro (as far as known).
@ SF_PER_COMPANY
This setting can be different for each company (saved in company struct).
static int32 ClampToI32(const int64 a)
Reduce a signed 64-bit int to a signed 32-bit one.
uint16 refresh_rate
How often we refresh the screen (time between draw-ticks).
@ SF_GUI_0_IS_SPECIAL
A value of zero is possible and has a custom string (the one after "strval").
virtual void LoadTextfile(const char *textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
static Titem * Get(size_t index)
Returns Titem with given index.
@ SEF_LEFT_DEPRESSED
Of a numeric setting entry, the left button is depressed.
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
String list item with parameters.
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
@ SEF_BUTTONS_MASK
Bit-mask for button flags.
Dimensions (a width and height) of a rectangle in 2D.
const TBaseSet * baseset
View the textfile of this BaseSet.
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
StringID content_type
STR_CONTENT_TYPE_xxx for title.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
static const SettingDesc * GetSettingFromName(const std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
Window to edit settings of the game.
bool IsEmpty() const
Check whether any filter words were entered.
bool _left_button_down
Is left mouse button pressed?
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
SettingCategory cat
assigned categories of the setting
void SetFilterTerm(const char *str)
Set the term to filter on.
void OnInit() override
Notification that the nested widget tree gets initialized.
SettingType type
Filter based on type.
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game)
virtual void SetVolume(byte vol)=0
Set the volume, if possible.
const IntSettingDesc * setting
Setting description of the setting.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
SettingType GetType() const
Return the type of the setting.
virtual void Init(byte level=0)
Initialization of an entire setting page.
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
List item containing a C char string.
uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help texts, if the width is at least maxw.
QueryString filter_editbox
Filter editbox;.
@ ST_CLIENT
Client setting.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
void SetLastField(bool last_field)
Set whether this is the last visible entry of the parent node.
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Window for displaying the textfile of a BaseSet.
bool _ctrl_pressed
Is Ctrl pressed?
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
StringFilter string
Filter string.
virtual void Init(byte level=0)
Initialization of a setting entry.
@ ST_COMPANY
Company setting.
Base list item class from which others are derived.
EntryVector entries
Settings on this page.
ClientSettings _settings_client
The current settings for this game.
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.
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.
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
byte autosave
how often should we do autosaves?
void AddLine(const char *str)
Pass another text line from the current item to the filter.
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
SettingFlag flags
Handles how a setting would show up in the GUI (text/currency, etc.).
@ SEF_FILTERED
Entry is hidden by the string filter.
@ WC_MUSIC_WINDOW
Music window; Window numbers:
bool IsVisibleByRestrictionMode(RestrictionMode mode) const
Checks whether an entry shall be made visible based on the restriction mode.
SettingsPage(StringID title)
Constructor for a sub-page in the 'advanced settings' window.
virtual void Init(byte level=0)
Initialization of a setting entry.
Data structure describing one page of settings in the settings window.
TextfileType file_type
Type of textfile to view.
@ TFT_CHANGELOG
NewGRF changelog.
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Rect WithHeight(int height, bool end=false) const
Copy Rect and set its height.
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Data stored about a string that can be modified in the GUI.
#define SETBITS(x, y)
Sets several bits in a variable.
void OnTimeout() override
Called when this window's timeout has been reached.
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
void Close() override
Hide the window and all its child windows, and mark them for a later deletion.
int _gui_scale
GUI scale, 100 is 100%.
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
char *const buf
buffer in which text is saved
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
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.
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.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
virtual uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help text(s), if the width is at least maxw.
StringID * BuildCurrencyDropdown()
Build a list of currency names StringIDs to use in a dropdown list.
static GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
@ WN_GAME_OPTIONS_GAME_OPTIONS
Game options.
High level window description.
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
byte level
Nesting level of this setting entry.
SettingType
Type of settings for filtering.
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
int _gui_scale_cfg
GUI scale in config.
StringID title
Title of the sub-page.
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL).
@ WC_QUERY_STRING
Query string window; Window numbers:
DropDownList BuildDropDownList(int widget, int *selected_index) const
Build the dropdown list for a specific widget.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
StringID str_val
(Translated) first string describing the value.
ResizeInfo resize
Resize information.
int warn_lines
Number of lines used for warning about missing search results.
static void ResetAllSettingsConfirmationCallback(Window *w, bool confirmed)
Callback function for the reset all settings button.
virtual std::vector< int > GetListOfMonitorRefreshRates()
Get a list of refresh rates of each available monitor.
static int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
void EnableWidget(byte widget_index)
Sets a widget to Enabled.
static MusicDriver * GetInstance()
Get the currently active instance of the music driver.
RestrictionMode
How the list of advanced settings is filtered.
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
@ WHR_TYPE
Type setting filtered matches away.
int height
Height of the window (number of pixels down in y direction)
Base integer type, including boolean, settings.
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
@ FS_SMALL
Index of the small font in the font tables.
void ResetAll()
Resets all settings to their default values.
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
byte missing_strings_threshold
the number of missing strings before showing the warning
virtual void ToggleVsync(bool vsync)
Change the vsync setting.
Data structure describing a single setting in a tab.
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
Show a drop down list.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
@ RM_END
End for iteration.
RestrictionMode mode
Filter based on category.
const char * name
Name of the setting.
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
virtual void FoldAll()
Recursively close all (filtered) folds of sub-pages.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
const LanguageMetadata * _current_language
The currently loaded language.
void DrawSliderWidget(Rect r, int min_value, int max_value, int value, const std::map< int, StringID > &labels)
Draw a slider widget with knob at given value.
@ SEF_LAST_FIELD
This entry is the last one in a (sub-)page.
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
@ RM_ALL
List all settings regardless of the default/newgame/... values.
WindowFlags flags
Window flags.
std::vector< Dimension > _resolutions
List of resolutions.
@ WF_TIMEOUT
Window timeout counter.
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
All settings together for the game.
bool folded
Sub-page is folded (not visible except for its title)
@ SF_GUI_NEGATIVE_IS_SPECIAL
A negative value has another string (the one after "strval").
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
void Init(byte level=0)
Initialization of an entire setting page.
Coordinates of a point in 2D.
@ SF_GUI_CURRENCY
The number represents money, so when reading value multiply by exchange rate.
void CheckBlitter()
Check whether we still use the right blitter, or use another (better) one.
@ RM_BASIC
Display settings associated to the "basic" list.
static void AddCustomRefreshRates()
Add the refresh rate from the config and the refresh rates from all the monitors to our list of refre...
@ WHR_CATEGORY
Category setting filtered matches away.
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
bool type_hides
Whether the type hides filtered strings.
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.
static void ShowCustCurrency()
Open custom currency window.
uint Vertical() const
Get total vertical padding of RectPadding.
@ TFT_README
NewGRF readme.
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.
WarnHiddenResult
Warnings about hidden search results.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
int mouse_capture_widget
Widgetindex of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse captu...
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
@ WHR_CATEGORY_TYPE
Both category and type settings filtered matches away.
void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
int GetNumMissing() const
Get the number of missing files.
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
void SetButtons(byte new_val)
Set the button-depressed flags (SEF_LEFT_DEPRESSED and SEF_RIGHT_DEPRESSED) to a specified value.
@ TFT_LICENSE
NewGRF license.
SwitchMode _switch_mode
The next mainloop command.
void OnResize() override
Called after the window got resized.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
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...
StringID str_help
(Translated) string with help text; gui only.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ CURRENCY_END
always the last item
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
int CDECL main(int argc, char *argv[])
And the main program (what else?)
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
byte currency
currency we currently use
GRFTextWrapper name
NOSAVE: GRF name (Action 0x08)
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
int32 interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
void UnFoldAll()
Recursively open all folds of sub-pages.
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the (filtered) tree.
uint Length() const
Return number of rows needed to display the whole page.
bool SetSettingValue(const IntSettingDesc *sd, int32 value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
@ RM_CHANGED_AGAINST_DEFAULT
Show only settings which are different compared to default values.
@ SC_BASIC_LIST
Settings displayed in the list of basic settings.
bool ClickSliderWidget(Rect r, Point pt, int min_value, int max_value, int &value)
Handle click on a slider widget to change the value.
void CloseWindowByClass(WindowClass cls)
Close all windows of a given class.
StringID str
(translated) string with descriptive text; gui and console
void OnPaint() override
The window must be repainted.
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
void ResetState()
Reset the matching state to process a new item.
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
bool _video_hw_accel
Whether to consider hardware accelerated video drivers.
virtual bool IsBoolSetting() const
Check whether this setting is a boolean type setting.
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
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.
bool GetState() const
Get the matching state of the current item.
@ SF_GUI_DROPDOWN
The value represents a limited number of string-options (internally integer) presented as dropdown.
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
int32 Read(const void *object) const
Read the integer from the the actual setting.
@ WL_ERROR
Errors (eg. saving/loading failed)
@ SM_MENU
Switch to game intro menu.
static uint GetCurrentResolutionIndex()
Get index of the current screen resolution.
static const int ACTION_CLEAR
Clear editbox.
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.
@ CS_NUMERAL_SIGNED
Only numbers and '-' for negative values.
static T abs(const T a)
Returns the absolute value of (scalar) variable.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
void SetValueDParams(uint first_param, int32 value) const
Set the DParams for drawing the value of a setting.
virtual 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 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.
bool _video_vsync
Whether we should use vsync (only if _video_hw_accel is enabled).
uint8 settings_restriction_mode
selected restriction mode in adv. settings GUI.
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
@ SA_CENTER
Center both horizontally and vertically.
SettingFilter filter
Filter for the list.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
#define lengthof(x)
Return the length of an fixed size array.
int width
width of the window (number of pixels to the right in x direction)
byte effect_vol
The requested effects volume.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
LocaleSettings locale
settings related to used currency/unit system in the current game
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
SettingEntry(const char *name)
Constructor for a single setting in the 'advanced settings' window.
Filter for settings list.
@ RM_CHANGED_AGAINST_NEW
Show only settings which are different compared to the user's new game setting values.
Window for displaying a textfile.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
static SettingsContainer & GetSettingsTree()
Construct settings tree.
@ ST_ALL
Used in setting filter to match all types.
CompanySettings company
default values for per-company settings
Containers for BaseSettingEntry.
bool closing_dropdown
True, if the dropdown list is currently closing.
byte flags
Flags of the setting entry.
Data structure for an opened window.
TextfileType
Additional text files accompanying Tar archives.
@ SC_ADVANCED_LIST
Settings displayed in the list of advanced settings.
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
virtual void ResetAll()
Resets all settings to their default values.
void DrawWidgets() const
Paint all widgets of a window.
void ShowGameSettings()
Open advanced settings window.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
int Width() const
Get width of Rect.
bool scale_bevels
bevels are scaled with GUI scale.
StringID GetHelpText() const
Get the help text of a single setting.
void SetWidgetDirty(byte widget_index) const
Invalidate a widget, i.e.
LanguageList _languages
The actual list of language meta data.
uint64 GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
int GetNumInvalid() const
Get the number of invalid files.
Specification of a rectangle with absolute coordinates of all edges.
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
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.
void SetDisplayedHelpText(SettingEntry *pe)
Set the entry that should have its help text displayed, and mark the window dirty so it gets repainte...
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
@ QSF_ENABLE_DEFAULT
enable the 'Default' button ("\0" is returned)
MusicSettings music
settings related to music/sound
void DisableWidget(byte widget_index)
Sets a widget to disabled.
#define CLRBITS(x, y)
Clears several bits in a variable.
@ WC_TEXTFILE
textfile; Window numbers:
@ WHR_NONE
Nothing was filtering matches away.
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
@ WDP_CENTER
Center the window.
void ChangeMusicSet(int index)
Change the configured music set and reset playback.
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button).
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
byte music_vol
The requested music volume.
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
bool _left_button_clicked
Is left mouse button clicked?
@ TD_RTL
Text is written right-to-left by default.
TextDirection _current_text_dir
Text direction of the currently selected language.
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
static Dimension _circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
@ CS_NUMERAL
Only numeric ones.
virtual void UnFoldAll()
Recursively open all (filtered) folds of sub-pages.
CharSetFilter
Valid filter types for IsValidChar.
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
int32 def
default value given when none is present
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
void SetMediaSet(int index)
Set the base media set.
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
@ CURRENCY_CUSTOM
Custom currency.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
GUISettings gui
settings related to the GUI
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.
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
bool IsFiltered() const
Check whether an entry is hidden due to filters.
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,...
@ RM_ADVANCED
Display settings associated to the "advanced" list.
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
void ShowGameOptions()
Open the game options window.
SettingEntryFlags
Flags for SettingEntry.
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().