OpenTTD Source: src/openttd.h Source File

OpenTTD Source 14.1

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,
28 SM_NEWGAME,
29 SM_RESTARTGAME,
30 SM_RELOADGAME,
31 SM_EDITOR,
32 SM_LOAD_GAME,
33 SM_MENU,
34 SM_SAVE_GAME,
35 SM_SAVE_HEIGHTMAP,
36 SM_GENRANDLAND,
37 SM_LOAD_SCENARIO,
38 SM_START_HEIGHTMAP,
39 SM_LOAD_HEIGHTMAP,
40 SM_RESTART_HEIGHTMAP,
41 SM_JOIN_GAME,
42 };
43
45 enum DisplayOptions {
46 DO_SHOW_TOWN_NAMES = 0,
47 DO_SHOW_STATION_NAMES = 1,
48 DO_SHOW_SIGNS = 2,
49 DO_FULL_ANIMATION = 3,
50 DO_FULL_DETAIL = 5,
51 DO_SHOW_WAYPOINT_NAMES = 6,
52 DO_SHOW_COMPETITOR_SIGNS = 7,
53 };
54
55 struct GameSessionStats {
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;
62 extern SwitchMode _switch_mode;
63 extern GameSessionStats _game_session_stats;
64 extern std::atomic<bool> _exit_game;
65 extern bool _save_config;
66
68 enum PauseMode : byte {
69 PM_UNPAUSED = 0,
70 PM_PAUSED_NORMAL = 1 << 0,
71 PM_PAUSED_SAVELOAD = 1 << 1,
72 PM_PAUSED_JOIN = 1 << 2,
73 PM_PAUSED_ERROR = 1 << 3,
74 PM_PAUSED_ACTIVE_CLIENTS = 1 << 4,
75 PM_PAUSED_GAME_SCRIPT = 1 << 5,
76 PM_PAUSED_LINK_GRAPH = 1 << 6,
77 PM_COMMAND_DURING_PAUSE = 1 << 7,
78
80 PMB_PAUSED_NETWORK = PM_PAUSED_ACTIVE_CLIENTS | PM_PAUSED_JOIN,
81 };
82 DECLARE_ENUM_AS_BIT_SET(PauseMode)
83
84
85 extern PauseMode _pause_mode;
86
87 void AskExitGame();
88 void AskExitToGameMenu();
89
90 int openttd_main(int argc, char *argv[]);
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 */
DO_SHOW_COMPETITOR_SIGNS
@ DO_SHOW_COMPETITOR_SIGNS
Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are ...
Definition: openttd.h:52
SwitchMode
SwitchMode
Mode which defines what mode we're switching to.
Definition: openttd.h:26
SM_START_HEIGHTMAP
@ SM_START_HEIGHTMAP
Load a heightmap and start a new game from it.
Definition: openttd.h:38
SM_LOAD_GAME
@ SM_LOAD_GAME
Load game, Play Scenario.
Definition: openttd.h:32
ChangeAutosaveFrequency
void ChangeAutosaveFrequency(bool reset)
Reset the interval of the autosave.
Definition: openttd.cpp:1540
SM_EDITOR
@ SM_EDITOR
Switch to scenario editor.
Definition: openttd.h:31
DisplayOptions
DisplayOptions
Display Options.
Definition: openttd.h:45
PMB_PAUSED_NETWORK
@ PMB_PAUSED_NETWORK
Pause mode bits when paused for network reasons.
Definition: openttd.h:80
SM_LOAD_SCENARIO
@ SM_LOAD_SCENARIO
Load scenario from scenario editor.
Definition: openttd.h:37
StateGameLoop
void StateGameLoop()
State controlling game loop.
Definition: openttd.cpp:1434
PM_UNPAUSED
@ PM_UNPAUSED
A normal unpaused game.
Definition: openttd.h:69
DO_FULL_ANIMATION
@ DO_FULL_ANIMATION
Perform palette animation.
Definition: openttd.h:49
GameSessionStats::start_time
std::chrono::steady_clock::time_point start_time
Time when the current game was started.
Definition: openttd.h:56
GenerateSavegameId
void GenerateSavegameId()
Generate an unique savegame ID.
Definition: misc.cpp:88
PM_PAUSED_SAVELOAD
@ PM_PAUSED_SAVELOAD
A game paused for saving/loading.
Definition: openttd.h:71
SM_NEWGAME
@ SM_NEWGAME
New Game --> 'Random game'.
Definition: openttd.h:28
GameSessionStats::savegame_id
std::string savegame_id
Unique ID of the savegame.
Definition: openttd.h:57
SM_SAVE_HEIGHTMAP
@ SM_SAVE_HEIGHTMAP
Save heightmap.
Definition: openttd.h:35
RequestNewGRFScan
bool RequestNewGRFScan(struct NewGRFScanCallback *callback=nullptr)
Request a new NewGRF scan.
Definition: openttd.cpp:1553
GameSessionStats::savegame_size
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
DO_SHOW_STATION_NAMES
@ DO_SHOW_STATION_NAMES
Display station names.
Definition: openttd.h:47
PauseMode
PauseMode
Modes of pausing we've got.
Definition: openttd.h:68
GameMode
GameMode
Mode which defines the state of the game.
Definition: openttd.h:18
SM_GENRANDLAND
@ SM_GENRANDLAND
Generate random land within scenario editor.
Definition: openttd.h:36
SM_SAVE_GAME
@ SM_SAVE_GAME
Save game.
Definition: openttd.h:34
DO_FULL_DETAIL
@ DO_FULL_DETAIL
Also draw details of track and roads.
Definition: openttd.h:50
PM_PAUSED_GAME_SCRIPT
@ PM_PAUSED_GAME_SCRIPT
A game paused by a game script.
Definition: openttd.h:75
openttd_main
int openttd_main(int argc, char *argv[])
Main entry point for this lovely game.
Definition: openttd.cpp:518
SM_LOAD_HEIGHTMAP
@ SM_LOAD_HEIGHTMAP
Load heightmap from scenario editor.
Definition: openttd.h:39
PM_PAUSED_ACTIVE_CLIENTS
@ PM_PAUSED_ACTIVE_CLIENTS
A game paused for 'min_active_clients'.
Definition: openttd.h:74
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:48
_game_session_stats
GameSessionStats _game_session_stats
Statistics about the current session.
Definition: gfx.cpp:50
PM_PAUSED_NORMAL
@ PM_PAUSED_NORMAL
A game normally paused.
Definition: openttd.h:70
SM_RESTART_HEIGHTMAP
@ SM_RESTART_HEIGHTMAP
Load a heightmap and start a new game from it with current settings.
Definition: openttd.h:40
DO_SHOW_SIGNS
@ DO_SHOW_SIGNS
Display signs.
Definition: openttd.h:48
DO_SHOW_TOWN_NAMES
@ DO_SHOW_TOWN_NAMES
Display town names.
Definition: openttd.h:46
SM_RELOADGAME
@ SM_RELOADGAME
Reload the savegame / scenario / heightmap you started the game with.
Definition: openttd.h:30
SM_MENU
@ SM_MENU
Switch to game intro menu.
Definition: openttd.h:33
PM_PAUSED_LINK_GRAPH
@ PM_PAUSED_LINK_GRAPH
A game paused due to the link graph schedule lagging.
Definition: openttd.h:76
enum_type.hpp
PM_PAUSED_JOIN
@ PM_PAUSED_JOIN
A game paused for 'pause_on_join'.
Definition: openttd.h:72
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
NewGRFScanCallback
Callback for NewGRF scanning.
Definition: newgrf_config.h:206
GameSessionStats
Definition: openttd.h:55
PM_PAUSED_ERROR
@ PM_PAUSED_ERROR
A game paused because a (critical) error.
Definition: openttd.h:73
SM_JOIN_GAME
@ SM_JOIN_GAME
Join a network game.
Definition: openttd.h:41
DO_SHOW_WAYPOINT_NAMES
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
Definition: openttd.h:51
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:49
PM_COMMAND_DURING_PAUSE
@ PM_COMMAND_DURING_PAUSE
A game paused, and a command executed during the pause; resets on autosave.
Definition: openttd.h:77
SM_RESTARTGAME
@ SM_RESTARTGAME
Restart --> 'Random game' with current settings.
Definition: openttd.h:29