45 static const StringID _driveside_dropdown[] = {
46 STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_LEFT,
47 STR_GAME_OPTIONS_ROAD_VEHICLES_DROPDOWN_RIGHT,
51 static const StringID _autosave_dropdown[] = {
52 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_OFF,
53 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_1_MONTH,
54 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_3_MONTHS,
55 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_6_MONTHS,
56 STR_GAME_OPTIONS_AUTOSAVE_DROPDOWN_EVERY_12_MONTHS,
60 static const StringID _gui_zoom_dropdown[] = {
61 STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_NORMAL,
62 STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_2X_ZOOM,
63 STR_GAME_OPTIONS_GUI_ZOOM_DROPDOWN_4X_ZOOM,
67 static const StringID _font_zoom_dropdown[] = {
68 STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_NORMAL,
69 STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_2X_ZOOM,
70 STR_GAME_OPTIONS_FONT_ZOOM_DROPDOWN_4X_ZOOM,
98 if (town_name <
_nb_orig_names)
return STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + town_name;
101 return STR_UNDEFINED;
121 static DropDownList BuildSetDropDownList(
int *selected_index,
bool allow_selection)
123 int n = T::GetNumSets();
124 *selected_index = T::GetIndexOfUsedSet();
127 for (
int i = 0; i < n; i++) {
134 DropDownList BuildMusicSetDropDownList(
int *selected_index)
136 return BuildSetDropDownList<BaseMusic>(selected_index,
true);
140 template <
class TBaseSet>
147 const char *textfile = this->baseset->GetTextfile(file_type);
166 template <
class TBaseSet>
180 this->reload =
false;
223 const StringID *items = _driveside_dropdown;
242 int enabled_item = (_game_mode == GM_MENU ||
Town::GetNumItems() == 0) ? -1 : *selected_index;
251 size_t newgrf_size = list.size();
253 if (newgrf_size > 0) {
260 list.emplace_back(
new DropDownListStringItem(STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + i, i, enabled_item != i && enabled_item >= 0));
268 const StringID *items = _autosave_dropdown;
276 for (uint i = 0; i <
_languages.size(); i++) {
295 const StringID *items = _gui_zoom_dropdown;
304 const StringID *items = _font_zoom_dropdown;
312 list = BuildSetDropDownList<BaseGraphics>(selected_index, (_game_mode == GM_MENU));
316 list = BuildSetDropDownList<BaseSounds>(selected_index, (_game_mode == GM_MENU));
320 list = BuildMusicSetDropDownList(selected_index);
373 size->height =
max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
381 if (invalid_files == 0)
continue;
392 size->height =
max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
400 size->height =
max(size->height, (uint)
GetStringHeight(STR_BLACK_RAW_STRING, size->width));
408 if (invalid_files == 0)
continue;
417 DropDownList list = this->BuildDropDownList(widget, &selected);
420 for (
const auto &ddli : list) {
422 int width = ddli->Width();
423 string_dim.width = width + padding.width;
424 string_dim.height = ddli->Height(width) + padding.height;
425 *size =
maxdim(*size, string_dim);
455 if (!ToggleFullScreen(!_fullscreen)) {
464 DropDownList list = this->BuildDropDownList(widget, &selected);
483 if (_game_mode == GM_MENU) {
484 const char *name = T::GetSet(index)->name;
529 ClearAllCachedNames();
558 this->SetMediaSet<BaseGraphics>(index);
562 this->SetMediaSet<BaseSounds>(index);
578 if (!gui_scope)
return;
584 for (
TextfileType tft = TFT_BEGIN; tft < TFT_END; tft++) {
595 static const NWidgetPart _nested_game_options_widgets[] = {
610 NWidget(
WWT_DROPDOWN, COLOUR_GREY,
WID_GO_RESOLUTION_DROPDOWN),
SetMinimalSize(150, 12),
SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_RESOLUTION_TOOLTIP),
SetFill(1, 0),
SetPadding(0, 0, 3, 0),
643 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),
656 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),
669 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),
683 _nested_game_options_widgets,
lengthof(_nested_game_options_widgets)
737 virtual void Init(byte level = 0);
738 virtual void FoldAll() {}
739 virtual void UnFoldAll() {}
747 virtual uint Length()
const = 0;
748 virtual void GetFoldingState(
bool &all_folded,
bool &all_unfolded)
const {}
751 virtual uint GetMaxHelpHeight(
int maxw) {
return 0; }
759 virtual bool UpdateFilterState(
SettingFilter &filter,
bool force_visible) = 0;
761 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;
764 virtual void DrawSetting(
GameSettings *settings_ptr,
int left,
int right,
int y,
bool highlight)
const = 0;
775 virtual void Init(byte level = 0);
776 virtual uint Length()
const;
777 virtual uint GetMaxHelpHeight(
int maxw);
778 virtual bool UpdateFilterState(
SettingFilter &filter,
bool force_visible);
780 void SetButtons(byte new_val);
791 void SetValueDParams(uint first_param, int32 value)
const;
794 virtual void DrawSetting(
GameSettings *settings_ptr,
int left,
int right,
int y,
bool highlight)
const;
802 typedef std::vector<BaseSettingEntry*> EntryVector;
808 this->entries.push_back(item);
812 void Init(byte level = 0);
817 void GetFoldingState(
bool &all_folded,
bool &all_unfolded)
const;
820 uint GetMaxHelpHeight(
int maxw);
822 bool UpdateFilterState(
SettingFilter &filter,
bool force_visible);
824 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;
834 virtual void Init(byte level = 0);
835 virtual void FoldAll();
836 virtual void UnFoldAll();
838 virtual uint Length()
const;
839 virtual void GetFoldingState(
bool &all_folded,
bool &all_unfolded)
const;
844 virtual bool UpdateFilterState(
SettingFilter &filter,
bool force_visible);
846 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;
849 virtual void DrawSetting(
GameSettings *settings_ptr,
int left,
int right,
int y,
bool highlight)
const;
871 if (this->IsFiltered())
return false;
872 if (
this == item)
return true;
884 if (this->IsFiltered())
return nullptr;
885 if (row_num == *cur_row)
return this;
921 if (this->IsFiltered())
return cur_row;
922 if (cur_row >= max_row)
return cur_row;
925 int offset = rtl ? -4 : 4;
928 int x = rtl ? right :
left;
929 if (cur_row >= first_row) {
934 for (uint lvl = 0; lvl < this->level; lvl++) {
935 if (!
HasBit(parent_last, lvl)) GfxDrawLine(x + offset, y, x + offset, y +
SETTING_HEIGHT - 1, colour);
941 GfxDrawLine(x + offset, y, x + offset, bottom_y, colour);
943 GfxDrawLine(x + offset, halfway_y, x + level_width - offset, halfway_y, colour);
946 this->DrawSetting(settings_ptr, rtl ? left : x, rtl ? x : right, y,
this == selected);
962 this->setting =
nullptr;
974 assert(this->setting !=
nullptr);
991 return this->IsFiltered() ? 0 : 1;
1012 if (mode ==
RM_ALL)
return true;
1021 const void *var = ResolveVariableAddress(settings_ptr, sd);
1044 return current_value != filter_value;
1057 bool visible =
true;
1078 if (!this->IsVisibleByRestrictionMode(filter.
mode)) {
1111 SetDParam(first_param++, value != 0 ? STR_CONFIG_SETTING_ON : STR_CONFIG_SETTING_OFF);
1137 const void *var = ResolveVariableAddress(settings_ptr, sd);
1149 SetDParam(0, highlight ? STR_ORANGE_STRING1_WHITE : STR_ORANGE_STRING1_LTBLUE);
1162 this->SetValueDParams(1, value);
1174 for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1182 for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1190 for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1202 for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1203 (*it)->GetFoldingState(all_folded, all_unfolded);
1215 bool visible =
false;
1216 bool first_visible =
true;
1217 for (EntryVector::reverse_iterator it = this->entries.rbegin(); it != this->entries.rend(); ++it) {
1218 visible |= (*it)->UpdateFilterState(filter, force_visible);
1219 (*it)->SetLastField(first_visible);
1220 if (visible && first_visible) first_visible =
false;
1234 for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1235 if ((*it)->IsVisible(item))
return true;
1244 for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1245 length += (*it)->Length();
1259 for (EntryVector::iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1260 pe = (*it)->
FindEntry(row_num, cur_row);
1261 if (pe !=
nullptr) {
1276 for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1277 biggest =
max(biggest, (*it)->GetMaxHelpHeight(maxw));
1299 for (EntryVector::const_iterator it = this->entries.begin(); it != this->entries.end(); ++it) {
1300 cur_row = (*it)->Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1301 if (cur_row >= max_row) {
1316 this->title = title;
1317 this->folded =
true;
1333 if (this->IsFiltered())
return;
1334 this->folded =
true;
1342 if (this->IsFiltered())
return;
1343 this->folded =
false;
1355 if (this->IsFiltered())
return;
1358 all_unfolded =
false;
1397 if (this->IsFiltered())
return false;
1398 if (
this == item)
return true;
1399 if (this->folded)
return false;
1407 if (this->IsFiltered())
return 0;
1408 if (this->folded)
return 1;
1421 if (this->IsFiltered())
return nullptr;
1422 if (row_num == *cur_row)
return this;
1424 if (this->folded)
return nullptr;
1445 if (this->IsFiltered())
return cur_row;
1446 if (cur_row >= max_row)
return cur_row;
1448 cur_row =
BaseSettingEntry::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1450 if (!this->folded) {
1452 assert(this->level < 8 *
sizeof(parent_last));
1453 SetBit(parent_last, this->level);
1456 cur_row =
SettingsContainer::Draw(settings_ptr, left, right, y, first_row, max_row, selected, cur_row, parent_last);
1473 DrawSprite((this->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED), PAL_NONE, rtl ? right - _circle_size.width : left, y + (
SETTING_HEIGHT - _circle_size.height) / 2);
1482 if (main ==
nullptr)
1489 localisation->Add(
new SettingEntry(
"locale.units_velocity"));
1490 localisation->Add(
new SettingEntry(
"locale.units_power"));
1491 localisation->Add(
new SettingEntry(
"locale.units_weight"));
1492 localisation->Add(
new SettingEntry(
"locale.units_volume"));
1493 localisation->Add(
new SettingEntry(
"locale.units_force"));
1494 localisation->Add(
new SettingEntry(
"locale.units_height"));
1495 localisation->Add(
new SettingEntry(
"gui.date_format_in_default_names"));
1502 graphics->Add(
new SettingEntry(
"gui.smallmap_land_colour"));
1503 graphics->Add(
new SettingEntry(
"gui.graph_line_thickness"));
1518 SettingsPage *
interface = main->Add(new SettingsPage(STR_CONFIG_SETTING_INTERFACE));
1520 SettingsPage *general = interface->Add(
new SettingsPage(STR_CONFIG_SETTING_INTERFACE_GENERAL));
1525 general->Add(
new SettingEntry(
"gui.window_snap_radius"));
1526 general->Add(
new SettingEntry(
"gui.window_soft_limit"));
1527 general->Add(
new SettingEntry(
"gui.right_mouse_wnd_close"));
1530 SettingsPage *viewports = interface->Add(
new SettingsPage(STR_CONFIG_SETTING_INTERFACE_VIEWPORTS));
1532 viewports->Add(
new SettingEntry(
"gui.auto_scrolling"));
1538 viewports->Add(
new SettingEntry(
"gui.scrollwheel_scrolling"));
1539 viewports->Add(
new SettingEntry(
"gui.scrollwheel_multiplier"));
1542 viewports->Add(
new SettingEntry(
"gui.right_mouse_btn_emulation"));
1544 viewports->Add(
new SettingEntry(
"gui.population_in_label"));
1546 viewports->Add(
new SettingEntry(
"construction.train_signal_side"));
1547 viewports->Add(
new SettingEntry(
"gui.measure_tooltip"));
1548 viewports->Add(
new SettingEntry(
"gui.loading_indicators"));
1549 viewports->Add(
new SettingEntry(
"gui.show_track_reservation"));
1552 SettingsPage *construction = interface->Add(
new SettingsPage(STR_CONFIG_SETTING_INTERFACE_CONSTRUCTION));
1554 construction->Add(
new SettingEntry(
"gui.link_terraform_toolbar"));
1555 construction->Add(
new SettingEntry(
"gui.enable_signal_gui"));
1556 construction->Add(
new SettingEntry(
"gui.persistent_buildingtools"));
1558 construction->Add(
new SettingEntry(
"gui.default_rail_type"));
1559 construction->Add(
new SettingEntry(
"gui.disable_unsuitable_building"));
1565 interface->Add(
new SettingEntry(
"gui.prefer_teamchat"));
1566 interface->Add(
new SettingEntry(
"gui.advanced_vehicle_list"));
1567 interface->Add(
new SettingEntry(
"gui.timetable_in_ticks"));
1568 interface->Add(
new SettingEntry(
"gui.timetable_arrival_departure"));
1569 interface->Add(
new SettingEntry(
"gui.expenses_layout"));
1570 interface->Add(
new SettingEntry(
"gui.show_newgrf_name"));
1573 SettingsPage *advisors = main->Add(
new SettingsPage(STR_CONFIG_SETTING_ADVISORS));
1575 advisors->Add(
new SettingEntry(
"gui.coloured_news_year"));
1576 advisors->Add(
new SettingEntry(
"news_display.general"));
1577 advisors->Add(
new SettingEntry(
"news_display.new_vehicles"));
1578 advisors->Add(
new SettingEntry(
"news_display.accident"));
1579 advisors->Add(
new SettingEntry(
"news_display.company_info"));
1580 advisors->Add(
new SettingEntry(
"news_display.acceptance"));
1581 advisors->Add(
new SettingEntry(
"news_display.arrival_player"));
1582 advisors->Add(
new SettingEntry(
"news_display.arrival_other"));
1583 advisors->Add(
new SettingEntry(
"news_display.advice"));
1584 advisors->Add(
new SettingEntry(
"gui.order_review_system"));
1585 advisors->Add(
new SettingEntry(
"gui.vehicle_income_warn"));
1586 advisors->Add(
new SettingEntry(
"gui.lost_vehicle_warn"));
1588 advisors->Add(
new SettingEntry(
"news_display.economy"));
1589 advisors->Add(
new SettingEntry(
"news_display.subsidies"));
1592 advisors->Add(
new SettingEntry(
"news_display.production_player"));
1593 advisors->Add(
new SettingEntry(
"news_display.production_other"));
1594 advisors->Add(
new SettingEntry(
"news_display.production_nobody"));
1597 SettingsPage *company = main->Add(
new SettingsPage(STR_CONFIG_SETTING_COMPANY));
1599 company->Add(
new SettingEntry(
"gui.semaphore_build_before"));
1600 company->Add(
new SettingEntry(
"gui.default_signal_type"));
1601 company->Add(
new SettingEntry(
"gui.cycle_signal_types"));
1602 company->Add(
new SettingEntry(
"gui.drag_signals_fixed_distance"));
1606 company->Add(
new SettingEntry(
"company.engine_renew"));
1607 company->Add(
new SettingEntry(
"company.engine_renew_months"));
1608 company->Add(
new SettingEntry(
"company.engine_renew_money"));
1609 company->Add(
new SettingEntry(
"vehicle.servint_ispercent"));
1610 company->Add(
new SettingEntry(
"vehicle.servint_trains"));
1611 company->Add(
new SettingEntry(
"vehicle.servint_roadveh"));
1612 company->Add(
new SettingEntry(
"vehicle.servint_ships"));
1613 company->Add(
new SettingEntry(
"vehicle.servint_aircraft"));
1616 SettingsPage *accounting = main->Add(
new SettingsPage(STR_CONFIG_SETTING_ACCOUNTING));
1618 accounting->Add(
new SettingEntry(
"economy.inflation"));
1619 accounting->Add(
new SettingEntry(
"difficulty.initial_interest"));
1620 accounting->Add(
new SettingEntry(
"difficulty.max_loan"));
1621 accounting->Add(
new SettingEntry(
"difficulty.subsidy_multiplier"));
1622 accounting->Add(
new SettingEntry(
"economy.feeder_payment_share"));
1623 accounting->Add(
new SettingEntry(
"economy.infrastructure_maintenance"));
1624 accounting->Add(
new SettingEntry(
"difficulty.vehicle_costs"));
1625 accounting->Add(
new SettingEntry(
"difficulty.construction_cost"));
1628 SettingsPage *vehicles = main->Add(
new SettingsPage(STR_CONFIG_SETTING_VEHICLES));
1630 SettingsPage *physics = vehicles->Add(
new SettingsPage(STR_CONFIG_SETTING_VEHICLES_PHYSICS));
1632 physics->Add(
new SettingEntry(
"vehicle.train_acceleration_model"));
1633 physics->Add(
new SettingEntry(
"vehicle.train_slope_steepness"));
1634 physics->Add(
new SettingEntry(
"vehicle.wagon_speed_limits"));
1635 physics->Add(
new SettingEntry(
"vehicle.freight_trains"));
1636 physics->Add(
new SettingEntry(
"vehicle.roadveh_acceleration_model"));
1637 physics->Add(
new SettingEntry(
"vehicle.roadveh_slope_steepness"));
1638 physics->Add(
new SettingEntry(
"vehicle.smoke_amount"));
1642 SettingsPage *routing = vehicles->Add(
new SettingsPage(STR_CONFIG_SETTING_VEHICLES_ROUTING));
1644 routing->Add(
new SettingEntry(
"pf.pathfinder_for_trains"));
1645 routing->Add(
new SettingEntry(
"difficulty.line_reverse_mode"));
1646 routing->Add(
new SettingEntry(
"pf.reverse_at_signals"));
1648 routing->Add(
new SettingEntry(
"pf.pathfinder_for_roadvehs"));
1649 routing->Add(
new SettingEntry(
"pf.pathfinder_for_ships"));
1652 vehicles->Add(
new SettingEntry(
"order.no_servicing_if_no_breakdowns"));
1653 vehicles->Add(
new SettingEntry(
"order.serviceathelipad"));
1656 SettingsPage *limitations = main->Add(
new SettingsPage(STR_CONFIG_SETTING_LIMITATIONS));
1658 limitations->Add(
new SettingEntry(
"construction.command_pause_level"));
1659 limitations->Add(
new SettingEntry(
"construction.autoslope"));
1660 limitations->Add(
new SettingEntry(
"construction.extra_dynamite"));
1661 limitations->Add(
new SettingEntry(
"construction.max_heightlevel"));
1662 limitations->Add(
new SettingEntry(
"construction.max_bridge_length"));
1663 limitations->Add(
new SettingEntry(
"construction.max_bridge_height"));
1664 limitations->Add(
new SettingEntry(
"construction.max_tunnel_length"));
1665 limitations->Add(
new SettingEntry(
"station.never_expire_airports"));
1666 limitations->Add(
new SettingEntry(
"vehicle.never_expire_vehicles"));
1667 limitations->Add(
new SettingEntry(
"vehicle.max_trains"));
1668 limitations->Add(
new SettingEntry(
"vehicle.max_roadveh"));
1669 limitations->Add(
new SettingEntry(
"vehicle.max_aircraft"));
1670 limitations->Add(
new SettingEntry(
"vehicle.max_ships"));
1671 limitations->Add(
new SettingEntry(
"vehicle.max_train_length"));
1672 limitations->Add(
new SettingEntry(
"station.station_spread"));
1673 limitations->Add(
new SettingEntry(
"station.distant_join_stations"));
1674 limitations->Add(
new SettingEntry(
"construction.road_stop_on_town_road"));
1675 limitations->Add(
new SettingEntry(
"construction.road_stop_on_competitor_road"));
1676 limitations->Add(
new SettingEntry(
"vehicle.disable_elrails"));
1679 SettingsPage *disasters = main->Add(
new SettingsPage(STR_CONFIG_SETTING_ACCIDENTS));
1681 disasters->Add(
new SettingEntry(
"difficulty.disasters"));
1682 disasters->Add(
new SettingEntry(
"difficulty.economy"));
1683 disasters->Add(
new SettingEntry(
"difficulty.vehicle_breakdowns"));
1684 disasters->Add(
new SettingEntry(
"vehicle.plane_crashes"));
1687 SettingsPage *genworld = main->Add(
new SettingsPage(STR_CONFIG_SETTING_GENWORLD));
1689 genworld->Add(
new SettingEntry(
"game_creation.landscape"));
1690 genworld->Add(
new SettingEntry(
"game_creation.land_generator"));
1691 genworld->Add(
new SettingEntry(
"difficulty.terrain_type"));
1692 genworld->Add(
new SettingEntry(
"game_creation.tgen_smoothness"));
1693 genworld->Add(
new SettingEntry(
"game_creation.variety"));
1694 genworld->Add(
new SettingEntry(
"game_creation.snow_line_height"));
1695 genworld->Add(
new SettingEntry(
"game_creation.amount_of_rivers"));
1696 genworld->Add(
new SettingEntry(
"game_creation.tree_placer"));
1698 genworld->Add(
new SettingEntry(
"economy.larger_towns"));
1699 genworld->Add(
new SettingEntry(
"economy.initial_city_size"));
1700 genworld->Add(
new SettingEntry(
"economy.town_layout"));
1701 genworld->Add(
new SettingEntry(
"difficulty.industry_density"));
1702 genworld->Add(
new SettingEntry(
"gui.pause_on_newgame"));
1703 genworld->Add(
new SettingEntry(
"game_creation.ending_year"));
1706 SettingsPage *environment = main->Add(
new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT));
1708 SettingsPage *authorities = environment->Add(
new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_AUTHORITIES));
1710 authorities->Add(
new SettingEntry(
"difficulty.town_council_tolerance"));
1712 authorities->Add(
new SettingEntry(
"economy.exclusive_rights"));
1713 authorities->Add(
new SettingEntry(
"economy.fund_roads"));
1714 authorities->Add(
new SettingEntry(
"economy.fund_buildings"));
1715 authorities->Add(
new SettingEntry(
"economy.station_noise_level"));
1718 SettingsPage *towns = environment->Add(
new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_TOWNS));
1720 towns->Add(
new SettingEntry(
"economy.town_growth_rate"));
1721 towns->Add(
new SettingEntry(
"economy.allow_town_roads"));
1722 towns->Add(
new SettingEntry(
"economy.allow_town_level_crossings"));
1724 towns->Add(
new SettingEntry(
"economy.town_cargogen_mode"));
1727 SettingsPage *industries = environment->Add(
new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_INDUSTRIES));
1729 industries->Add(
new SettingEntry(
"construction.raw_industry_construction"));
1730 industries->Add(
new SettingEntry(
"construction.industry_platform"));
1731 industries->Add(
new SettingEntry(
"economy.multiple_industry_per_town"));
1732 industries->Add(
new SettingEntry(
"game_creation.oil_refinery_limit"));
1733 industries->Add(
new SettingEntry(
"economy.smooth_economy"));
1734 industries->Add(
new SettingEntry(
"station.serve_neutral_industries"));
1737 SettingsPage *cdist = environment->Add(
new SettingsPage(STR_CONFIG_SETTING_ENVIRONMENT_CARGODIST));
1740 cdist->Add(
new SettingEntry(
"linkgraph.recalc_interval"));
1741 cdist->Add(
new SettingEntry(
"linkgraph.distribution_pax"));
1742 cdist->Add(
new SettingEntry(
"linkgraph.distribution_mail"));
1743 cdist->Add(
new SettingEntry(
"linkgraph.distribution_armoured"));
1744 cdist->Add(
new SettingEntry(
"linkgraph.distribution_default"));
1746 cdist->Add(
new SettingEntry(
"linkgraph.demand_distance"));
1748 cdist->Add(
new SettingEntry(
"linkgraph.short_path_saturation"));
1751 environment->Add(
new SettingEntry(
"station.modified_catchment"));
1752 environment->Add(
new SettingEntry(
"construction.extra_tree_placement"));
1755 SettingsPage *ai = main->Add(
new SettingsPage(STR_CONFIG_SETTING_AI));
1757 SettingsPage *npc = ai->Add(
new SettingsPage(STR_CONFIG_SETTING_AI_NPC));
1760 npc->Add(
new SettingEntry(
"script.script_max_opcode_till_suspend"));
1761 npc->Add(
new SettingEntry(
"script.script_max_memory_megabytes"));
1762 npc->Add(
new SettingEntry(
"difficulty.competitor_speed"));
1765 npc->Add(
new SettingEntry(
"ai.ai_disable_veh_roadveh"));
1766 npc->Add(
new SettingEntry(
"ai.ai_disable_veh_aircraft"));
1772 ai->Add(
new SettingEntry(
"economy.min_years_for_shares"));
1780 static const StringID _game_settings_restrict_dropdown[] = {
1781 STR_CONFIG_SETTING_RESTRICT_BASIC,
1782 STR_CONFIG_SETTING_RESTRICT_ADVANCED,
1783 STR_CONFIG_SETTING_RESTRICT_ALL,
1784 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_DEFAULT,
1785 STR_CONFIG_SETTING_RESTRICT_CHANGED_AGAINST_NEW,
1787 assert_compile(
lengthof(_game_settings_restrict_dropdown) ==
RM_END);
1799 static const int SETTINGTREE_LEFT_OFFSET = 5;
1800 static const int SETTINGTREE_RIGHT_OFFSET = 5;
1801 static const int SETTINGTREE_TOP_OFFSET = 5;
1802 static const int SETTINGTREE_BOTTOM_OFFSET = 5;
1823 this->warn_lines = 0;
1825 this->filter.min_cat =
RM_ALL;
1826 this->filter.type =
ST_ALL;
1827 this->filter.type_hides =
false;
1833 this->valuewindow_entry =
nullptr;
1834 this->clicked_entry =
nullptr;
1835 this->last_clicked =
nullptr;
1836 this->valuedropdown_entry =
nullptr;
1837 this->closing_dropdown =
false;
1838 this->manually_changed_folding =
false;
1858 size->height = 5 * resize->height + SETTINGTREE_TOP_OFFSET + SETTINGTREE_BOTTOM_OFFSET;
1862 static const StringID setting_types[] = {
1863 STR_CONFIG_SETTING_TYPE_CLIENT,
1864 STR_CONFIG_SETTING_TYPE_COMPANY_MENU, STR_CONFIG_SETTING_TYPE_COMPANY_INGAME,
1865 STR_CONFIG_SETTING_TYPE_GAME_MENU, STR_CONFIG_SETTING_TYPE_GAME_INGAME,
1867 for (uint i = 0; i <
lengthof(setting_types); i++) {
1888 if (this->closing_dropdown) {
1889 this->closing_dropdown =
false;
1890 assert(this->valuedropdown_entry !=
nullptr);
1892 this->valuedropdown_entry =
nullptr;
1897 StringID warn_str = STR_CONFIG_SETTING_CATEGORY_HIDES - 1 + this->warn_missing;
1899 if (this->warn_missing ==
WHR_NONE) {
1905 if (this->warn_lines != new_warn_lines) {
1906 this->vscroll->
SetCount(this->vscroll->
GetCount() - this->warn_lines + new_warn_lines);
1907 this->warn_lines = new_warn_lines;
1913 if (this->warn_missing !=
WHR_NONE) {
1915 const int right = left + panel->
current_x - 1;
1918 if (this->warn_lines == 1) {
1931 SetDParam(0, _game_settings_restrict_dropdown[this->filter.
mode]);
1935 switch (this->filter.
type) {
1936 case ST_GAME:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_GAME_INGAME);
break;
1937 case ST_COMPANY:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_DROPDOWN_COMPANY_INGAME);
break;
1939 default:
SetDParam(0, STR_CONFIG_SETTING_TYPE_DROPDOWN_ALL);
break;
1950 for (
int mode = 0; mode !=
RM_END; mode++) {
1961 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));
1962 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));
1973 int top_pos = r.top + SETTINGTREE_TOP_OFFSET + 1 + this->warn_lines *
SETTING_HEIGHT;
1975 int next_row =
GetSettingsTree().
Draw(settings_ptr, r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos,
1976 this->vscroll->GetPosition(), last_row, this->last_clicked);
1977 if (next_row == 0)
DrawString(r.left + SETTINGTREE_LEFT_OFFSET, r.right - SETTINGTREE_RIGHT_OFFSET, top_pos, STR_CONFIG_SETTINGS_NONE);
1982 if (this->last_clicked !=
nullptr) {
1987 case ST_COMPANY:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_COMPANY_MENU : STR_CONFIG_SETTING_TYPE_COMPANY_INGAME);
break;
1989 case ST_GAME:
SetDParam(0, _game_mode == GM_MENU ? STR_CONFIG_SETTING_TYPE_GAME_MENU : STR_CONFIG_SETTING_TYPE_GAME_INGAME);
break;
1990 default: NOT_REACHED();
1992 DrawString(r.left, r.right, y, STR_CONFIG_SETTING_TYPE);
1997 DrawString(r.left, r.right, y, STR_CONFIG_SETTING_DEFAULT_VALUE);
2000 DrawStringMultiLine(r.left, r.right, y, r.bottom, this->last_clicked->GetHelpText(), TC_WHITE);
2015 if (this->last_clicked != pe) this->
SetDirty();
2016 this->last_clicked = pe;
2023 this->manually_changed_folding =
true;
2029 this->manually_changed_folding =
true;
2036 if (!list.empty()) {
2044 if (!list.empty()) {
2054 if (btn == INT_MAX || (
int)btn < this->warn_lines)
return;
2055 btn -= this->warn_lines;
2060 if (clicked_entry ==
nullptr)
return;
2066 if (clicked_page !=
nullptr) {
2067 this->SetDisplayedHelpText(
nullptr);
2070 this->manually_changed_folding =
true;
2077 assert(pe !=
nullptr);
2082 this->SetDisplayedHelpText(pe);
2086 const void *var = ResolveVariableAddress(settings_ptr, sd);
2092 this->SetDisplayedHelpText(pe);
2094 if (this->valuedropdown_entry == pe) {
2097 this->closing_dropdown =
false;
2099 this->valuedropdown_entry =
nullptr;
2101 if (this->valuedropdown_entry !=
nullptr) this->valuedropdown_entry->
SetButtons(0);
2102 this->closing_dropdown =
false;
2105 int rel_y = (pt.y - (int)wid->
pos_y - SETTINGTREE_TOP_OFFSET) % wid->
resize_y;
2114 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
2115 this->valuedropdown_entry = pe;
2119 for (
int i = sdb->
min; i <= (
int)sdb->
max; i++) {
2128 this->SetDisplayedHelpText(pe);
2130 int32 oldvalue = value;
2141 if (step == 0) step = 1;
2153 assert((int32)sdb->
max >= 0);
2154 if (value > (int32)sdb->
max) value = (int32)sdb->
max;
2156 if ((uint32)value > sdb->
max) value = (int32)sdb->
max;
2158 if (value < sdb->
min) value = sdb->
min;
2165 if (value != oldvalue) {
2166 if (this->clicked_entry !=
nullptr) {
2167 this->clicked_entry->SetButtons(0);
2169 this->clicked_entry = pe;
2177 default: NOT_REACHED();
2180 if (value != oldvalue) {
2194 this->valuewindow_entry = pe;
2198 this->SetDisplayedHelpText(pe);
2204 if (this->clicked_entry !=
nullptr) {
2206 this->clicked_entry =
nullptr;
2214 if (str ==
nullptr)
return;
2216 assert(this->valuewindow_entry !=
nullptr);
2226 value = (int32)(
size_t)sd->
desc.
def;
2245 if (!this->manually_changed_folding) {
2265 assert(this->valuedropdown_entry !=
nullptr);
2294 assert(this->valuedropdown_entry !=
nullptr);
2295 this->closing_dropdown =
true;
2302 if (!gui_scope)
return;
2306 this->filter.min_cat = min_level;
2307 this->filter.type_hides =
false;
2312 }
else if (min_level < this->filter.
min_cat) {
2319 if (this->last_clicked !=
nullptr && !
GetSettingsTree().IsVisible(this->last_clicked)) {
2320 this->SetDisplayedHelpText(
nullptr);
2323 bool all_folded =
true;
2324 bool all_unfolded =
true;
2334 if (!this->filter.
string.
IsEmpty() && !this->manually_changed_folding) {
2351 static const NWidgetPart _nested_settings_selection_widgets[] = {
2361 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),
2365 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),
2372 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
2396 _nested_settings_selection_widgets,
lengthof(_nested_settings_selection_widgets)
2416 void DrawArrowButtons(
int x,
int y, Colours button_colour, byte state,
bool clickable_left,
bool clickable_right)
2419 Dimension dim = NWidgetScrollbar::GetHorizontalDimension();
2421 DrawFrameRect(x, y, x + dim.width - 1, y + dim.height - 1, button_colour, (state == 1) ?
FR_LOWERED : FR_NONE);
2422 DrawFrameRect(x + dim.width, y, x + dim.width + dim.width - 1, y + dim.height - 1, button_colour, (state == 2) ?
FR_LOWERED : FR_NONE);
2428 if (rtl ? !clickable_right : !clickable_left) {
2431 if (rtl ? !clickable_left : !clickable_right) {
2465 static const Colours _bool_ctabs[2][2] = {{COLOUR_CREAM, COLOUR_RED}, {COLOUR_DARK_GREEN, COLOUR_GREEN}};
2479 void SetButtonState()
2495 SetDParam(0, (_custom_currency.to_euro !=
CF_NOEURO) ? STR_CURRENCY_SWITCH_TO_EURO : STR_CURRENCY_SWITCH_TO_EURO_NEVER);
2533 if (_custom_currency.rate > 1) _custom_currency.rate--;
2539 if (_custom_currency.rate < UINT16_MAX) _custom_currency.rate++;
2555 str = STR_JUST_RAW_STRING;
2563 str = STR_JUST_RAW_STRING;
2571 str = STR_JUST_RAW_STRING;
2577 _custom_currency.to_euro = (_custom_currency.to_euro <= 2000) ?
CF_NOEURO : _custom_currency.to_euro - 1;
2583 _custom_currency.to_euro =
Clamp(_custom_currency.to_euro + 1, 2000,
MAX_YEAR);
2598 this->query_widget = line;
2599 ShowQueryString(str, STR_CURRENCY_CHANGE_PARAMETER, len + 1,
this, afilter, QSF_NONE);
2608 if (str ==
nullptr)
return;
2610 switch (this->query_widget) {
2612 _custom_currency.rate =
Clamp(atoi(str), 1, UINT16_MAX);
2616 strecpy(_custom_currency.separator, str,
lastof(_custom_currency.separator));
2620 strecpy(_custom_currency.prefix, str,
lastof(_custom_currency.prefix));
2624 strecpy(_custom_currency.suffix, str,
lastof(_custom_currency.suffix));
2628 int val = atoi(str);
2644 static const NWidgetPart _nested_cust_currency_widgets[] = {
2680 SetDataTip(STR_CURRENCY_PREVIEW, STR_CURRENCY_CUSTOM_CURRENCY_PREVIEW_TOOLTIP),
SetPadding(15, 1, 18, 2),
2688 _nested_cust_currency_widgets,
lengthof(_nested_cust_currency_widgets)
RestrictionMode mode
Filter based on category.
Functions related to OTTD's strings.
VehicleSettings vehicle
options for vehicles
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition of stuff that is very close to a company, like the company struct itself.
void CheckForMissingGlyphs(bool base_font, MissingGlyphSearcher *searcher)
Check whether the currently loaded language pack uses characters that the currently loaded font does ...
bool _networking
are we in networking mode?
const void * def
default value given when none is present
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
bool IsFiltered() const
Check whether an entry is hidden due to filters.
Horizontally center the text.
ResizeInfo resize
Resize information.
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
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 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...
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
void OnEditboxChanged(int wid) override
The text in an editbox has been edited.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
int warn_lines
Number of lines used for warning about missing search results.
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help texts, if the width is at least maxw.
void SetTimeout()
Set the timeout flag of the window and initiate the timer.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
High level window description.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
WindowFlags flags
Window flags.
int left
x position of left edge of the window
bitmasked number where only ONE bit may be set
All settings together for the game.
void DrawWidgets() const
Paint all widgets of a window.
void ChangeMusicSet(int index)
Change the configured music set and reset playback.
static Titem * Get(size_t index)
Returns Titem with given index.
Switch to game intro menu.
virtual void UnFoldAll()
Recursively open all (filtered) folds of sub-pages.
SettingsPage(StringID title)
Constructor for a sub-page in the 'advanced settings' window.
CurrencySpec _currency_specs[CURRENCY_END]
Array of currencies used by the system.
Functions to handle different currencies.
virtual void Init(byte level=0)
Initialization of a setting entry.
int GetNumInvalid() const
Get the number of invalid files.
Data structure describing a single setting in a tab.
Of a numeric setting entry, the right button is depressed.
Normal amount of vertical space between two paragraphs of text.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
textfile; Window numbers:
void ResetState()
Reset the matching state to process a new item.
void UnFoldAll()
Recursively open all folds of sub-pages.
void SetMediaSet(int index)
Set the base media set.
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
SettingGuiFlag flags
handles how a setting would show up in the GUI (text/currency, etc.)
bool GetState() const
Get the matching state of the current item.
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
fluid_settings_t * settings
FluidSynth settings handle.
Show only settings which are different compared to the user's new game setting values.
#define SETBITS(x, y)
Sets several bits in a variable.
const LanguageMetadata * _current_language
The currently loaded language.
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 closing_dropdown
True, if the dropdown list is currently closing.
static Dimension _circle_size
Dimension of the circle +/- icon. This is here as not all users are within the class of the settings ...
static const int ACTION_CLEAR
Clear editbox.
static uint GetCurRes()
Get index of the current screen resolution.
Filter for settings list.
int top
y position of top edge of the window
Header of Action 0F "universal holder" structure and functions.
Type setting filtered matches away.
int64 ReadValue(const void *ptr, VarType conv)
Return a signed-long version of the value of a setting.
the value represents a limited number of string-options (internally integer)
WarnHiddenResult
Warnings about hidden search results.
void SetButtons(byte new_val)
Set the button-depressed flags (SEF_LEFT_DEPRESSED and SEF_RIGHT_DEPRESSED) to a specified value...
WarnHiddenResult warn_missing
Whether and how to warn about missing search results.
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.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
LanguageList _languages
The actual list of language meta data.
Window to edit settings of the game.
Properties of config file settings.
uint Length() const
Return number of rows needed to display the whole page.
Settings displayed in the list of basic settings.
void SetLastField(bool last_field)
Set whether this is the last visible entry of the parent node.
#define lastof(x)
Get the last element of an fixed size array.
Settings displayed in the list of advanced settings.
Show only settings which are different compared to default values.
Stuff related to the text buffer GUI.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
const SettingDesc * setting
Setting description of the setting.
void DisableWidget(byte widget_index)
Sets a widget to disabled.
#define CLRBITS(x, y)
Clears several bits in a variable.
Subdirectory for all base data (base sets, intro game)
static T max(const T a, const T b)
Returns the maximum of two values.
static StringID TownName(int town_name)
Get a town name.
virtual uint GetMaxHelpHeight(int maxw)
Get the biggest height of the help text(s), if the width is at least maxw.
int GetNumMissing() const
Get the number of missing files.
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
this setting can be different for each company (saved in company struct)
virtual void Init(byte level=0)
Initialization of an entire setting page.
int HideDropDownMenu(Window *pw)
Delete the drop-down menu from window pw.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
static const int LEVEL_WIDTH
Indenting width of a sub-page in pixels.
void OnTimeout() override
Called when this window's timeout has been reached.
bool _left_button_clicked
Is left mouse button clicked?
std::vector< Dimension > _resolutions
List of resolutions.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, int button, uint width, bool auto_width, bool instant_close)
Show a drop down list.
Functions related to (drawing on) viewports.
Base for the GUIs that have an edit box in them.
Data structure for an opened window.
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
void SetFilterTerm(const char *str)
Set the term to filter on.
Functions to read fonts from files and cache them.
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.
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
SettingEntry * last_clicked
If non-nullptr, pointer to the last clicked setting.
Bottom offset of the text of the frame.
SaveLoad save
Internal structure (going to savegame, parts to config)
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
enable the 'Default' button ("\0" is returned)
bool ReadLanguagePack(const LanguageMetadata *lang)
Read a particular language.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Functions related to low-level strings.
bool type_hides
Whether the type hides filtered strings.
bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
VarType conv
type of the variable to be saved, int
Functions related to errors.
Used in setting filter to match all types.
Of a numeric setting entry, the left button is depressed.
bool manually_changed_folding
Whether the user expanded/collapsed something manually.
CompanySettings company
default values for per-company settings
static GameSettings * settings_ptr
Pointer to the game settings being displayed and modified.
StringID str_help
(Translated) string with help text; gui only.
int main(int argc, char *argv[])
Entry point.
SettingEntry(const char *name)
Constructor for a single setting in the 'advanced settings' window.
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
byte road_side
the side of the road vehicles drive on
void SetDisplayedHelpText(SettingEntry *pe)
Set the entry that should have its help text displayed, and mark the window dirty so it gets repainte...
SmallMap< int, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
const char * name
Name of the setting.
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
Data stored about a string that can be modified in the GUI.
ClientSettings _settings_client
The current settings for this game.
static bool NatSortFunc(std::unique_ptr< const DropDownListItem > const &first, std::unique_ptr< const DropDownListItem > const &second)
Natural sorting comparator function for DropDownList::sort().
Definition of base types and functions in a cross-platform compatible way.
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
static const int CF_NOEURO
Currency never switches to the Euro (as far as known).
void OnDropdownClose(Point pt, int widget, int index, bool instant_close) override
A dropdown window associated to this window has been closed.
A number of safeguards to prevent using unsafe methods.
static int SETTING_HEIGHT
Height of a single setting in the tree view in pixels.
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
byte level
Nesting level of this setting entry.
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.
StringID GetHelpText() const
Get the help text of a single setting.
Display settings associated to the "basic" list.
bool IsVisibleByRestrictionMode(RestrictionMode mode) const
Checks whether an entry shall be made visible based on the restriction mode.
Offset at bottom to draw below the text.
Custom currency; Window numbers:
const SettingDesc * GetSettingFromName(const char *name, uint *i)
Given a name of setting, return a setting description of it.
StringID title
Title of the sub-page.
StringID * BuildCurrencyDropdown()
Build a list of currency names StringIDs to use in a dropdown list.
Information about languages and their files.
SettingFilter filter
Filter for the list.
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Window for displaying the textfile of a BaseSet.
Display settings associated to the "advanced" list.
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
void OnQueryTextFinished(char *str) override
The query window opened from this window has closed.
void Init(byte level=0)
Initialization of an entire setting page.
virtual void LoadTextfile(const char *textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
SettingType type
Filter based on type.
Containers for BaseSettingEntry.
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
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.
Entry is hidden by the string filter.
Basic functions/variables used all over the place.
void SetValueDParams(uint first_param, int32 value) const
Set the DParams for drawing the value of a setting.
uint index
Index of the setting in the settings table.
RestrictionMode
How the list of advanced settings is filtered.
SettingEntryFlags
Flags for SettingEntry.
Right offset of the text of the frame.
#define lengthof(x)
Return the length of an fixed size array.
bool RoadVehiclesAreBuilt()
Verify whether a road vehicle is available.
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information...
TextfileType
Additional text files accompanying Tar archives.
static T min(const T a, const T b)
Returns the minimum of two values.
bool folded
Sub-page is folded (not visible except for its title)
static StringID * _grf_names
Pointer to town names defined by NewGRFs.
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Top offset of the text of the frame.
StringFilter string
Filter string.
Left offset of the text of the frame.
Types related to the drop down widget.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
void DrawArrowButtons(int x, int y, Colours button_colour, byte state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
void OnPaint() override
The window must be repainted.
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
virtual uint Length() const
Return number of rows needed to display the (filtered) entry.
Data structure describing one page of settings in the settings window.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
CharSetFilter
Valid filter types for IsValidChar.
This entry is the last one in a (sub-)page.
void SetCompanySetting(uint index, int32 value)
Top function to save the new value of an element of the Settings struct.
the number represents money, so when reading value multiply by exchange rate
Offset at top to draw above the text.
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
virtual void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the (filtered) tree.
bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
RestrictionMode min_cat
Minimum category needed to display all filtered strings (RM_BASIC, RM_ADVANCED, or RM_ALL)...
void FoldAll()
Recursively close all folds of sub-pages.
virtual void FoldAll()
Recursively close all (filtered) folds of sub-pages.
uint8 settings_restriction_mode
selected restriction mode in adv. settings GUI.
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
SettingEntry * valuedropdown_entry
If non-nullptr, pointer to the value for which a dropdown window is currently opened.
void AddLine(const char *str)
Pass another text line from the current item to the filter.
const TBaseSet * baseset
View the textfile of this BaseSet.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Draw only every second pixel, used for greying-out.
No window, redirects to WC_MAIN_WINDOW.
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
bool IsEditable(bool do_command=false) const
Check whether the setting is editable in the current gamemode.
void InitGRFTownGeneratorNames()
Allocate memory for the NewGRF town names.
EntryVector entries
Settings on this page.
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.
static void * GetVariableAddress(const void *object, const SaveLoad *sld)
Get the address of the variable.
StringID str_val
(Translated) first string describing the value.
Functions related to companies.
char *const buf
buffer in which text is saved
const char * GetCurrentLanguageIsoCode()
Get the ISO language code of the currently loaded language.
void ReInitAllWindows()
Re-initialize all windows.
Both numeric and alphabetic and spaces and stuff.
Category setting filtered matches away.
Declaration of functions and types defined in highscore.h and highscore_gui.h.
GUISettings gui
settings related to the GUI
Bit-mask for button flags.
void ShowBaseSetTextfileWindow(TextfileType file_type, const TBaseSet *baseset, StringID content_type)
Open the BaseSet version of the textfile window.
Window for displaying a textfile.
If set the frame is lowered and the background colour brighter (ie. buttons when pressed) ...
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
void UpdateCursorSize()
Update cursor dimension.
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
static size_t GetNumItems()
Returns number of valid items in the pool.
a value of zero means the feature is disabled
TextDirection _current_text_dir
Text direction of the currently selected language.
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.
static GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
Searching and filtering using a stringterm.
TextfileType file_type
Type of textfile to view.
Top offset of image in the button.
bool SetSettingValue(uint index, int32 value, bool force_newgame)
Top function to save the new value of an element of the Settings struct.
void ShowGameOptions()
Open the game options window.
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Functions for setting GUIs.
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.
Functions related to zooming.
Scrollbar * vscroll
Vertical scrollbar.
Functions and types used internally for the settings configurations.
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
ZoomLevel _font_zoom
Font Zoom level.
bool SetFocusedWidget(int widget_index)
Set focus within this window to the given widget.
Functions related to the drop down widget.
ZoomLevel _gui_zoom
GUI Zoom level.
SwitchMode _switch_mode
The next mainloop command.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
void OnTimeout() override
Called when this window's timeout has been reached.
display absolute value of the setting
SettingType GetType() const
Return the type of the setting.
SettingDescType cmd
various flags for the variable
LocaleSettings locale
settings related to used currency/unit system in the current game
virtual void Init(byte level=0)
Initialization of a setting entry.
static SettingsContainer & GetSettingsTree()
Construct settings tree.
void ShowGameSettings()
Open advanced settings window.
byte town_name
the town name generator used for town names
GRFTextWrapper * name
NOSAVE: GRF name (Action 0x08)
virtual BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find setting entry at row row_num.
static int _nb_grf_names
Number of town names defined by NewGRFs.
Functions related to commands.
bool _network_server
network-server is active
Coordinates of a point in 2D.
byte flags
Flags of the setting entry.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
List item containing a C char string.
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
virtual void DrawSetting(GameSettings *settings_ptr, int left, int right, int y, bool highlight) const
Function to draw setting value (button + text + current value)
SettingEntry * clicked_entry
If non-nullptr, pointer to a clicked numeric setting (with a depressed left or right button)...
StringID str
(translated) string with descriptive text; gui and console
StringID content_type
STR_CONTENT_TYPE_xxx for title.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
DropDownList BuildDropDownList(int widget, int *selected_index) const
Build the dropdown list for a specific widget.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
uint64 GetMaskOfAllowedCurrencies()
get a mask of the allowed currencies depending on the year
Offset at right to draw the frame rectangular area.
int width
width of the window (number of pixels to the right in x direction)
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Base functions for all AIs.
ZoomLevel
All zoom levels we know.
static void ShowCustCurrency()
Open custom currency window.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
GameCreationSettings game_creation
settings used during the creation of a game (map)
QueryString filter_editbox
Filter editbox;.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
Specification of a rectangle with absolute coordinates of all edges.
int _nb_orig_names
Number of original town names.
Both category and type settings filtered matches away.
Text is written right-to-left by default.
SettingEntry * valuewindow_entry
If non-nullptr, pointer to setting for which a value-entering window has been opened.
Window functions not directly related to making/drawing windows.
SettingType
Type of settings for filtering.
const char * GetTextfile(TextfileType type, Subdirectory dir, const char *filename)
Search a textfile file next to the given content.
virtual void OnDropdownClose(Point pt, int widget, int index, bool instant_close)
A dropdown window associated to this window has been closed.
Nothing was filtering matches away.
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
ZoomLevel zoom_min
minimum zoom out level
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
uint8 timeout_timer
Timer value of the WF_TIMEOUT for flags.
Errors (eg. saving/loading failed)
void GetFoldingState(bool &all_folded, bool &all_unfolded) const
Recursively accumulate the folding state of the tree.
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
BaseSettingEntry * FindEntry(uint row, uint *cur_row)
Find the setting entry at row number row_num.
void OnResize() override
Called after the window got resized.
Left offset of the image in the button.
int32 interval
the interval to use between settings in the 'settings' window. If interval is '0' the interval is dyn...
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Base list item class from which others are derived.
byte autosave
how often should we do autosaves?
SettingDescBase desc
Settings structure (going to configuration file)
Dimensions (a width and height) of a rectangle in 2D.
Query string window; Window numbers:
bool IsEmpty() const
Check whether any filter words were entered.
Offset at left to draw the frame rectangular area.
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...
Factory to 'query' all available blitters.
Game options window; Window numbers:
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
virtual bool IsVisible(const BaseSettingEntry *item) const
Check whether an entry is visible and not folded or filtered away.
int height
Height of the window (number of pixels down in y direction)
virtual bool UpdateFilterState(SettingFilter &filter, bool force_visible)
Update the filter state.
void EnableWidget(byte widget_index)
Sets a widget to Enabled.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
GUI functions related to textfiles.
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.
virtual void OnInvalidateData(int data=0, bool gui_scope=true)
Some data on this window has become invalid.
List all settings regardless of the default/newgame/... values.
byte currency
currency we currently use
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.