OpenTTD
Data Structures | Functions | Variables
openttd.cpp File Reference

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 "fontcache.h"
#include "error.h"
#include "gui.h"
#include "base_media_base.h"
#include "saveload/saveload.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 "date_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 "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_sprite_sorter.h"
#include "linkgraph/linkgraphschedule.h"
#include <stdarg.h>
#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 IncreaseDate ()
 Increases the tick counter, increases date and possibly calls procedures that have to be called daily, monthly or yearly.
 
void DoPaletteAnimations ()
 
void MusicLoop ()
 
void ResetMusic ()
 
void CallWindowTickEvent ()
 Dispatch WE_TICK event over all windows.
 
bool HandleBootstrap ()
 Handle all procedures for bootstrapping OpenTTD without a base graphics set. More...
 
CompanyDoStartupNewCompany (bool is_ai, CompanyID company=INVALID_COMPANY)
 Create a new company and sets all company variables default values. More...
 
void ShowOSErrorBox (const char *buf, bool system)
 
void CDECL usererror (const char *s,...)
 Error handling for fatal user errors. More...
 
void CDECL error (const char *s,...)
 Error handling for fatal non-user errors. More...
 
void CDECL ShowInfoF (const char *str,...)
 Shows some information on the console/a popup box depending on the OS. More...
 
static void ShowHelp ()
 Show the help message when someone passed a wrong parameter.
 
static void WriteSavegameInfo (const char *name)
 
static void ParseResolution (Dimension *res, const char *s)
 Extract the resolution from the given string and store it in the 'res' parameter. More...
 
static void ShutdownGame ()
 Unitializes drivers, frees allocated memory, cleans pools, ... More...
 
static void LoadIntroGame (bool load_newgrfs=true)
 Load the introduction game. More...
 
void MakeNewgameSettingsLive ()
 
void OpenBrowser (const char *url)
 
int openttd_main (int argc, char *argv[])
 Main entry point for this lovely game. More...
 
void HandleExitGameRequest ()
 
static void MakeNewGameDone ()
 
static void MakeNewGame (bool from_heightmap, bool reset_settings)
 
static void MakeNewEditorWorldDone ()
 
static void MakeNewEditorWorld ()
 
bool SafeLoad (const char *filename, SaveLoadOperation fop, DetailedFileType dft, GameMode newgm, Subdirectory subdir, struct LoadFilter *lf=NULL)
 Load the specified savegame but on error do different things. More...
 
void SwitchToMode (SwitchMode new_mode)
 
static void CheckCaches ()
 Check the validity of some of the caches. More...
 
void StateGameLoop ()
 State controlling game loop. More...
 
static void DoAutosave ()
 Create an autosave. More...
 
void GameLoop ()
 

Variables

char * _config_file
 Configuration file of OpenTTD.
 
static const OptionData _options []
 Options of OpenTTD. More...
 

Detailed Description

Functions related to starting OpenTTD.

Definition in file openttd.cpp.

Function Documentation

◆ CheckCaches()

static void CheckCaches ( )
static

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 1191 of file openttd.cpp.

◆ DoAutosave()

static void DoAutosave ( )
static

Create an autosave.

The default name is "autosave#.sav". However with the setting 'keep_all_autosave' the name defaults to company-name + date

Definition at line 1406 of file openttd.cpp.

◆ DoStartupNewCompany()

Company* DoStartupNewCompany ( bool  is_ai,
CompanyID  company = INVALID_COMPANY 
)

Create a new company and sets all company variables default values.

Parameters
is_aiis an AI company?
companyCompanyID to use for the new company
Returns
the company struct

Definition at line 533 of file company_cmd.cpp.

◆ error()

void CDECL error ( const char *  s,
  ... 
)

◆ HandleBootstrap()

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.

Returns
True if a base set exists, otherwise false.

Definition at line 215 of file bootstrap_gui.cpp.

References _network_available, BlitterFactory::GetCurrentBlitter(), and BaseMedia< GraphicsSet >::GetUsedSet().

◆ LoadIntroGame()

static void LoadIntroGame ( bool  load_newgrfs = true)
static

Load the introduction game.

Parameters
load_newgrfsWhether to load the NewGRFs or not.

Definition at line 320 of file openttd.cpp.

◆ openttd_main()

int openttd_main ( int  argc,
char *  argv[] 
)

Main entry point for this lovely game.

Parameters
argcThe number of arguments passed to this game.
argvThe values of the arguments.
Returns
0 when there is no error.

Definition at line 534 of file openttd.cpp.

References AfterNewGRFScan::AfterNewGRFScan(), and AfterNewGRFScan::save_config.

◆ ParseResolution()

static void ParseResolution ( Dimension res,
const char *  s 
)
static

Extract the resolution from the given string and store it in the 'res' parameter.

Parameters
resvariable to store the resolution in.
sthe string to decompose.

Definition at line 266 of file openttd.cpp.

References max(), and ShowInfoF().

◆ SafeLoad()

bool SafeLoad ( const char *  filename,
SaveLoadOperation  fop,
DetailedFileType  dft,
GameMode  newgm,
Subdirectory  subdir,
struct LoadFilter lf = NULL 
)

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.

Parameters
modemode of loading, either SL_LOAD or SL_OLD_LOAD
newgmswitch to this mode of loading fails due to some unknown error
filenamefile to be loaded
subdirdefault directory to look for filename, set to 0 if not needed
lfLoad filter to use, if NULL: use filename + subdir.

Definition at line 1000 of file openttd.cpp.

Referenced by ClientNetworkGameSocketHandler::IsConnected().

◆ ShowInfoF()

void CDECL ShowInfoF ( const char *  str,
  ... 
)

Shows some information on the console/a popup box depending on the OS.

Parameters
strthe text to show.

Definition at line 130 of file openttd.cpp.

References lastof, and vseprintf().

Referenced by GetFontByFaceName(), ParseResolution(), IniFile::ReportFileError(), and SetDebugString().

◆ ShutdownGame()

static void ShutdownGame ( )
static

Unitializes drivers, frees allocated memory, cleans pools, ...

Generally, prepares the game for shutting down

Definition at line 283 of file openttd.cpp.

◆ StateGameLoop()

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 1341 of file openttd.cpp.

References _pause_mode, CallWindowTickEvent(), Game::GameLoop(), HasModalProgress(), PM_UNPAUSED, Layouter::ReduceLineCache(), and UpdateLandscapingLimits().

Referenced by ClientNetworkGameSocketHandler::GameLoop().

◆ usererror()

void CDECL usererror ( const char *  s,
  ... 
)

Error handling for fatal user errors.

Parameters
sthe string to print.
Note
Does NEVER return.

Definition at line 90 of file openttd.cpp.

References lastof, and vseprintf().

Referenced by FioOpenFile(), LoadGrfFile(), LoadGrfFileIndexed(), LoadNextSprite(), DriverFactoryBase::SelectDriver(), and DriverFactoryBase::SelectDriverImpl().

Variable Documentation

◆ _options

const OptionData _options[]
static
Initial value:
= {
}
#define GETOPT_SHORT_OPTVAL(shortname)
Short option with optional value.
Definition: getoptdata.h:106
#define GETOPT_SHORT_VALUE(shortname)
Short option with value.
Definition: getoptdata.h:99
#define GETOPT_SHORT_NOVAL(shortname)
Short option without value.
Definition: getoptdata.h:93

Options of OpenTTD.

Definition at line 497 of file openttd.cpp.