Functions to generate a map. More...

#include "stdafx.h"
#include "landscape.h"
#include "company_func.h"
#include "town_cmd.h"
#include "signs_cmd.h"
#include "3rdparty/nlohmann/json.hpp"
#include "strings_func.h"
#include "genworld.h"
#include "gfxinit.h"
#include "window_func.h"
#include "network/network.h"
#include "heightmap.h"
#include "viewport_func.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_tick.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 "newgrf_house.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 "newgrf_railtype.h"
#include "newgrf_roadtype.h"
#include "string_func.h"
#include "thread.h"
#include "tgp.h"
#include "table/strings.h"
#include "safeguards.h"

Data Structures
struct	GenWorldInfo
	Properties of current genworld process. More...

class	AbortGenerateWorldSignal

Functions
void	GenerateClearTile ()

void	GenerateIndustries ()
	This function will create random industries during game creation.

void	GenerateObjects ()

void	GenerateTrees ()
	Place new trees.

void	StartupEconomy ()

void	StartupCompanies ()
	Start of a new game.

void	StartupDisasters ()

void	InitializeGame (uint size_x, uint size_y, bool reset_date, bool reset_settings)

static void	CleanupGeneration ()
	Generation is done; show windows again and delete the progress window.

static void	_GenerateWorld ()
	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.

void	GenerateWorldSetAbortCallback (GWAbortProc *proc)
	Set here the function, if any, that you want to be called when landscape generation is aborted.

void	AbortGeneratingWorld ()
	Initializes the abortion process.

bool	IsGeneratingWorldAborted ()
	Is the generation being aborted?

void	HandleGeneratingWorldAbortion ()
	Really handle the abortion, i.e.

void	GenerateWorld (GenWorldMode mode, uint size_x, uint size_y, bool reset_settings)
	Generate a world.

void	LoadTownData ()
	Load town data from _file_to_saveload, place towns at the appropriate locations, and expand them to their target populations.

Variables
bool	_generating_world
	Whether we are generating the map or not.

Detailed Description

Functions to generate a map.

Definition in file genworld.cpp.

Function Documentation

◆ _GenerateWorld()

static void _GenerateWorld ( )

static

The internal, real, generate function.

Definition at line 98 of file genworld.cpp.

References _current_company, _generating_world, _local_company, _network_dedicated, _random, _settings_game, _switch_mode, AUTOSAVE_DIR, CheckTownRoadTypes(), CleanupGeneration(), GameSettings::construction, TimerGameTick::counter, TimerGameEconomy::date, Debug, DEF_SNOWLINE_HEIGHT, DFT_GAME_FILE, GameSettings::economy, FlatEmptyWorld(), ConstructionSettings::freeform_edges, GameSettings::game_creation, Game::GameLoop(), GenerateIndustries(), GenerateLandscape(), GenerateTowns(), GenerateTrees(), GameCreationSettings::generation_seed, Game::GetInstance(), GWM_EMPTY, GWP_GAME_INIT, GWP_GAME_START, GWP_MAP_INIT, GWP_OBJECT, GWP_RUNSCRIPT, GWP_RUNTILELOOP, HandleGeneratingWorldAbortion(), HT_NONE, IncreaseGeneratingWorldProgress(), Backup< T >::IsValid(), GenWorldInfo::lc, MakeVoid(), GenWorldInfo::mode, OWNER_NONE, GenWorldInfo::proc, PSM_ENTER_GAMELOOP, PSM_LEAVE_GAMELOOP, ResetObjectToPlace(), Backup< T >::Restore(), RunTileLoop(), SaveOrLoad(), GameCreationSettings::se_flat_world_height, SetGeneratingWorldProgress(), SetObjectToPlace(), Randomizer::SetSeed(), ShowNewGRFError(), ShowVitalWindows(), Map::SizeX(), Map::SizeY(), SLO_SAVE, GameCreationSettings::snow_line_height, Game::StartNew(), StartupCompanies(), StartupEngines(), BasePersistentStorageArray::SwitchMode(), TileXY(), EconomySettings::town_layout, Backup< T >::Trash(), and WC_MAIN_WINDOW.

