OpenTTD Source 20260311-master-g511d3794ce
settings_table.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "settings_table.h"
12#include "currency.h"
13#include "screenshot.h"
14#include "network/network.h"
16#include "network/core/config.h"
19#include "genworld.h"
20#include "train.h"
21#include "news_func.h"
22#include "window_func.h"
23#include "company_func.h"
25#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
26#define HAS_TRUETYPE_FONT
27#include "fontcache.h"
28#endif
29#include "textbuf_gui.h"
30#include "rail_gui.h"
31#include "elrail_func.h"
32#include "error.h"
33#include "town.h"
37#include "blitter/factory.hpp"
38#include "base_media_base.h"
39#include "base_media_music.h"
40#include "base_media_sounds.h"
41#include "ai/ai_config.hpp"
42#include "ai/ai.hpp"
43#include "game/game_config.hpp"
44#include "ship.h"
45#include "smallmap_gui.h"
46#include "roadveh.h"
47#include "roadveh_cmd.h"
48#include "vehicle_func.h"
49#include "viewport_func.h"
50#include "void_map.h"
51#include "station_func.h"
52#include "station_base.h"
53
54#include "table/strings.h"
55#include "table/settings.h"
56
57#include "safeguards.h"
58
59SettingTable _company_settings{ _company_settings_table };
60SettingTable _currency_settings{ _currency_settings_table };
61SettingTable _difficulty_settings{ _difficulty_settings_table };
62SettingTable _multimedia_settings{ _multimedia_settings_table };
63SettingTable _economy_settings{ _economy_settings_table };
64SettingTable _game_settings{ _game_settings_table };
65SettingTable _gui_settings{ _gui_settings_table };
66SettingTable _linkgraph_settings{ _linkgraph_settings_table };
67SettingTable _locale_settings{ _locale_settings_table };
68SettingTable _misc_settings{ _misc_settings_table };
69SettingTable _network_private_settings{ _network_private_settings_table };
70SettingTable _network_secrets_settings{ _network_secrets_settings_table };
71SettingTable _network_settings{ _network_settings_table };
72SettingTable _news_display_settings{ _news_display_settings_table };
73SettingTable _old_gameopt_settings{ _old_gameopt_settings_table };
74SettingTable _pathfinding_settings{ _pathfinding_settings_table };
75SettingTable _script_settings{ _script_settings_table };
76SettingTable _window_settings{ _window_settings_table };
77SettingTable _world_settings{ _world_settings_table };
78#if defined(_WIN32) && !defined(DEDICATED)
79SettingTable _win32_settings{ _win32_settings_table };
80#endif /* _WIN32 */
81
82
83/* Begin - Callback Functions for the various settings. */
84
87{
88 return TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU) ? sd.str + 1 : sd.str;
89}
90
93{
94 return TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU) ? sd.str_help + 1 : sd.str_help;
95}
96
98static std::pair<StringParameter, StringParameter> SettingsValueVelocityUnit([[maybe_unused]] const IntSettingDesc &sd, int32_t value)
99{
100 StringID val;
101 switch (value) {
102 case 0: val = STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_IMPERIAL; break;
103 case 1: val = STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_METRIC; break;
104 case 2: val = STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_SI; break;
105 case 3: val = TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU) ? STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_GAMEUNITS_SECS : STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_GAMEUNITS_DAYS; break;
106 case 4: val = STR_CONFIG_SETTING_LOCALISATION_UNITS_VELOCITY_KNOTS; break;
107 default: NOT_REACHED();
108 }
109 return {val, {}};
110}
111
113static std::pair<StringParameter, StringParameter> SettingsValueAbsolute(const IntSettingDesc &sd, int32_t value)
114{
115 return {sd.str_val + ((value >= 0) ? 1 : 0), abs(value)};
116}
117
119static std::pair<StringParameter, StringParameter> ServiceIntervalSettingsValueText(const IntSettingDesc &sd, int32_t value)
120{
122 if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
123 vds = &_settings_client.company.vehicle;
124 } else {
125 vds = &Company::Get(_current_company)->settings.vehicle;
126 }
127
128 StringID str;
129 if (value == 0) {
130 str = sd.str_val + 3;
131 } else if (vds->servint_ispercent) {
132 str = sd.str_val + 2;
133 } else if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) {
134 str = sd.str_val + 1;
135 } else {
136 str = sd.str_val;
137 }
138 return {str, value};
139}
140
142static void v_PositionMainToolbar(int32_t)
143{
144 if (_game_mode != GM_MENU) PositionMainToolbar(nullptr);
145}
146
148static void v_PositionStatusbar(int32_t)
149{
150 if (_game_mode != GM_MENU) {
151 PositionStatusbar(nullptr);
152 PositionNewsMessage(nullptr);
154 }
155}
156
160static void RedrawSmallmap(int32_t)
161{
165}
166
168static void UpdateLinkgraphColours(int32_t)
169{
172}
173
174static void StationSpreadChanged(int32_t)
175{
178}
179
180static void UpdateConsists(int32_t)
181{
182 for (Train *t : Train::Iterate()) {
183 /* Update the consist of all trains so the maximum speed is set correctly. */
184 if (t->IsFrontEngine() || t->IsFreeWagon()) t->ConsistChanged(CCF_TRACK);
185 }
187}
188
193static void UpdateAllServiceInterval(int32_t new_value)
194{
195 bool update_vehicles;
197 if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
198 vds = &_settings_client.company.vehicle;
199 update_vehicles = false;
200 } else {
201 vds = &Company::Get(_current_company)->settings.vehicle;
202 update_vehicles = true;
203 }
204
205 if (new_value != 0) {
206 /* Service intervals are in percents. */
207 vds->servint_trains = DEF_SERVINT_PERCENT;
208 vds->servint_roadveh = DEF_SERVINT_PERCENT;
209 vds->servint_aircraft = DEF_SERVINT_PERCENT;
210 vds->servint_ships = DEF_SERVINT_PERCENT;
211 } else if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) {
212 /* Service intervals are in minutes. */
213 vds->servint_trains = DEF_SERVINT_MINUTES_TRAINS;
214 vds->servint_roadveh = DEF_SERVINT_MINUTES_ROADVEH;
215 vds->servint_aircraft = DEF_SERVINT_MINUTES_AIRCRAFT;
216 vds->servint_ships = DEF_SERVINT_MINUTES_SHIPS;
217 } else {
218 /* Service intervals are in days. */
219 vds->servint_trains = DEF_SERVINT_DAYS_TRAINS;
220 vds->servint_roadveh = DEF_SERVINT_DAYS_ROADVEH;
221 vds->servint_aircraft = DEF_SERVINT_DAYS_AIRCRAFT;
222 vds->servint_ships = DEF_SERVINT_DAYS_SHIPS;
223 }
224
225 if (update_vehicles) {
227 for (Vehicle *v : Vehicle::Iterate()) {
228 if (v->owner == _current_company && v->IsPrimaryVehicle() && !v->ServiceIntervalIsCustom()) {
229 v->SetServiceInterval(CompanyServiceInterval(c, v->type));
230 v->SetServiceIntervalIsPercent(new_value != 0);
231 }
232 }
233 }
234
236}
237
238static bool CanUpdateServiceInterval(VehicleType, int32_t &new_value)
239{
241 if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
242 vds = &_settings_client.company.vehicle;
243 } else {
244 vds = &Company::Get(_current_company)->settings.vehicle;
245 }
246
247 /* Test if the interval is valid */
248 int32_t interval = GetServiceIntervalClamped(new_value, vds->servint_ispercent);
249 return new_value == 0 || interval == new_value;
250}
251
252static void UpdateServiceInterval(VehicleType type, int32_t new_value)
253{
254 if (_game_mode != GM_MENU && Company::IsValidID(_current_company)) {
255 for (Vehicle *v : Vehicle::Iterate()) {
256 if (v->owner == _current_company && v->type == type && v->IsPrimaryVehicle() && !v->ServiceIntervalIsCustom()) {
257 v->SetServiceInterval(new_value);
258 }
259 }
260 }
261
263}
264
272{
274 if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
275 vds = &_settings_client.company.vehicle;
276 } else {
277 vds = &Company::Get(_current_company)->settings.vehicle;
278 }
279
280 if (vds->servint_ispercent) return DEF_SERVINT_PERCENT;
281
282 if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) {
283 switch (type) {
284 case VEH_TRAIN: return DEF_SERVINT_MINUTES_TRAINS;
285 case VEH_ROAD: return DEF_SERVINT_MINUTES_ROADVEH;
286 case VEH_AIRCRAFT: return DEF_SERVINT_MINUTES_AIRCRAFT;
287 case VEH_SHIP: return DEF_SERVINT_MINUTES_SHIPS;
288 default: NOT_REACHED();
289 }
290 }
291
292 return sd.def;
293}
294
295static std::tuple<int32_t, uint32_t> GetServiceIntervalRange(const IntSettingDesc &)
296{
298 if (_game_mode == GM_MENU || !Company::IsValidID(_current_company)) {
299 vds = &_settings_client.company.vehicle;
300 } else {
301 vds = &Company::Get(_current_company)->settings.vehicle;
302 }
303
304 if (vds->servint_ispercent) return { MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT };
305
306 if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) {
307 return { MIN_SERVINT_MINUTES, MAX_SERVINT_MINUTES };
308 }
309
310 return { MIN_SERVINT_DAYS, MAX_SERVINT_DAYS };
311}
312
313static void TrainAccelerationModelChanged(int32_t)
314{
315 for (Train *t : Train::Iterate()) {
316 if (t->IsFrontEngine()) {
317 t->tcache.cached_max_curve_speed = t->GetCurveSpeedLimit();
318 t->UpdateAcceleration();
319 }
320 }
321
322 /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
326}
327
331static void TrainSlopeSteepnessChanged(int32_t)
332{
333 for (Train *t : Train::Iterate()) {
334 if (t->IsFrontEngine()) t->CargoChanged();
335 }
336}
337
342{
343 if (_settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL) {
344 for (RoadVehicle *rv : RoadVehicle::Iterate()) {
345 if (rv->IsFrontEngine()) {
346 rv->CargoChanged();
347 }
348 }
349 }
350
351 /* These windows show acceleration values only when realistic acceleration is on. They must be redrawn after a setting change. */
355}
356
361{
362 for (RoadVehicle *rv : RoadVehicle::Iterate()) {
363 if (rv->IsFrontEngine()) rv->CargoChanged();
364 }
365}
366
367static void TownFoundingChanged(int32_t)
368{
369 if (_game_mode != GM_EDITOR && _settings_game.economy.found_town == TF_FORBIDDEN) {
371 } else {
373 }
374}
375
376static void ZoomMinMaxChanged(int32_t)
377{
378 ConstrainAllViewportsZoom();
381 if (AdjustGUIZoom(false)) {
382 ReInitAllWindows(true);
383 }
384}
385
386static void SpriteZoomMinChanged(int32_t)
387{
389 /* Force all sprites to redraw at the new chosen zoom level */
391}
392
404
405static void InvalidateCompanyLiveryWindow(int32_t)
406{
408 ResetVehicleColourMap();
409}
410
411static void DifficultyNoiseChange(int32_t)
412{
413 if (_game_mode == GM_NORMAL) {
415 if (_settings_game.economy.station_noise_level) {
417 }
418 }
419}
420
421static void MaxNoAIsChange(int32_t)
422{
423 if (GetGameSettings().difficulty.max_no_competitors != 0 &&
424 AI::GetInfoList()->empty() &&
426 ShowErrorMessage(GetEncodedString(STR_WARNING_NO_SUITABLE_AI), {}, WL_CRITICAL);
427 }
428
430}
431
436static bool CheckRoadSide(int32_t &)
437{
438 return _game_mode == GM_MENU || !RoadVehiclesAreBuilt();
439}
440
448static std::optional<uint32_t> ConvertLandscape(std::string_view value)
449{
450 /* try with the old values */
451 static constexpr std::initializer_list<std::string_view> _old_landscape_values{"normal"sv, "hilly"sv, "desert"sv, "candy"sv};
452 return OneOfManySettingDesc::ParseSingleValue(value, _old_landscape_values);
453}
454
455static bool CheckFreeformEdges(int32_t &new_value)
456{
457 if (_game_mode == GM_MENU) return true;
458 if (new_value != 0) {
459 for (Ship *s : Ship::Iterate()) {
460 /* Check if there is a ship on the northern border. */
461 if (TileX(s->tile) == 0 || TileY(s->tile) == 0) {
462 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_EMPTY), {}, WL_ERROR);
463 return false;
464 }
465 }
466 for (const BaseStation *st : BaseStation::Iterate()) {
467 /* Check if there is a non-deleted buoy on the northern border. */
468 if (st->IsInUse() && (TileX(st->xy) == 0 || TileY(st->xy) == 0)) {
469 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_EMPTY), {}, WL_ERROR);
470 return false;
471 }
472 }
473 } else {
474 for (uint i = 0; i < Map::MaxX(); i++) {
475 if (TileHeight(TileXY(i, 1)) != 0) {
476 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_WATER), {}, WL_ERROR);
477 return false;
478 }
479 }
480 for (uint i = 1; i < Map::MaxX(); i++) {
481 if (!IsTileType(TileXY(i, Map::MaxY() - 1), TileType::Water) || TileHeight(TileXY(1, Map::MaxY())) != 0) {
482 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_WATER), {}, WL_ERROR);
483 return false;
484 }
485 }
486 for (uint i = 0; i < Map::MaxY(); i++) {
487 if (TileHeight(TileXY(1, i)) != 0) {
488 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_WATER), {}, WL_ERROR);
489 return false;
490 }
491 }
492 for (uint i = 1; i < Map::MaxY(); i++) {
493 if (!IsTileType(TileXY(Map::MaxX() - 1, i), TileType::Water) || TileHeight(TileXY(Map::MaxX(), i)) != 0) {
494 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_EDGES_NOT_WATER), {}, WL_ERROR);
495 return false;
496 }
497 }
498 }
499 return true;
500}
501
502static void UpdateFreeformEdges(int32_t new_value)
503{
504 if (_game_mode == GM_MENU) return;
505
506 if (new_value != 0) {
507 for (uint x = 0; x < Map::SizeX(); x++) MakeVoid(TileXY(x, 0));
508 for (uint y = 0; y < Map::SizeY(); y++) MakeVoid(TileXY(0, y));
509 } else {
510 /* Make tiles at the border water again. */
511 for (uint i = 0; i < Map::MaxX(); i++) {
512 SetTileHeight(TileXY(i, 0), 0);
514 }
515 for (uint i = 0; i < Map::MaxY(); i++) {
516 SetTileHeight(TileXY(0, i), 0);
518 }
519 }
521}
522
528static bool CheckDynamicEngines([[maybe_unused]] int32_t &value)
529{
530 if (_game_mode == GM_MENU) return true;
531
533 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_DYNAMIC_ENGINES_EXISTING_VEHICLES), {}, WL_ERROR);
534 return false;
535 }
536
537 return true;
538}
539
540static bool CheckMaxHeightLevel(int32_t &new_value)
541{
542 if (_game_mode == GM_NORMAL) return false;
543 if (_game_mode != GM_EDITOR) return true;
544
545 /* Check if at least one mountain on the map is higher than the new value.
546 * If yes, disallow the change. */
547 for (const auto t : Map::Iterate()) {
548 if ((int32_t)TileHeight(t) > new_value) {
549 ShowErrorMessage(GetEncodedString(STR_CONFIG_SETTING_TOO_HIGH_MOUNTAIN), {}, WL_ERROR);
550 /* Return old, unchanged value */
551 return false;
552 }
553 }
554
555 return true;
556}
557
558static void StationCatchmentChanged(int32_t)
559{
562}
563
564static void MaxVehiclesChanged(int32_t)
565{
568}
569
575static bool ReplaceAsteriskWithEmptyPassword(std::string &newval)
576{
577 if (newval == "*") newval.clear();
578 return true;
579}
580
592
597{
598 /* If service intervals are in time units (calendar days or real-world minutes), reset them to the correct defaults. */
599 if (!_settings_client.company.vehicle.servint_ispercent) {
601 }
602
603 /* If we are using calendar timekeeping, "minutes per year" must be default. */
605 _settings_newgame.economy.minutes_per_calendar_year = CalendarTime::DEF_MINUTES_PER_YEAR;
606 }
607
609
610 /* It is possible to change these units in Scenario Editor. We must set the economy date appropriately. */
611 if (_game_mode == GM_EDITOR) {
612 TimerGameEconomy::Date new_economy_date;
613 TimerGameEconomy::DateFract new_economy_date_fract;
614
616 /* If the new mode is wallclock units, set the economy year back to 1. */
617 new_economy_date = TimerGameEconomy::ConvertYMDToDate(TimerGameEconomy::Year{1}, 0, 1);
618 new_economy_date_fract = 0;
619 } else {
620 /* If the new mode is calendar units, sync the economy year with the calendar year. */
621 new_economy_date = TimerGameEconomy::Date{TimerGameCalendar::date.base()};
622 new_economy_date_fract = TimerGameCalendar::date_fract;
623 }
624
625 /* If you open a savegame as a scenario, there may already be link graphs and/or vehicles. These use economy date. */
626 LinkGraphSchedule::instance.ShiftDates(new_economy_date - TimerGameEconomy::date);
627 for (auto v : Vehicle::Iterate()) v->ShiftDates(new_economy_date - TimerGameEconomy::date);
628
629 /* Only change the date after changing cached values above. */
630 TimerGameEconomy::SetDate(new_economy_date, new_economy_date_fract);
631 }
632}
633
638static void ChangeMinutesPerYear(int32_t new_value)
639{
640 /* We don't allow setting Minutes Per Year below default, unless it's to 0 for frozen calendar time. */
641 if (new_value < CalendarTime::DEF_MINUTES_PER_YEAR) {
642 int clamped;
643
644 /* If the new value is 1, we're probably at 0 and trying to increase the value, so we should jump up to default. */
645 if (new_value == 1) {
646 clamped = CalendarTime::DEF_MINUTES_PER_YEAR;
647 } else {
648 clamped = CalendarTime::FROZEN_MINUTES_PER_YEAR;
649 }
650
651 /* Override the setting with the clamped value. */
652 if (_game_mode == GM_MENU) {
653 _settings_newgame.economy.minutes_per_calendar_year = clamped;
654 } else {
655 _settings_game.economy.minutes_per_calendar_year = clamped;
656 }
657 }
658
659 /* If the setting value is not the default, force the game to use wallclock timekeeping units.
660 * This can only happen in the menu, since the pre_cb ensures this setting can only be changed there, or if we're already using wallclock units.
661 */
662 if (_game_mode == GM_MENU && (_settings_newgame.economy.minutes_per_calendar_year != CalendarTime::DEF_MINUTES_PER_YEAR)) {
663 if (_settings_newgame.economy.timekeeping_units != TimekeepingUnits::Wallclock) {
664 _settings_newgame.economy.timekeeping_units = TimekeepingUnits::Wallclock;
666 }
667 }
668}
669
670/* Get the valid range of the "minutes per calendar year" setting. */
671static std::tuple<int32_t, uint32_t> GetMinutesPerYearRange(const IntSettingDesc &)
672{
673 /* Allow a non-default value only if using Wallclock timekeeping units. */
674 if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) return { CalendarTime::FROZEN_MINUTES_PER_YEAR, CalendarTime::MAX_MINUTES_PER_YEAR };
675
676 return { CalendarTime::DEF_MINUTES_PER_YEAR, CalendarTime::DEF_MINUTES_PER_YEAR };
677}
678
683static bool CanChangeTimetableMode(int32_t &)
684{
686}
687
688/* End - Callback Functions */
Base functions for all AIs.
AIConfig stores the configuration settings of every AI.
Generic functions for replacing base data (graphics, sounds).
Generic functions for replacing base music data.
Generic functions for replacing base sounds data.
static const ScriptInfoList * GetInfoList()
Get the list of all registered scripts.
Definition ai_core.cpp:298
static constexpr int MAX_MINUTES_PER_YEAR
One week of real time. The actual max that doesn't overflow TimerGameCalendar::sub_date_fract is 1062...
static LinkGraphSchedule instance
Static instance of LinkGraphSchedule.
static Date date
Current date in days (day counter).
static DateFract date_fract
Fractional part of the day.
static Date date
Current date in days (day counter).
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
static void SetDate(Date date, DateFract fract)
Set the date.
static Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
int CompanyServiceInterval(const Company *c, VehicleType type)
Get the service interval for the given company and vehicle type.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
Configuration options of the network stuff.
Functions to handle different currencies.
Header file for electrified rail specific functions.
Functions related to errors.
@ WL_ERROR
Errors (eg. saving/loading failed).
Definition error.h:26
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
Definition error.h:27
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
Factory to 'query' all available blitters.
Functions to read fonts from files and cache them.
GameConfig stores the configuration settings of every Game.
Functions related to world/map generation.
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition gfx.cpp:1837
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1554
Declaration of link graph schedule used for cargo distribution.
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:376
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition math_func.hpp:23
Base for all music playback.
bool _networking
are we in networking mode?
Definition network.cpp:67
bool _network_server
network-server is active
Definition network.cpp:68
Basic functions/variables used all over the place.
Network functions used by other parts of OpenTTD.
void NetworkServerUpdateGameInfo()
Update the server's NetworkServerGameInfo due to changes in settings.
void NetworkServerSendConfigUpdate()
Send Config Update.
Functions related to news.
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
General types related to pathfinders.
Functions/types etc.
bool RoadVehiclesAreBuilt()
Verify whether a road vehicle is available.
Definition road_cmd.cpp:172
Road vehicle states.
Command definitions related to road vehicles.
A number of safeguards to prevent using unsafe methods.
Functions to make screenshots.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition settings.cpp:62
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
static void ChangeTimekeepingUnits()
Callback for when the player changes the timekeeping units.
static void RoadVehSlopeSteepnessChanged(int32_t)
This function updates the road vehicle acceleration cache after a steepness change.
static void RoadVehAccelerationModelChanged(int32_t)
This function updates realistic acceleration caches when the setting "Road vehicle acceleration model...
static void UpdateAllServiceInterval(int32_t new_value)
Check and update if needed all vehicle service intervals.
static void v_PositionStatusbar(int32_t)
Reposition the statusbar as the setting changed.
static int32_t GetDefaultServiceInterval(const IntSettingDesc &sd, VehicleType type)
Checks if the service intervals in the settings are specified as percentages and corrects the default...
static void TrainSlopeSteepnessChanged(int32_t)
This function updates the train acceleration cache after a steepness change.
static void UpdateLinkgraphColours(int32_t)
Redraw linkgraph links after a colour scheme change.
static void RedrawSmallmap(int32_t)
Redraw the smallmap after a colour scheme change.
static bool ReplaceAsteriskWithEmptyPassword(std::string &newval)
Replace a passwords that are a literal asterisk with an empty string.
static StringID SettingHelpWallclock(const IntSettingDesc &sd)
Switch setting help depending on wallclock setting.
static bool CheckDynamicEngines(int32_t &value)
Changing the setting "allow multiple NewGRF sets" is not allowed if there are vehicles.
static bool CheckRoadSide(int32_t &)
Check whether the road side may be changed.
static void v_PositionMainToolbar(int32_t)
Reposition the main toolbar as the setting changed.
static std::optional< uint32_t > ConvertLandscape(std::string_view value)
Conversion callback for _gameopt_settings_game.landscape It converts (or try) between old values and ...
static bool CanChangeTimetableMode(int32_t &)
Pre-callback check when trying to change the timetable mode.
static void UpdateClientConfigValues()
Update the game info, and send it to the clients when we are running as a server.
static std::pair< StringParameter, StringParameter > ServiceIntervalSettingsValueText(const IntSettingDesc &sd, int32_t value)
Service Interval Settings Default Value displays the correct units or as a percentage.
static void ChangeMinutesPerYear(int32_t new_value)
Callback after the player changes the minutes per year.
static StringID SettingTitleWallclock(const IntSettingDesc &sd)
Switch setting title depending on wallclock setting.
static std::pair< StringParameter, StringParameter > SettingsValueAbsolute(const IntSettingDesc &sd, int32_t value)
A negative value has another string (the one after "strval").
static std::pair< StringParameter, StringParameter > SettingsValueVelocityUnit(const IntSettingDesc &sd, int32_t value)
Setting values for velocity unit localisation.
static void InvalidateNewGRFChangeWindows(int32_t)
Update any possible saveload window and delete any newgrf dialogue as its widget parts might change.
Definition of the configuration tables of the settings.
GameSettings & GetGameSettings()
Get the settings-object applicable for the current situation: the newgame settings when we're in the ...
Base for ships.
void BuildLandLegend()
(Re)build the colour tables for the legends.
void BuildOwnerLegend()
Completes the array for the owned property legend.
void BuildLinkStatsLegend()
Populate legend table for the link stat view.
Smallmap GUI functions.
Base for all sound drivers.
void GfxClearSpriteCache()
Remove all encoded sprites from the sprite cache without discarding sprite location information.
Base classes/functions for stations.
void UpdateAirportsNoise()
Recalculate the noise generated by the airports of each town.
Functions related to stations.
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Base class for all station-ish types.
static bool ResetToCurrentNewGRFConfig()
Tries to reset the engine mapping to match the current NewGRF configuration.
Definition engine.cpp:588
Base integer type, including boolean, settings.
StringID str_help
(Translated) string with help text; gui only.
StringID str_val
(Translated) first string describing the value.
int32_t def
default value given when none is present
StringID str
(translated) string with descriptive text; gui and console
static uint SizeX()
Get the size of the map along the X.
Definition map_func.h:262
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:271
static IterateWrapper Iterate()
Returns an iterable ensemble of all Tiles.
Definition map_func.h:366
static uint MaxY()
Gets the maximum Y coordinate within the map, including TileType::Void.
Definition map_func.h:298
static uint MaxX()
Gets the maximum X coordinate within the map, including TileType::Void.
Definition map_func.h:289
static std::optional< uint32_t > ParseSingleValue(std::string_view str, std::span< const std::string_view > many)
Find the index value of a ONEofMANY type in a string.
Definition settings.cpp:191
static Pool::IterateWrapper< Vehicle > Iterate(size_t from=0)
static Company * Get(auto index)
Buses, trucks and trams belong to this class.
Definition roadveh.h:105
All ships have this type.
Definition ship.h:32
static void RecomputeCatchmentForAll()
Recomputes catchment of all stations.
Definition station.cpp:537
'Train' is either a loco or a wagon.
Definition train.h:97
Default settings for vehicles.
uint16_t servint_aircraft
service interval for aircraft
uint16_t servint_roadveh
service interval for road vehicles
uint16_t servint_ships
service interval for ships
bool servint_ispercent
service intervals are in percents
uint16_t servint_trains
service interval for trains
Vehicle data structure.
Stuff related to the text buffer GUI.
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
static uint TileHeight(Tile tile)
Returns the height of a tile.
Definition tile_map.h:29
void SetTileType(Tile tile, TileType type)
Set the type of a tile.
Definition tile_map.h:131
void SetTileHeight(Tile tile, uint height)
Sets the height of a tile.
Definition tile_map.h:57
@ Water
Water tile.
Definition tile_type.h:55
Definition of the game-calendar-timer.
Base of the town class.
@ TF_FORBIDDEN
Forbidden.
Definition town_type.h:108
Base for the train class.
static constexpr ConsistChangeFlags CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition train.h:53
Functions related to vehicles.
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
Base of all video drivers.
Functions related to (drawing on) viewports.
Map accessors for void tiles.
void MakeVoid(Tile t)
Make a nice void tile ;).
Definition void_map.h:19
int PositionStatusbar(Window *w)
(Re)position statusbar window at the screen.
Definition window.cpp:3504
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1209
int PositionMainToolbar(Window *w)
(Re)position main toolbar window at the screen.
Definition window.cpp:3493
int PositionNetworkChatWindow(Window *w)
(Re)position network chat window at the screen.
Definition window.cpp:3526
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition window.cpp:3438
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1222
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition window.cpp:3515
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Definition window.cpp:3229
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3321
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3339
Window functions not directly related to making/drawing windows.
@ WC_BUILD_STATION
Build station; Window numbers:
@ WC_SPRITE_ALIGNER
Sprite aligner (debug); Window numbers:
@ WC_COMPANY_COLOUR
Company colour selection; Window numbers:
@ WC_FOUND_TOWN
Found a town; Window numbers:
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition window_type.h:78
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
@ WC_ENGINE_PREVIEW
Engine preview window; Window numbers:
@ WC_CLIENT_LIST
Client list; Window numbers:
@ WC_TOWN_VIEW
Town view; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_SMALLMAP
Small map; Window numbers:
@ WC_SAVELOAD
Saveload window; Window numbers:
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
@ WC_BUILD_VEHICLE
Build vehicle; Window numbers: