openttd.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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>.
 */

 
#ifndef OPENTTD_H
#define OPENTTD_H
 
#include <atomic>
#include <chrono>
#include "core/enum_type.hpp"

enum GameMode : uint8_t {
  GM_MENU,
  GM_NORMAL,
  GM_EDITOR,
  GM_BOOTSTRAP
};

enum SwitchMode : uint8_t {
  SM_NONE,
  SM_NEWGAME,           
  SM_RESTARTGAME,       
  SM_RELOADGAME,        
  SM_EDITOR,            
  SM_LOAD_GAME,         
  SM_MENU,              
  SM_SAVE_GAME,         
  SM_SAVE_HEIGHTMAP,    
  SM_GENRANDLAND,       
  SM_LOAD_SCENARIO,     
  SM_START_HEIGHTMAP,   
  SM_LOAD_HEIGHTMAP,    
  SM_RESTART_HEIGHTMAP, 
  SM_JOIN_GAME,         
};

enum DisplayOptions : uint8_t {
  DO_SHOW_TOWN_NAMES     = 0, 
  DO_SHOW_STATION_NAMES  = 1, 
  DO_SHOW_SIGNS          = 2, 
  DO_FULL_ANIMATION      = 3, 
  DO_FULL_DETAIL         = 5, 
  DO_SHOW_WAYPOINT_NAMES = 6, 
  DO_SHOW_COMPETITOR_SIGNS = 7, 
};
 
struct GameSessionStats {
  std::chrono::steady_clock::time_point start_time; 
  std::string savegame_id; 
  std::optional<size_t> savegame_size; 
};
 
extern GameMode _game_mode;
extern SwitchMode _switch_mode;
extern GameSessionStats _game_session_stats;
extern std::atomic<bool> _exit_game;
extern bool _save_config;

enum class PauseMode : uint8_t {
  Normal             = 0, 
  SaveLoad           = 1, 
  Join               = 2, 
  Error              = 3, 
  ActiveClients      = 4, 
  GameScript         = 5, 
  LinkGraph          = 6, 
  CommandDuringPause = 7, 
};
using PauseModes = EnumBitSet<PauseMode, uint8_t>;

extern PauseModes _pause_mode;
 
void AskExitGame();
void AskExitToGameMenu();
 
int openttd_main(std::span<std::string_view> arguments);
void StateGameLoop();
void HandleExitGameRequest();
 
void SwitchToMode(SwitchMode new_mode);
 
bool RequestNewGRFScan(struct NewGRFScanCallback *callback = nullptr);
void GenerateSavegameId();
 
void OpenBrowser(const std::string &url);
void ChangeAutosaveFrequency(bool reset);
 
#endif /* OPENTTD_H */