Referenced by GenerateWorld().

◆ AbortGeneratingWorld()

void AbortGeneratingWorld ( )

Initializes the abortion process.

Definition at line 261 of file genworld.cpp.

References GenWorldInfo::abort.

◆ CleanupGeneration()

static void CleanupGeneration ( )

static

Generation is done; show windows again and delete the progress window.

Definition at line 81 of file genworld.cpp.

References _generating_world, GenWorldInfo::abortp, CloseWindowByClass(), MarkWholeScreenDirty(), GenWorldInfo::proc, SetModalProgress(), SetMouseCursorBusy(), ShowFirstError(), and WC_MODAL_PROGRESS.

Referenced by _GenerateWorld().

◆ GenerateClearTile()

void GenerateClearTile ( )

Definition at line 316 of file clear_cmd.cpp.

◆ 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 2481 of file industry_cmd.cpp.

References _industry_builder, _settings_game, GameSettings::difficulty, GetNumberOfIndustries(), GetScaledProbabilities(), GWP_LAND_INDUSTRY, GWP_WATER_INDUSTRY, ID_CUSTOM, ID_FUND_ONLY, DifficultySettings::industry_density, NUM_INDUSTRYTYPES, PlaceInitialIndustry(), RandomRange(), IndustryBuildData::Reset(), Map::ScaleByLandProportion(), and SetGeneratingWorldProgress().

Referenced by _GenerateWorld().

◆ GenerateObjects()

void GenerateObjects ( )

Definition at line 805 of file object_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 476 of file tree_cmd.cpp.

References _settings_game, DEFAULT_RAINFOREST_TREE_STEPS, DEFAULT_TREE_STEPS, GameSettings::game_creation, GB(), GWP_TREE, GameCreationSettings::landscape, PlaceTreeGroups(), PlaceTreesRandomly(), Random, Map::ScaleBySize(), SetGeneratingWorldProgress(), TP_IMPROVED, TP_NONE, TP_ORIGINAL, and GameCreationSettings::tree_placer.

Referenced by _GenerateWorld().

◆ GenerateWorld()

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

Generate a world.

Parameters

mode	The mode of world generation (see GenWorldMode).
size_x	The X-size of the map.
size_y	The Y-size of the map.
reset_settings	Whether to reset the game configuration (used for restart)

Definition at line 295 of file genworld.cpp.

References _GenerateWorld(), _local_company, _settings_game, GenWorldInfo::abort, GenWorldInfo::abortp, CloseAllNonVitalWindows(), COMPANY_SPECTATOR, GameSettings::construction, GameSettings::game_creation, GENERATE_NEW_SEED, GameCreationSettings::generation_seed, GetEstimationTGPMapHeight(), GfxLoadSprites(), GWM_EMPTY, GWM_HEIGHTMAP, HasModalProgress(), GameCreationSettings::heightmap_height, HideVitalWindows(), HT_NONE, InitializeBuildingCounts(), GameCreationSettings::land_generator, GenWorldInfo::lc, LG_TERRAGENESIS, LoadStringWidthTable(), ConstructionSettings::map_height_limit, MAP_HEIGHT_LIMIT_AUTO_CEILING_ROOM, MAP_HEIGHT_LIMIT_AUTO_MINIMUM, MAX_MAP_HEIGHT_LIMIT, GenWorldInfo::mode, PrepareGenerateWorldProgress(), ResetWindowSystem(), ScrollMainWindowToTile(), GameCreationSettings::se_flat_world_height, SetCurrentRailTypeLabelList(), SetCurrentRoadTypeLabelList(), SetLocalCompany(), SetModalProgress(), SetObjectToPlace(), SetupColoursAndInitialWindow(), ShowGenerateWorldProgress(), GenWorldInfo::size_x, GenWorldInfo::size_y, Map::SizeX(), Map::SizeY(), TileXY(), UnshowCriticalError(), and WC_MAIN_WINDOW.