OpenTTD Source 20241224-master-gf74b0cf984
|
Functions related to starting OpenTTD. More...
#include "stdafx.h"
#include "blitter/factory.hpp"
#include "sound/sound_driver.hpp"
#include "music/music_driver.hpp"
#include "video/video_driver.hpp"
#include "mixer.h"
#include "fontcache.h"
#include "error.h"
#include "error_func.h"
#include "gui.h"
#include "base_media_base.h"
#include "saveload/saveload.h"
#include "company_cmd.h"
#include "company_func.h"
#include "command_func.h"
#include "news_func.h"
#include "fios.h"
#include "aircraft.h"
#include "roadveh.h"
#include "train.h"
#include "ship.h"
#include "console_func.h"
#include "screenshot.h"
#include "network/network.h"
#include "network/network_func.h"
#include "ai/ai.hpp"
#include "ai/ai_config.hpp"
#include "settings_func.h"
#include "genworld.h"
#include "progress.h"
#include "strings_func.h"
#include "vehicle_func.h"
#include "gamelog.h"
#include "animated_tile_func.h"
#include "roadstop_base.h"
#include "elrail_func.h"
#include "rev.h"
#include "highscore.h"
#include "station_base.h"
#include "crashlog.h"
#include "engine_func.h"
#include "core/random_func.hpp"
#include "rail_gui.h"
#include "road_gui.h"
#include "core/backup_type.hpp"
#include "hotkeys.h"
#include "newgrf.h"
#include "misc/getoptdata.h"
#include "game/game.hpp"
#include "game/game_config.hpp"
#include "town.h"
#include "subsidy_func.h"
#include "gfx_layout.h"
#include "viewport_func.h"
#include "viewport_sprite_sorter.h"
#include "framerate_type.h"
#include "industry.h"
#include "network/network_gui.h"
#include "network/network_survey.h"
#include "misc_cmd.h"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
#include "timer/timer_game_realtime.h"
#include "timer/timer_game_tick.h"
#include "social_integration.h"
#include "linkgraph/linkgraphschedule.h"
#include <system_error>
#include "safeguards.h"
Go to the source code of this file.
Data Structures | |
struct | AfterNewGRFScan |
Callback structure of statements to be executed after the NewGRF scan. More... | |
Functions | |
void | CallLandscapeTick () |
void | DoPaletteAnimations () |
void | MusicLoop () |
Check music playback status and start/stop/song-finished. | |
void | CallWindowGameTickEvent () |
Dispatch OnGameTick event over all windows. | |
bool | HandleBootstrap () |
Handle all procedures for bootstrapping OpenTTD without a base graphics set. | |
void | CheckCaches () |
Check the validity of some of the caches. | |
Company * | DoStartupNewCompany (bool is_ai, CompanyID company=INVALID_COMPANY) |
Create a new company and sets all company variables default values. | |
void | OSOpenBrowser (const std::string &url) |
void | ShowOSErrorBox (const char *buf, bool system) |
void | UserErrorI (const std::string &str) |
Error handling for fatal user errors. | |
void | FatalErrorI (const std::string &str) |
Error handling for fatal non-user errors. | |
static void | ShowHelp () |
Show the help message when someone passed a wrong parameter. | |
static void | WriteSavegameInfo (const std::string &name) |
static void | ParseResolution (Dimension *res, const char *s) |
Extract the resolution from the given string and store it in the 'res' parameter. | |
static void | ShutdownGame () |
Uninitializes drivers, frees allocated memory, cleans pools, ... Generally, prepares the game for shutting down. | |
static void | LoadIntroGame (bool load_newgrfs=true) |
Load the introduction game. | |
void | MakeNewgameSettingsLive () |
void | OpenBrowser (const std::string &url) |
void | PostMainLoop () |
static std::vector< OptionData > | CreateOptions () |
Create all the options that OpenTTD supports. | |
int | openttd_main (std::span< char *const > arguments) |
Main entry point for this lovely game. | |
void | HandleExitGameRequest () |
static void | OnStartScenario () |
Triggers everything required to set up a saved scenario for a new game. | |
static void | OnStartGame (bool dedicated_server) |
Triggers everything that should be triggered when starting a game. | |
static void | MakeNewGameDone () |
static void | MakeNewGame (bool from_heightmap, bool reset_settings) |
static void | MakeNewEditorWorldDone () |
static void | MakeNewEditorWorld () |
bool | SafeLoad (const std::string &filename, SaveLoadOperation fop, DetailedFileType dft, GameMode newgm, Subdirectory subdir, std::shared_ptr< LoadFilter > lf=nullptr) |
Load the specified savegame but on error do different things. | |
static void | UpdateSocialIntegration (GameMode game_mode) |
void | SwitchToMode (SwitchMode new_mode) |
void | StateGameLoop () |
State controlling game loop. | |
void | ChangeAutosaveFrequency (bool reset) |
Reset the interval of the autosave. | |
bool | RequestNewGRFScan (NewGRFScanCallback *callback) |
Request a new NewGRF scan. | |
void | GameLoop () |
Variables | |
std::string | _config_file |
Configuration file of OpenTTD. | |
bool | _save_config = false |
bool | _request_newgrf_scan = false |
NewGRFScanCallback * | _request_newgrf_scan_callback = nullptr |
static IntervalTimer< TimerGameRealtime > | _autosave_interval ({std::chrono::milliseconds::zero(), TimerGameRealtime::AUTOSAVE}, [](auto) { _pause_mode &=~PM_COMMAND_DURING_PAUSE;_do_autosave=true;SetWindowDirty(WC_STATUS_BAR, 0);static FiosNumberedSaveName _autosave_ctr("autosave");DoAutoOrNetsave(_autosave_ctr);_do_autosave=false;SetWindowDirty(WC_STATUS_BAR, 0);}) |
Interval for regular autosaves. | |
Functions related to starting OpenTTD.
Definition in file openttd.cpp.
void CallLandscapeTick | ( | ) |
Definition at line 1662 of file landscape.cpp.
void CallWindowGameTickEvent | ( | ) |
Dispatch OnGameTick event over all windows.
Definition at line 3248 of file window.cpp.
References Window::OnGameTick().
Referenced by StateGameLoop().
void ChangeAutosaveFrequency | ( | bool | reset | ) |
Reset the interval of the autosave.
If reset is not set, this does not set the elapsed time on the timer, so if the interval is smaller, it might result in an autosave being done immediately.
reset | Whether to reset the timer back to zero, or to continue. |
Definition at line 1318 of file openttd.cpp.
References _autosave_interval, _settings_client, TimerGameRealtime::AUTOSAVE, GUISettings::autosave_interval, ClientSettings::gui, and IntervalTimer< TTimerType >::SetInterval().
Referenced by GameOptionsWindow::OnDropdownSelect().
|
extern |
Check the validity of some of the caches.
Especially in the sense of desyncs between the cached value and what the value would be when calculated from the 'base' data.
Definition at line 36 of file cachecheck.cpp.
References OrthogonalTileArea::Add(), AfterLoadCompanyStats(), CCF_TRACK, Debug, DIAGDIR_NE, DIAGDIR_NW, FillNewGRFVehicleCache(), SpecializedVehicle< Ship, VEH_SHIP >::From(), SpecializedVehicle< T, Type >::From(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), OrthogonalTileArea::h, IsBayRoadStopTile(), IsDockingTile(), SpecializedStation< Station, false >::Iterate(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_industry_pool >::Iterate(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Iterate(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Iterate(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Iterate(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_roadstop_pool >::Iterate(), Vehicle::Next(), RebuildSubsidisedSourceAndDestinationCache(), RebuildTownCaches(), Station::RecomputeCatchmentForAll(), RoadVehUpdateCache(), OrthogonalTileArea::tile, UpdateAircraftCache(), Ship::UpdateCache(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, VS_CRASHED, and OrthogonalTileArea::w.
Referenced by StateGameLoop().
|
static |
Create all the options that OpenTTD supports.
Each option is always a single character with no, an optional or a required value.
Definition at line 482 of file openttd.cpp.
References ODF_HAS_VALUE.
Referenced by openttd_main().
void DoPaletteAnimations | ( | ) |
Definition at line 172 of file palette.cpp.
|
extern |
Create a new company and sets all company variables default values.
is_ai | is an AI company? |
company | CompanyID to use for the new company |
Definition at line 585 of file company_cmd.cpp.
void FatalErrorI | ( | const std::string & | str | ) |
Error handling for fatal non-user errors.
str | the string to print. |
Definition at line 133 of file openttd.cpp.
void GameLoop | ( | ) |
Definition at line 1340 of file openttd.cpp.
bool HandleBootstrap | ( | ) |
Handle all procedures for bootstrapping OpenTTD without a base graphics set.
This requires all kinds of trickery that is needed to avoid the use of sprites from the base graphics set which are pretty interwoven.
Definition at line 362 of file bootstrap_gui.cpp.
References _network_available, CheckForMissingGlyphs(), BlitterFactory::GetCurrentBlitter(), VideoDriver::GetInstance(), BaseMedia< GraphicsSet >::GetUsedSet(), InitializeUnicodeGlyphMap(), VideoDriver::MainLoop(), SetColourGradient(), and BaseMedia< GraphicsSet >::SetSet().
Referenced by openttd_main().
void HandleExitGameRequest | ( | ) |
Definition at line 817 of file openttd.cpp.
|
static |
Load the introduction game.
load_newgrfs | Whether to load the NewGRFs or not. |
Definition at line 315 of file openttd.cpp.
References _pause_mode, BASESET_DIR, CheckForMissingGlyphs(), COMPANY_FIRST, COMPANY_SPECTATOR, DFT_GAME_FILE, CursorVars::fix_at, GenerateWorld(), GWM_EMPTY, MusicLoop(), PM_UNPAUSED, ResetGRFConfig(), ResetWindowSystem(), SaveOrLoad(), SetLocalCompany(), SetupColoursAndInitialWindow(), SL_OK, and SLO_LOAD.
Referenced by AfterNewGRFScan::OnNewGRFsScanned(), openttd_main(), and SafeLoad().
|
static |
Definition at line 921 of file openttd.cpp.
|
static |
Definition at line 916 of file openttd.cpp.
|
static |
Definition at line 902 of file openttd.cpp.
|
static |
Definition at line 860 of file openttd.cpp.
void MakeNewgameSettingsLive | ( | ) |
Definition at line 342 of file openttd.cpp.
void MusicLoop | ( | ) |
Check music playback status and start/stop/song-finished.
Called from main loop.
Definition at line 454 of file music_gui.cpp.
References MusicSystem::CheckStatus().
Referenced by LoadIntroGame().
|
static |
Triggers everything that should be triggered when starting a game.
dedicated_server | Whether this is a dedicated server or not. |
Definition at line 848 of file openttd.cpp.
References COMPANY_SPECTATOR, GetFirstPlayableCompanyID(), IConsoleCmdExec(), NetworkOnGameStart(), and SetLocalCompany().
|
static |
Triggers everything required to set up a saved scenario for a new game.
Definition at line 833 of file openttd.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_industry_pool >::Iterate(), EngineOverrideManager::ResetToCurrentNewGRFConfig(), and TimerGameEconomy::year.
void OpenBrowser | ( | const std::string & | url | ) |
Definition at line 370 of file openttd.cpp.
int openttd_main | ( | std::span< char *const > | arguments | ) |
Main entry point for this lovely game.
arguments | The command line arguments passed to the application. |
Definition at line 504 of file openttd.cpp.
References _blitter_autodetected, _config_file, _cur_resolution, _file_to_saveload, _game_session_stats, _ini_blitter, _ini_musicdriver, _ini_sounddriver, _ini_videodriver, _load_check_data, _skip_all_newgrf_scanning, _switch_mode, GetOptData::arguments, TarScanner::BASESET, BLT_8BPP, LoadCheckData::Clear(), CreateOptions(), Debug, DeterminePaths(), DFT_GAME_FILE, TarScanner::DoScan(), Driver::DT_MUSIC, Driver::DT_SOUND, Driver::DT_VIDEO, LoadCheckData::error, LoadCheckData::error_msg, BaseGraphics::Ini::extra_version, BaseMedia< MusicSet >::FindSets(), BaseMedia< GraphicsSet >::FindSets(), BaseMedia< SoundsSet >::FindSets(), FiosGetSavegameListCallback(), FiosGetScenarioListCallback(), FS2OTTD(), FT_HEIGHTMAP, FT_SAVEGAME, FT_SCENARIO, GENERATE_NEW_SEED, GenerateWorld(), GetAbstractFileType(), GetDetailedFileType(), VideoDriver::GetInstance(), GetOptData::GetOpt(), GraphicsSet::GetOrCreateExtraConfig(), GetString(), BaseMedia< GraphicsSet >::GetUsedSet(), GWM_EMPTY, HandleBootstrap(), LoadCheckData::HasErrors(), CursorVars::in_window, BaseSounds::ini_set, BaseMusic::ini_set, InitFontCache(), SocialIntegration::Initialize(), InitializeLanguagePacks(), InitializeScreenshotFormats(), InitializeSpriteSorter(), InitWindowSystem(), GRFConfig::IsCompatible(), LoadFromConfig(), LoadIntroGame(), VideoDriver::MainLoop(), FileToSaveLoad::name, NetworkStartUp(), GetOptData::opt, OTTD2FS(), ParseFullConnectionString(), ParseResolution(), RequestNewGRFScan(), S8BPP_NONE, SAVE_DIR, GameSessionStats::savegame_size, SaveOrLoad(), ScheduleErrorMessage(), BlitterFactory::SelectBlitter(), DriverFactoryBase::SelectDriver(), SetDebugString(), SetDParamStr(), ErrorMessageData::SetDParamStr(), FileToSaveLoad::SetMode(), BaseMedia< GraphicsSet >::SetSet(), BaseMedia< MusicSet >::SetSet(), BaseMedia< SoundsSet >::SetSet(), BaseMedia< GraphicsSet >::SetSetByName(), BaseMedia< SoundsSet >::SetSetByName(), BaseMedia< MusicSet >::SetSetByName(), BaseMedia< GraphicsSet >::SetSetByShortname(), ShowHelp(), ShutdownGame(), SL_OK, SLO_CHECK, SLO_LOAD, SM_EDITOR, SM_LOAD_GAME, SM_LOAD_HEIGHTMAP, SM_LOAD_SCENARIO, SM_MENU, SM_NEWGAME, SM_START_HEIGHTMAP, GameSessionStats::start_time, StrEmpty(), UpdateGUIZoom(), and ZOOM_LVL_MIN.
|
static |
Extract the resolution from the given string and store it in the 'res' parameter.
res | variable to store the resolution in. |
s | the string to decompose. |
Definition at line 267 of file openttd.cpp.
Referenced by openttd_main().
void PostMainLoop | ( | ) |
Definition at line 457 of file openttd.cpp.
bool RequestNewGRFScan | ( | NewGRFScanCallback * | callback | ) |
Request a new NewGRF scan.
This will be executed on the next game-tick. This is mostly needed to ensure NewGRF scans (which are blocking) are done in the game-thread, and not in the draw-thread (which most often triggers this request).
callback | Optional callback to call when NewGRF scan is completed. |
Definition at line 1331 of file openttd.cpp.
Referenced by NetworkContentDownloadStatusWindow::Close(), NewGRFWindow::OnClick(), and openttd_main().
bool SafeLoad | ( | const std::string & | filename, |
SaveLoadOperation | fop, | ||
DetailedFileType | dft, | ||
GameMode | newgm, | ||
Subdirectory | subdir, | ||
std::shared_ptr< LoadFilter > | lf = nullptr |
||
) |
Load the specified savegame but on error do different things.
If loading fails due to corrupt savegame, bad version, etc. go back to a previous correct state. In the menu for example load the intro game again.
filename | file to be loaded |
fop | mode of loading, always SLO_LOAD |
newgm | switch to this mode of loading fails due to some unknown error |
subdir | default directory to look for filename, set to 0 if not needed |
lf | Load filter to use, if nullptr: use filename + subdir. |
Definition at line 943 of file openttd.cpp.
References _network_dedicated, _network_server, Debug, DFT_GAME_FILE, DFT_OLD_GAME_FILE, LoadIntroGame(), LoadWithFilter(), NetworkDisconnect(), SaveOrLoad(), SL_OK, SL_REINIT, and SLO_LOAD.
|
static |
Show the help message when someone passed a wrong parameter.
Definition at line 147 of file openttd.cpp.
References DumpDebugFacilityNames(), BlitterFactory::GetBlittersInfo(), AI::GetConsoleList(), Game::GetConsoleList(), DriverFactoryBase::GetDriversInfo(), BaseMedia< MusicSet >::GetSetsList(), BaseMedia< SoundsSet >::GetSetsList(), BaseMedia< GraphicsSet >::GetSetsList(), AI::Initialize(), Game::Initialize(), AI::Uninitialize(), and Game::Uninitialize().
Referenced by openttd_main().
|
extern |
|
static |
Uninitializes drivers, frees allocated memory, cleans pools, ... Generally, prepares the game for shutting down.
Definition at line 284 of file openttd.cpp.
References _gamelog, _network_available, PoolBase::Clean(), LinkGraphSchedule::Clear(), NetworkShutDown(), PT_ALL, Gamelog::Reset(), ResetNewGRFData(), SocialIntegration::Shutdown(), DriverFactoryBase::ShutdownDrivers(), UninitFontCache(), AI::Uninitialize(), Game::Uninitialize(), and UnInitWindowSystem().
Referenced by openttd_main().
void StateGameLoop | ( | ) |
State controlling game loop.
The state must not be changed from anywhere but here. That check is enforced in DoCommand.
Definition at line 1212 of file openttd.cpp.
References _current_company, _network_server, _networking, _pause_mode, _settings_game, AnimateAnimatedTiles(), AUTOSAVE_DIR, CallWindowGameTickEvent(), CheckCaches(), TimerGameEconomy::date, TimerGameEconomy::date_fract, DFT_GAME_FILE, TimerManager< TTimerType >::Elapsed(), GameSettings::game_creation, AI::GameLoop(), Game::GameLoop(), GameCreationSettings::generation_seed, HasModalProgress(), IsLocalCompany(), OWNER_NONE, PerformanceMeasurer::Paused(), PFE_ALLSCRIPTS, PFE_GAMELOOP, PFE_GL_AIRCRAFT, PFE_GL_ECONOMY, PFE_GL_LANDSCAPE, PFE_GL_ROADVEHS, PFE_GL_SHIPS, PFE_GL_TRAINS, PM_UNPAUSED, PSM_ENTER_GAMELOOP, PSM_LEAVE_GAMELOOP, Layouter::ReduceLineCache(), PerformanceAccumulator::Reset(), Backup< T >::Restore(), RunTileLoop(), RunVehicleCalendarDayProc(), SaveOrLoad(), SLO_SAVE, StateGameLoop_LinkGraphPauseControl(), BasePersistentStorageArray::SwitchMode(), and UpdateLandscapingLimits().
Referenced by ClientNetworkGameSocketHandler::GameLoop().
void SwitchToMode | ( | SwitchMode | new_mode | ) |
Definition at line 1020 of file openttd.cpp.
|
static |
Definition at line 998 of file openttd.cpp.
void UserErrorI | ( | const std::string & | str | ) |
Error handling for fatal user errors.
str | the string to print. |
Definition at line 112 of file openttd.cpp.
References VideoDriver::GetInstance(), and Driver::Stop().
|
static |
Definition at line 223 of file openttd.cpp.
|
static |
Interval for regular autosaves.
Initialized at zero to disable till settings are loaded.
Referenced by ChangeAutosaveFrequency().
|
extern |
Configuration file of OpenTTD.
Definition at line 60 of file settings.cpp.
Referenced by openttd_main().
bool _request_newgrf_scan = false |
Definition at line 104 of file openttd.cpp.
NewGRFScanCallback* _request_newgrf_scan_callback = nullptr |
Definition at line 105 of file openttd.cpp.
bool _save_config = false |
Definition at line 103 of file openttd.cpp.