OpenTTD Source  1.11.0-beta2
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 "core/enum_type.hpp"
14 
16 enum GameMode {
17  GM_MENU,
18  GM_NORMAL,
19  GM_EDITOR,
20  GM_BOOTSTRAP
21 };
22 
24 enum SwitchMode {
25  SM_NONE,
39 };
40 
50 };
51 
52 extern GameMode _game_mode;
54 extern bool _exit_game;
55 extern bool _save_config;
56 
58 enum PauseMode : byte {
60  PM_PAUSED_NORMAL = 1 << 0,
61  PM_PAUSED_SAVELOAD = 1 << 1,
62  PM_PAUSED_JOIN = 1 << 2,
63  PM_PAUSED_ERROR = 1 << 3,
67 
70 };
72 
73 
74 extern PauseMode _pause_mode;
75 
76 void AskExitGame();
77 void AskExitToGameMenu();
78 
79 int openttd_main(int argc, char *argv[]);
80 void HandleExitGameRequest();
81 
82 void SwitchToMode(SwitchMode new_mode);
83 
84 #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:49
SwitchMode
SwitchMode
Mode which defines what mode we're switching to.
Definition: openttd.h:24
SM_START_HEIGHTMAP
@ SM_START_HEIGHTMAP
Load a heightmap and start a new game from it.
Definition: openttd.h:36
SM_LOAD_GAME
@ SM_LOAD_GAME
Load game, Play Scenario.
Definition: openttd.h:30
SM_EDITOR
@ SM_EDITOR
Switch to scenario editor.
Definition: openttd.h:29
DisplayOptions
DisplayOptions
Display Options.
Definition: openttd.h:42
PMB_PAUSED_NETWORK
@ PMB_PAUSED_NETWORK
Pause mode bits when paused for network reasons.
Definition: openttd.h:69
SM_LOAD_SCENARIO
@ SM_LOAD_SCENARIO
Load scenario from scenario editor.
Definition: openttd.h:35
PM_UNPAUSED
@ PM_UNPAUSED
A normal unpaused game.
Definition: openttd.h:59
DO_FULL_ANIMATION
@ DO_FULL_ANIMATION
Perform palette animation.
Definition: openttd.h:46
PM_PAUSED_SAVELOAD
@ PM_PAUSED_SAVELOAD
A game paused for saving/loading.
Definition: openttd.h:61
SM_NEWGAME
@ SM_NEWGAME
New Game --> 'Random game'.
Definition: openttd.h:26
SM_SAVE_HEIGHTMAP
@ SM_SAVE_HEIGHTMAP
Save heightmap.
Definition: openttd.h:33
DO_SHOW_STATION_NAMES
@ DO_SHOW_STATION_NAMES
Display station names.
Definition: openttd.h:44
PauseMode
PauseMode
Modes of pausing we've got.
Definition: openttd.h:58
GameMode
GameMode
Mode which defines the state of the game.
Definition: openttd.h:16
SM_GENRANDLAND
@ SM_GENRANDLAND
Generate random land within scenario editor.
Definition: openttd.h:34
SM_SAVE_GAME
@ SM_SAVE_GAME
Save game.
Definition: openttd.h:32
DO_FULL_DETAIL
@ DO_FULL_DETAIL
Also draw details of track and roads.
Definition: openttd.h:47
PM_PAUSED_GAME_SCRIPT
@ PM_PAUSED_GAME_SCRIPT
A game paused by a game script.
Definition: openttd.h:65
openttd_main
int openttd_main(int argc, char *argv[])
Main entry point for this lovely game.
Definition: openttd.cpp:545
SM_LOAD_HEIGHTMAP
@ SM_LOAD_HEIGHTMAP
Load heightmap from scenario editor.
Definition: openttd.h:37
PM_PAUSED_ACTIVE_CLIENTS
@ PM_PAUSED_ACTIVE_CLIENTS
A game paused for 'min_active_clients'.
Definition: openttd.h:64
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
PM_PAUSED_NORMAL
@ PM_PAUSED_NORMAL
A game normally paused.
Definition: openttd.h:60
SM_RESTART_HEIGHTMAP
@ SM_RESTART_HEIGHTMAP
Load a heightmap and start a new game from it with current settings.
Definition: openttd.h:38
DO_SHOW_SIGNS
@ DO_SHOW_SIGNS
Display signs.
Definition: openttd.h:45
DO_SHOW_TOWN_NAMES
@ DO_SHOW_TOWN_NAMES
Display town names.
Definition: openttd.h:43
SM_RELOADGAME
@ SM_RELOADGAME
Reload the savegame / scenario / heightmap you started the game with.
Definition: openttd.h:28
SM_MENU
@ SM_MENU
Switch to game intro menu.
Definition: openttd.h:31
PM_PAUSED_LINK_GRAPH
@ PM_PAUSED_LINK_GRAPH
A game paused due to the link graph schedule lagging.
Definition: openttd.h:66
enum_type.hpp
PM_PAUSED_JOIN
@ PM_PAUSED_JOIN
A game paused for 'pause_on_join'.
Definition: openttd.h:62
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:29
PM_PAUSED_ERROR
@ PM_PAUSED_ERROR
A game paused because a (critical) error.
Definition: openttd.h:63
DO_SHOW_WAYPOINT_NAMES
@ DO_SHOW_WAYPOINT_NAMES
Display waypoint names.
Definition: openttd.h:48
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
SM_RESTARTGAME
@ SM_RESTARTGAME
Restart --> 'Random game' with current settings.
Definition: openttd.h:27