OpenTTD
Functions | Variables
genworld.cpp File Reference

Functions to generate a map. More...

#include "stdafx.h"
#include "landscape.h"
#include "company_func.h"
#include "genworld.h"
#include "gfxinit.h"
#include "window_func.h"
#include "network/network.h"
#include "heightmap.h"
#include "viewport_func.h"
#include "date_func.h"
#include "engine_func.h"
#include "water.h"
#include "video/video_driver.hpp"
#include "tilehighlight_func.h"
#include "saveload/saveload.h"
#include "void_map.h"
#include "town.h"
#include "newgrf.h"
#include "core/random_func.hpp"
#include "core/backup_type.hpp"
#include "progress.h"
#include "error.h"
#include "game/game.hpp"
#include "game/game_instance.hpp"
#include "string_func.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

void GenerateClearTile ()
 
void GenerateIndustries ()
 This function will create random industries during game creation. More...
 
void GenerateObjects ()
 
void GenerateTrees ()
 Place new trees. More...
 
void StartupEconomy ()
 
void StartupCompanies ()
 Start the next competitor now. More...
 
void StartupDisasters ()
 
void InitializeGame (uint size_x, uint size_y, bool reset_date, bool reset_settings)
 
bool IsGenerateWorldThreaded ()
 Tells if the world generation is done in a thread or not. More...
 
static void CleanupGeneration ()
 Clean up the 'mess' of generation. More...
 
static void _GenerateWorld (void *)
 The internal, real, generate function.
 
void GenerateWorldSetCallback (GWDoneProc *proc)
 Set here the function, if any, that you want to be called when landscape generation is done. More...
 
void GenerateWorldSetAbortCallback (GWAbortProc *proc)
 Set here the function, if any, that you want to be called when landscape generation is aborted. More...
 
void WaitTillGeneratedWorld ()
 This will wait for the thread to finish up his work. More...
 
void AbortGeneratingWorld ()
 Initializes the abortion process.
 
bool IsGeneratingWorldAborted ()
 Is the generation being aborted? More...
 
void HandleGeneratingWorldAbortion ()
 Really handle the abortion, i.e. More...
 
void GenerateWorld (GenWorldMode mode, uint size_x, uint size_y, bool reset_settings)
 Generate a world. More...
 

Variables

GenWorldInfo _gw
 Please only use this variable in genworld.h and genworld.cpp and nowhere else. More...
 
bool _generating_world
 Whether we are generating the map or not. More...
 

Detailed Description

Functions to generate a map.

Definition in file genworld.cpp.

Function Documentation

◆ CleanupGeneration()

static void CleanupGeneration ( )
static

Clean up the 'mess' of generation.

That is, show windows again, reset thread variables, and delete the progress window.

Definition at line 76 of file genworld.cpp.

References _generating_world, SetMouseCursorBusy(), and GenWorldInfo::threaded.

◆ GenerateIndustries()

void GenerateIndustries ( )

This function will create random industries during game creation.

It will scale the amount of industries by mapsize and difficulty level.

Definition at line 2116 of file industry_cmd.cpp.

◆ GenerateTrees()

void GenerateTrees ( )

Place new trees.

This function takes care of the selected tree placer algorithm and place randomly the trees for a new game.

Definition at line 300 of file tree_cmd.cpp.

References _settings_game, GameSettings::game_creation, GameCreationSettings::landscape, TP_NONE, TP_ORIGINAL, and GameCreationSettings::tree_placer.

◆ GenerateWorld()

void GenerateWorld ( GenWorldMode  mode,
uint  size_x,
uint  size_y,
bool  reset_settings 
)

Generate a world.

Parameters
modeThe mode of world generation (see GenWorldMode).
size_xThe X-size of the map.
size_yThe Y-size of the map.
reset_settingsWhether to reset the game configuration (used for restart)

Definition at line 298 of file genworld.cpp.

References _local_company, GenWorldInfo::abort, GenWorldInfo::abortp, COMPANY_SPECTATOR, HasModalProgress(), GenWorldInfo::lc, GenWorldInfo::mode, GenWorldInfo::quit_thread, SetLocalCompany(), SetModalProgress(), GenWorldInfo::size_x, GenWorldInfo::size_y, and GenWorldInfo::threaded.

◆ GenerateWorldSetAbortCallback()

void GenerateWorldSetAbortCallback ( GWAbortProc proc)

Set here the function, if any, that you want to be called when landscape generation is aborted.

Parameters
proccallback procedure

Definition at line 233 of file genworld.cpp.

References GenWorldInfo::abortp.

Referenced by GenerateTerrainPerlin().

◆ GenerateWorldSetCallback()

void GenerateWorldSetCallback ( GWDoneProc proc)

Set here the function, if any, that you want to be called when landscape generation is done.

Parameters
proccallback procedure

Definition at line 223 of file genworld.cpp.

References GenWorldInfo::proc.

◆ HandleGeneratingWorldAbortion()

void HandleGeneratingWorldAbortion ( )

Really handle the abortion, i.e.

clean up some of the mess

Definition at line 277 of file genworld.cpp.

References _switch_mode.

◆ IsGenerateWorldThreaded()

bool IsGenerateWorldThreaded ( )

Tells if the world generation is done in a thread or not.

Returns
the 'threaded' status

Definition at line 67 of file genworld.cpp.

References GenWorldInfo::quit_thread, and GenWorldInfo::threaded.

◆ IsGeneratingWorldAborted()

bool IsGeneratingWorldAborted ( )

Is the generation being aborted?

Returns
the 'aborted' status

Definition at line 269 of file genworld.cpp.

References GenWorldInfo::abort.

◆ StartupCompanies()

void StartupCompanies ( )

Start the next competitor now.

Definition at line 583 of file company_cmd.cpp.

References _next_competitor_start.

◆ WaitTillGeneratedWorld()

void WaitTillGeneratedWorld ( )

This will wait for the thread to finish up his work.

It will not continue till the work is done.

Definition at line 242 of file genworld.cpp.

References _modal_progress_paint_mutex, _modal_progress_work_mutex, ThreadMutex::BeginCritical(), ThreadMutex::EndCritical(), ThreadObject::Join(), GenWorldInfo::quit_thread, GenWorldInfo::thread, and GenWorldInfo::threaded.

Variable Documentation

◆ _generating_world

bool _generating_world

◆ _gw

Please only use this variable in genworld.h and genworld.cpp and nowhere else.

For speed improvements we need it to be global, but in no way the meaning of it is to use it anywhere else besides in the genworld.h and genworld.cpp!

Definition at line 58 of file genworld.cpp.