OpenTTD Source  20241108-master-g80f628063a
openttd.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef OPENTTD_H
11 #define OPENTTD_H
12 
13 #include <atomic>
14 #include <chrono>
15 #include "core/enum_type.hpp"
16 
18 enum GameMode {
19  GM_MENU,
20  GM_NORMAL,
21  GM_EDITOR,
22  GM_BOOTSTRAP
23 };
24 
26 enum SwitchMode {
27  SM_NONE,
42 };
43 
53 };
54 
56  std::chrono::steady_clock::time_point start_time;
57  std::string savegame_id;
58  std::optional<size_t> savegame_size;
59 };
60 
61 extern GameMode _game_mode;
64 extern std::atomic<bool> _exit_game;
65 extern bool _save_config;
66 
68 enum PauseMode : uint8_t {
70  PM_PAUSED_NORMAL = 1 << 0,
71  PM_PAUSED_SAVELOAD = 1 << 1,
72  PM_PAUSED_JOIN = 1 << 2,
73  PM_PAUSED_ERROR = 1 << 3,
78 
81 };
83 
84 
85 extern PauseMode _pause_mode;
86 
87 void AskExitGame();
88 void AskExitToGameMenu();
89 
90 int openttd_main(std::span<char * const> arguments);
91 void StateGameLoop();
92 void HandleExitGameRequest();
93 
94 void SwitchToMode(SwitchMode new_mode);
95 
96 bool RequestNewGRFScan(struct NewGRFScanCallback *callback = nullptr);
97 void GenerateSavegameId();
98 
99 void OpenBrowser(const std::string &url);
100 void ChangeAutosaveFrequency(bool reset);
101 
102 #endif /* OPENTTD_H */
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Type (helpers) for enums.
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:50
int openttd_main(std::span< char *const > arguments)
Main entry point for this lovely game.
Definition: openttd.cpp:504
SwitchMode
Mode which defines what mode we're switching to.
Definition: openttd.h:26
@ SM_START_HEIGHTMAP
Load a heightmap and start a new game from it.
Definition: openttd.h:38
@ SM_RESTART_HEIGHTMAP
Load a heightmap and start a new game from it with current settings.
Definition: openttd.h:40
@ SM_LOAD_SCENARIO
Load scenario from scenario editor.
Definition: openttd.h:37
@ SM_GENRANDLAND
Generate random land within scenario editor.
Definition: openttd.h:36
@ SM_JOIN_GAME
Join a network game.
Definition: openttd.h:41
@ SM_MENU
Switch to game intro menu.
Definition: openttd.h:33
@ SM_RESTARTGAME
Restart --> 'Random game' with current settings.
Definition: openttd.h:29
@ SM_RELOADGAME
Reload the savegame / scenario / heightmap you started the game with.
Definition: openttd.h:30
@ SM_SAVE_HEIGHTMAP
Save heightmap.
Definition: openttd.h:35
@ SM_LOAD_HEIGHTMAP
Load heightmap from scenario editor.
Definition: openttd.h:39
@ SM_SAVE_GAME
Save game.
Definition: openttd.h:34
@ SM_LOAD_GAME
Load game, Play Scenario.
Definition: openttd.h:32
@ SM_EDITOR
Switch to scenario editor.
Definition: openttd.h:31
@ SM_NEWGAME
New Game --> 'Random game'.
Definition: openttd.h:28
void ChangeAutosaveFrequency(bool reset)
Reset the interval of the autosave.
Definition: openttd.cpp:1318
GameSessionStats _game_session_stats
Statistics about the current session.
Definition: gfx.cpp:51
void StateGameLoop()
State controlling game loop.
Definition: openttd.cpp:1212
void GenerateSavegameId()
Generate an unique savegame ID.
Definition: misc.cpp:87
PauseMode
Modes of pausing we've got.
Definition: openttd.h:68
@ PM_COMMAND_DURING_PAUSE
A game paused, and a command executed during the pause; resets on autosave.
Definition: openttd.h:77
@ PM_UNPAUSED
A normal unpaused game.
Definition: openttd.h:69
@ PM_PAUSED_ACTIVE_CLIENTS
A game paused for 'min_active_clients'.
Definition: openttd.h:74
@ PM_PAUSED_ERROR
A game paused because a (critical) error.
Definition: openttd.h:73
@ PM_PAUSED_GAME_SCRIPT
A game paused by a game script.
Definition: openttd.h:75
@ PM_PAUSED_JOIN
A game paused for 'pause_on_join'.
Definition: openttd.h:72
@ PMB_PAUSED_NETWORK
Pause mode bits when paused for network reasons.
Definition: openttd.h:80
@ PM_PAUSED_LINK_GRAPH
A game paused due to the link graph schedule lagging.
Definition: openttd.h:76
@ PM_PAUSED_NORMAL
A game normally paused.
Definition: openttd.h:70
@ PM_PAUSED_SAVELOAD
A game paused for saving/loading.
Definition: openttd.h:71
bool RequestNewGRFScan(struct NewGRFScanCallback *callback=nullptr)
Request a new NewGRF scan.
Definition: openttd.cpp:1331
GameMode
Mode which defines the state of the game.
Definition: openttd.h:18
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:49
DisplayOptions
Display Options.
Definition: openttd.h:45
@ DO_SHOW_TOWN_NAMES
Display town names.
Definition: openttd.h:46
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:52
@ DO_FULL_DETAIL
Also draw details of track and roads.
Definition: openttd.h:50
@ DO_SHOW_SIGNS
Display signs.
Definition: openttd.h:48
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
Definition: openttd.h:51
@ DO_SHOW_STATION_NAMES
Display station names.
Definition: openttd.h:47
@ DO_FULL_ANIMATION
Perform palette animation.
Definition: openttd.h:49
std::chrono::steady_clock::time_point start_time
Time when the current game was started.
Definition: openttd.h:56
std::string savegame_id
Unique ID of the savegame.
Definition: openttd.h:57
std::optional< size_t > savegame_size
Size of the last saved savegame in bytes, or std::nullopt if not saved yet.
Definition: openttd.h:58
Callback for NewGRF scanning.