Go to the documentation of this file.
1 /* $Id: genworld.cpp 27670 2016-10-30 17:29:33Z frosch $ */
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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 <>.
8  */
12 #include "stdafx.h"
13 #include "landscape.h"
14 #include "company_func.h"
15 #include "genworld.h"
16 #include "gfxinit.h"
17 #include "window_func.h"
18 #include "network/network.h"
19 #include "heightmap.h"
20 #include "viewport_func.h"
21 #include "date_func.h"
22 #include "engine_func.h"
23 #include "water.h"
24 #include "video/video_driver.hpp"
25 #include "tilehighlight_func.h"
26 #include "saveload/saveload.h"
27 #include "void_map.h"
28 #include "town.h"
29 #include "newgrf.h"
30 #include "core/random_func.hpp"
31 #include "core/backup_type.hpp"
32 #include "progress.h"
33 #include "error.h"
34 #include "game/game.hpp"
35 #include "game/game_instance.hpp"
36 #include "string_func.h"
38 #include "safeguards.h"
41 void GenerateClearTile();
42 void GenerateIndustries();
43 void GenerateObjects();
44 void GenerateTrees();
46 void StartupEconomy();
47 void StartupCompanies();
48 void StartupDisasters();
50 void InitializeGame(uint size_x, uint size_y, bool reset_date, bool reset_settings);
68 {
69  return _gw.threaded && !_gw.quit_thread;
70 }
76 static void CleanupGeneration()
77 {
78  _generating_world = false;
80  SetMouseCursorBusy(false);
81  /* Show all vital windows again, because we have hidden them */
82  if (_gw.threaded && _game_mode != GM_MENU) ShowVitalWindows();
83  SetModalProgress(false);
84  _gw.proc = NULL;
85  _gw.abortp = NULL;
86  _gw.threaded = false;
91 }
96 static void _GenerateWorld(void *)
97 {
98  /* Make sure everything is done via OWNER_NONE. */
99  Backup<CompanyByte> _cur_company(_current_company, OWNER_NONE, FILE_LINE);
101  try {
102  _generating_world = true;
104  if (_network_dedicated) DEBUG(net, 1, "Generating map, please wait...");
105  /* Set the Random() seed to generation_seed so we produce the same map with the same seed */
114  /* Must start economy early because of the costs. */
115  StartupEconomy();
117  /* Don't generate landscape items when in the scenario editor. */
118  if (_gw.mode == GWM_EMPTY) {
121  /* Make sure the tiles at the north border are void tiles if needed. */
123  for (uint row = 0; row < MapSizeY(); row++) MakeVoid(TileXY(0, row));
124  for (uint col = 0; col < MapSizeX(); col++) MakeVoid(TileXY(col, 0));
125  }
127  /* Make the map the height of the setting */
130  ConvertGroundTilesIntoWaterTiles();
132  } else {
133  GenerateLandscape(_gw.mode);
134  GenerateClearTile();
136  /* only generate towns, tree and industries in newgame mode. */
137  if (_game_mode != GM_EDITOR) {
139  _cur_company.Restore();
141  return;
142  }
144  GenerateObjects();
145  GenerateTrees();
146  }
147  }
149  /* These are probably pointless when inside the scenario editor. */
153  StartupEngines();
155  StartupDisasters();
156  _generating_world = false;
158  /* No need to run the tile loop in the scenario editor. */
159  if (_gw.mode != GWM_EMPTY) {
160  uint i;
163  for (i = 0; i < 0x500; i++) {
164  RunTileLoop();
165  _tick_counter++;
167  }
169  if (_game_mode != GM_EDITOR) {
170  Game::StartNew();
172  if (Game::GetInstance() != NULL) {
174  _generating_world = true;
175  for (i = 0; i < 2500; i++) {
176  Game::GameLoop();
178  if (Game::GetInstance()->IsSleeping()) break;
179  }
180  _generating_world = false;
181  }
182  }
183  }
188  _cur_company.Trash();
192  /* Call any callback */
193  if (_gw.proc != NULL) _gw.proc();
199  ShowNewGRFError();
201  if (_network_dedicated) DEBUG(net, 1, "Map generated, starting game");
202  DEBUG(desync, 1, "new_map: %08x", _settings_game.game_creation.generation_seed);
204  if (_debug_desync_level > 0) {
205  char name[MAX_PATH];
206  seprintf(name, lastof(name), "dmp_cmds_%08x_%08x.sav", _settings_game.game_creation.generation_seed, _date);
208  }
209  } catch (...) {
211  if (_cur_company.IsValid()) _cur_company.Restore();
212  _generating_world = false;
214  throw;
215  }
216 }
224 {
225  _gw.proc = proc;
226 }
234 {
235  _gw.abortp = proc;
236 }
243 {
244  if (_gw.thread == NULL) return;
248  _gw.quit_thread = true;
249  _gw.thread->Join();
250  delete _gw.thread;
251  _gw.thread = NULL;
252  _gw.threaded = false;
255 }
261 {
262  _gw.abort = true;
263 }
270 {
271  return _gw.abort;
272 }
278 {
279  /* Clean up - in SE create an empty map, otherwise, go to intro menu */
280  _switch_mode = (_game_mode == GM_EDITOR) ? SM_EDITOR : SM_MENU;
282  if (_gw.abortp != NULL) _gw.abortp();
286  if (_gw.thread != NULL) _gw.thread->Exit();
288  SwitchToMode(_switch_mode);
289 }
298 void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings)
299 {
300  if (HasModalProgress()) return;
301  _gw.mode = mode;
302  _gw.size_x = size_x;
303  _gw.size_y = size_y;
304  SetModalProgress(true);
305  _gw.abort = false;
306  _gw.abortp = NULL;
307 = _local_company;
308  _gw.quit_thread = false;
309  _gw.threaded = true;
311  /* This disables some commands and stuff */
314  InitializeGame(_gw.size_x, _gw.size_y, true, reset_settings);
317  /* Load the right landscape stuff, and the NewGRFs! */
318  GfxLoadSprites();
321  /* Re-init the windowing system */
324  /* Create toolbars */
328  if (_gw.thread != NULL) {
329  _gw.thread->Join();
330  delete _gw.thread;
331  _gw.thread = NULL;
332  }
334  if (!VideoDriver::GetInstance()->HasGUI() || !ThreadObject::New(&_GenerateWorld, NULL, &_gw.thread, "ottd:genworld")) {
335  DEBUG(misc, 1, "Cannot create genworld thread, reverting to single-threaded mode");
336  _gw.threaded = false;
338  _GenerateWorld(NULL);
340  return;
341  }
344  /* Remove any open window */
346  /* Hide vital windows, because we don't allow to use them */
349  /* Don't show the dialog if we don't have a thread */
352  /* Centre the view on the map */
353  if (FindWindowById(WC_MAIN_WINDOW, 0) != NULL) {
354  ScrollMainWindowToTile(TileXY(MapSizeX() / 2, MapSizeY() / 2), true);
355  }
356 }
void SetupColoursAndInitialWindow()
Initialise the default colours (remaps and the likes), and load the main windows. ...
Definition: main_gui.cpp:549
void GenerateIndustries()
This function will create random industries during game creation.
void PrepareGenerateWorldProgress()
Initializes the progress counters to the starting point.
static uint MapSizeX()
Get the size of the map along the X.
Definition: map_func.h:74
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
Base of all video drivers.
static uint MapSizeY()
Get the size of the map along the Y.
Definition: map_func.h:84
static void MakeVoid(TileIndex t)
Make a nice void tile ;)
Definition: void_map.h:21
void GWDoneProc()
Procedure called when the genworld process finishes.
Definition: genworld.h:50
static void GameLoop()
Called every game-tick to let Game do something.
Definition: game_core.cpp:32
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1602
EconomySettings economy
settings to change the economy
Generate objects (radio tower, light houses)
Definition: genworld.h:75
Switch to game intro menu.
Definition: openttd.h:32
Functions related to dates.
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:398
Progress report of landscape generation; Window numbers:
Definition: window_type.h:458
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1105
bool IsValid() const
Checks whether the variable was already restored.
Definition: backup_type.hpp:65
uint size_y
Y-size of the map.
Definition: genworld.h:61
Modes for GenerateWorld.
Definition: genworld.h:28
static void _GenerateWorld(void *)
The internal, real, generate function.
Definition: genworld.cpp:96
Initialize/allocate the map, start economy.
Definition: genworld.h:69
GenWorldInfo _gw
Please only use this variable in genworld.h and genworld.cpp and nowhere else.
Definition: genworld.cpp:58
TownLayoutByte town_layout
select town layout,
void ShowGenerateWorldProgress()
Show the window where a user can follow the process of the map generation.
static const uint GENERATE_NEW_SEED
Create a new random seed.
Definition: genworld.h:25
void GenerateTrees()
Place new trees.
Definition: tree_cmd.cpp:300
bool IsGenerateWorldThreaded()
Tells if the world generation is done in a thread or not.
Definition: genworld.cpp:67
GenWorldMode mode
What mode are we making a world in.
Definition: genworld.h:58
bool IsGeneratingWorldAborted()
Is the generation being aborted?
Definition: genworld.cpp:269
bool quit_thread
Do we want to quit the active thread.
Definition: genworld.h:56
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
The client is spectating.
Definition: company_type.h:37
Functions related to world/map generation.
bool GenerateTowns(TownLayout layout)
This function will generate a certain amount of towns, with a certain layout It can be called from th...
Definition: town_cmd.cpp:1949
void AbortGeneratingWorld()
Initializes the abortion process.
Definition: genworld.cpp:260
virtual void EndCritical(bool allow_recursive=false)=0
End of the critical section.
void DeleteAllNonVitalWindows()
It is possible that a stickied window gets to a position where the &#39;close&#39; button is outside the gami...
Definition: window.cpp:3295
byte se_flat_world_height
land height a flat world gets in SE
File is being saved.
Definition: fileio_type.h:52
uint size_x
X-size of the map.
Definition: genworld.h:60
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:59
Class to backup a specific variable and restore it later.
Definition: backup_type.hpp:23
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
ThreadMutex * _modal_progress_work_mutex
Rights for the performing work.
Definition: progress.cpp:21
Functions related to (drawing on) viewports.
Pseudo random number generator.
void GenerateWorldSetAbortCallback(GWAbortProc *proc)
Set here the function, if any, that you want to be called when landscape generation is aborted...
Definition: genworld.cpp:233
bool freeform_edges
allow terraforming the tiles at the map edges
Save game or scenario file.
Definition: fileio_type.h:33
bool abort
Whether to abort the thread ASAP.
Definition: genworld.h:55
Main window; Window numbers:
Definition: window_type.h:46
Functions related to low-level strings.
Functions/types related to saving and loading games.
void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings)
Generate a world.
Definition: genworld.cpp:298
Functions related to errors.
Switch to scenario editor.
Definition: openttd.h:30
void HideVitalWindows()
Delete all always on-top windows to get an empty screen.
Definition: window.cpp:3337
GWDoneProc * proc
Proc that is called when done (can be NULL)
Definition: genworld.h:62
Functions related to engines.
static void SwitchMode(PersistentStorageMode mode, bool ignore_prev_mode=false)
Clear temporary changes made since the last call to SwitchMode, and set whether subsequent changes sh...
Functions related to modal progress.
Definition of base types and functions in a cross-platform compatible way.
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1130
Enter the gameloop, changes will be permanent.
A number of safeguards to prevent using unsafe methods.
void SetLocalCompany(CompanyID new_company)
Sets the local company and updates the settings that are set on a per-company basis to reflect the co...
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition: settings.cpp:78
Subdirectory of save for autosaves.
Definition: fileio_type.h:113
The GameInstance tracks games.
bool threaded
Whether we run _GenerateWorld threaded.
Definition: genworld.h:57
The tile has no ownership.
Definition: company_type.h:27
Properties of current genworld process.
Definition: genworld.h:54
Generate an empty map (sea-level)
Definition: genworld.h:30
Basic functions/variables used all over the place.
void SetSeed(uint32 seed)
(Re)set the state of the random number generator.
Definition: random_func.cpp:57
static class GameInstance * GetInstance()
Get the current active instance.
Definition: game.hpp:113
SaveOrLoadResult SaveOrLoad(const char *filename, SaveLoadOperation fop, DetailedFileType dft, Subdirectory sb, bool threaded)
Main Save or Load function where the high-level saveload functions are handled.
Definition: saveload.cpp:2790
Runs the tile loop 1280 times to make snow etc.
Definition: genworld.h:78
ThreadMutex * _modal_progress_paint_mutex
Rights for the painting.
Definition: progress.cpp:23
void GWAbortProc()
Called when genworld is aborted.
Definition: genworld.h:51
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1150
void StartupCompanies()
Start the next competitor now.
static void StartNew()
Start up a new GameScript.
Definition: game_core.cpp:65
GWAbortProc * abortp
Proc that is called when aborting (can be NULL)
Definition: genworld.h:63
static void CleanupGeneration()
Clean up the &#39;mess&#39; of generation.
Definition: genworld.cpp:76
void WaitTillGeneratedWorld()
This will wait for the thread to finish up his work.
Definition: genworld.cpp:242
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
void StartupEngines()
Start/initialise all our engines.
Definition: engine.cpp:688
Functions related to the graphics initialization.
uint16 _tick_counter
Ever incrementing (and sometimes wrapping) tick counter for setting off various events.
Definition: date.cpp:30
void ShowNewGRFError()
Show the first NewGRF error we can find.
Definition: newgrf_gui.cpp:45
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:357
void GenerateWorldSetCallback(GWDoneProc *proc)
Set here the function, if any, that you want to be called when landscape generation is done...
Definition: genworld.cpp:223
void Trash()
Trash the backup.
virtual void Join()=0
Join this thread.
Functions related to companies.
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:61
Leave the gameloop, changes will be temporary.
uint32 generation_seed
noise seed for world generation
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
Functions related to creating heightmaps from files.
Randomizer _random
Random used in the game state calculations.
Definition: random_func.cpp:27
Map accessors for void tiles.
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Runs the game script at most 2500 times, or when ever the script sleeps.
Definition: genworld.h:79
CompanyID lc
The local_company before generating.
Definition: genworld.h:59
class ThreadObject * thread
The thread we are in (can be NULL)
Definition: genworld.h:64
void FlatEmptyWorld(byte tile_height)
Make an empty world where all tiles are of height &#39;tile_height&#39;.
Definition: heightmap.cpp:512
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:47
Functions related to OTTD&#39;s landscape.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2268
Base functions for all Games.
void SetObjectToPlace(CursorID icon, PaletteID pal, HighLightStyle mode, WindowClass window_class, WindowNumber window_num)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
Definition: viewport.cpp:3166
ConstructionSettings construction
construction of things in-game
void SetModalProgress(bool state)
Set the modal progress state.
Definition: progress.cpp:30
void HandleGeneratingWorldAbortion()
Really handle the abortion, i.e.
Definition: genworld.cpp:277
void Restore()
Restore the variable.
Base of the town class.
void RunTileLoop()
Gradually iterate over all tiles on the map, calling their TileLoopProcs once every 256 ticks...
Definition: landscape.cpp:721
GameCreationSettings game_creation
settings used during the creation of a game (map)
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3211
virtual void BeginCritical(bool allow_recursive=false)=0
Begin the critical section.
Functions related to tile highlights.
void ResetWindowSystem()
Reset the windowing system, by means of shutting it down followed by re-initialization.
Definition: window.cpp:1910
Window functions not directly related to making/drawing windows.
virtual bool Exit()=0
Exit this thread.
void SetGeneratingWorldProgress(GenWorldProgress cls, uint total)
Set the total of a stage of the world generation.
Functions related to water (management)
void GenerateLandscape(byte mode)
Definition: landscape.cpp:1211
void IncreaseGeneratingWorldProgress(GenWorldProgress cls)
Increases the current stage of the world generation with one.
Initialize the game.
Definition: genworld.h:77
Date _date
Current date in days (day counter)
Definition: date.cpp:28
void ShowVitalWindows()
Show the vital in-game windows.
Definition: main_gui.cpp:577
static bool New(OTTDThreadFunc proc, void *param, ThreadObject **thread=NULL, const char *name=NULL)
Create a thread; proc will be called as first function inside the thread, with optional params...
Class for backupping variables and making sure they are restored later.
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:165
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:23
Really prepare to start the game.
Definition: genworld.h:80
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1461
void GfxLoadSprites()
Initialise and load all the sprites.
Definition: gfxinit.cpp:337
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:343
Base for the NewGRF implementation.