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 8 /** @file openttd.h Some generic types. */ 9 10 #ifndef OPENTTD_H 11 #define OPENTTD_H 12 13 #include <atomic> 14 #include "core/enum_type.hpp" 15 16 /** Mode which defines the state of the game. */ 17 enum GameMode { 18 GM_MENU, 19 GM_NORMAL, 20 GM_EDITOR, 21 GM_BOOTSTRAP 22 }; 23 24 /** Mode which defines what mode we're switching to. */ 25 enum SwitchMode { 26 SM_NONE, 27 SM_NEWGAME, ///< New Game --> 'Random game'. 28 SM_RESTARTGAME, ///< Restart --> 'Random game' with current settings. 29 SM_RELOADGAME, ///< Reload the savegame / scenario / heightmap you started the game with. 30 SM_EDITOR, ///< Switch to scenario editor. 31 SM_LOAD_GAME, ///< Load game, Play Scenario. 32 SM_MENU, ///< Switch to game intro menu. 33 SM_SAVE_GAME, ///< Save game. 34 SM_SAVE_HEIGHTMAP, ///< Save heightmap. 35 SM_GENRANDLAND, ///< Generate random land within scenario editor. 36 SM_LOAD_SCENARIO, ///< Load scenario from scenario editor. 37 SM_START_HEIGHTMAP, ///< Load a heightmap and start a new game from it. 38 SM_LOAD_HEIGHTMAP, ///< Load heightmap from scenario editor. 39 SM_RESTART_HEIGHTMAP, ///< Load a heightmap and start a new game from it with current settings. 40 SM_JOIN_GAME, ///< Join a network game. 41 }; 42 43 /** Display Options */ 44 enum DisplayOptions { 45 DO_SHOW_TOWN_NAMES = 0, ///< Display town names. 46 DO_SHOW_STATION_NAMES = 1, ///< Display station names. 47 DO_SHOW_SIGNS = 2, ///< Display signs. 48 DO_FULL_ANIMATION = 3, ///< Perform palette animation. 49 DO_FULL_DETAIL = 5, ///< Also draw details of track and roads. 50 DO_SHOW_WAYPOINT_NAMES = 6, ///< Display waypoint names. 51 DO_SHOW_COMPETITOR_SIGNS = 7, ///< Display signs, station names and waypoint names of opponent companies. Buoys and oilrig-stations are always shown, even if this option is turned off. 52 }; 53 54 extern GameMode _game_mode; 55 extern SwitchMode _switch_mode; 56 extern std::atomic<bool> _exit_game; 57 extern bool _save_config; 58 59 /** Modes of pausing we've got */ 60 enum PauseMode : byte { 61 PM_UNPAUSED = 0, ///< A normal unpaused game 62 PM_PAUSED_NORMAL = 1 << 0, ///< A game normally paused 63 PM_PAUSED_SAVELOAD = 1 << 1, ///< A game paused for saving/loading 64 PM_PAUSED_JOIN = 1 << 2, ///< A game paused for 'pause_on_join' 65 PM_PAUSED_ERROR = 1 << 3, ///< A game paused because a (critical) error 66 PM_PAUSED_ACTIVE_CLIENTS = 1 << 4, ///< A game paused for 'min_active_clients' 67 PM_PAUSED_GAME_SCRIPT = 1 << 5, ///< A game paused by a game script 68 PM_PAUSED_LINK_GRAPH = 1 << 6, ///< A game paused due to the link graph schedule lagging 69 70 /** Pause mode bits when paused for network reasons. */ 71 PMB_PAUSED_NETWORK = PM_PAUSED_ACTIVE_CLIENTS | PM_PAUSED_JOIN, 72 }; 73 DECLARE_ENUM_AS_BIT_SET(PauseMode) 74 75 /** The current pause mode */ 76 extern PauseMode _pause_mode; 77 78 void AskExitGame(); 79 void AskExitToGameMenu(); 80 81 int openttd_main(int argc, char *argv[]); 82 void HandleExitGameRequest(); 83 84 void SwitchToMode(SwitchMode new_mode); 85 86 bool RequestNewGRFScan(struct NewGRFScanCallback *callback = nullptr); 87 88 #endif /* OPENTTD_H */ 89