OpenTTD Source  20241108-master-g80f628063a
genworld.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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 <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef GENWORLD_H
11 #define GENWORLD_H
12 
13 #include "company_type.h"
14 #include <thread>
15 
18  /* Order of these enums has to be the same as in lang/english.txt
19  * Otherwise you will get inconsistent behaviour. */
22 };
23 
24 static const uint32_t GENERATE_NEW_SEED = UINT32_MAX;
25 
29  GWM_EMPTY = 1,
30  GWM_RANDOM = 2,
32 };
33 
41 
43 };
44 
46 
47 static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY = 4;
48 static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE = 1;
49 static const uint CUSTOM_SEA_LEVEL_MAX_PERCENTAGE = 90;
50 
51 static const uint MAP_HEIGHT_LIMIT_AUTO_MINIMUM = 30;
52 static const uint MAP_HEIGHT_LIMIT_AUTO_CEILING_ROOM = 15;
53 
54 typedef void GWDoneProc();
55 typedef void GWAbortProc();
56 
58 struct GenWorldInfo {
59  bool abort;
62  uint size_x;
63  uint size_y;
66 };
67 
82  GWP_CLASS_COUNT
83 };
84 
85 /* genworld.cpp */
88 void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings = true);
92 void LoadTownData();
93 
94 /* genworld_gui.cpp */
95 void SetNewLandscapeType(uint8_t landscape);
96 void SetGeneratingWorldProgress(GenWorldProgress cls, uint total);
100 void StartNewGameWithoutGUI(uint32_t seed);
101 void ShowCreateScenario();
102 void StartScenarioEditor();
103 
104 extern bool _generating_world;
105 
106 #endif /* GENWORLD_H */
Types related to companies.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
void GWAbortProc()
Called when genworld is aborted.
Definition: genworld.h:55
void IncreaseGeneratingWorldProgress(GenWorldProgress cls)
Increases the current stage of the world generation with one.
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:67
static const uint MAP_HEIGHT_LIMIT_AUTO_MINIMUM
When map height limit is auto, make this the lowest possible map height limit.
Definition: genworld.h:51
void GenerateWorldSetCallback(GWDoneProc *proc)
Set here the function, if any, that you want to be called when landscape generation is done.
Definition: genworld.cpp:234
static const uint CUSTOM_SEA_LEVEL_MAX_PERCENTAGE
Maximum percentage a user can specify for custom sea level.
Definition: genworld.h:49
void GenerateWorldSetAbortCallback(GWAbortProc *proc)
Set here the function, if any, that you want to be called when landscape generation is aborted.
Definition: genworld.cpp:244
void ShowGenerateWorldProgress()
Show the window where a user can follow the process of the map generation.
void SetNewLandscapeType(uint8_t landscape)
Changes landscape type and sets genworld window dirty.
void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings=true)
Generate a world.
Definition: genworld.cpp:286
GenWorldMode
Modes for GenerateWorld.
Definition: genworld.h:27
@ GWM_HEIGHTMAP
Generate a newgame from a heightmap.
Definition: genworld.h:31
@ GWM_EMPTY
Generate an empty map (sea-level)
Definition: genworld.h:29
@ GWM_RANDOM
Generate a random map for SE.
Definition: genworld.h:30
@ GWM_NEWGAME
Generate a map for a new game.
Definition: genworld.h:28
void HandleGeneratingWorldAbortion()
Really handle the abortion, i.e.
Definition: genworld.cpp:269
static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY
Value for custom sea level in difficulty settings.
Definition: genworld.h:47
void ShowCreateScenario()
Show the window to create a scenario.
static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE
Minimum percentage a user can specify for custom sea level.
Definition: genworld.h:48
GenWorldProgress
Current stage of world generation process.
Definition: genworld.h:69
@ GWP_TREE
Generate trees.
Definition: genworld.h:77
@ GWP_ROUGH_ROCKY
Make rough and rocky areas.
Definition: genworld.h:73
@ GWP_OBJECT
Generate objects (radio tower, light houses)
Definition: genworld.h:76
@ GWP_MAP_INIT
Initialize/allocate the map, start economy.
Definition: genworld.h:70
@ GWP_TOWN
Generate towns.
Definition: genworld.h:74
@ GWP_RUNSCRIPT
Runs the game script at most 2500 times, or when ever the script sleeps.
Definition: genworld.h:80
@ GWP_GAME_START
Really prepare to start the game.
Definition: genworld.h:81
@ GWP_INDUSTRY
Generate industries.
Definition: genworld.h:75
@ GWP_LANDSCAPE
Create the landscape.
Definition: genworld.h:71
@ GWP_GAME_INIT
Initialize the game.
Definition: genworld.h:78
@ GWP_RIVER
Create the rivers.
Definition: genworld.h:72
@ GWP_RUNTILELOOP
Runs the tile loop 1280 times to make snow etc.
Definition: genworld.h:79
void GWDoneProc()
Procedure called when the genworld process finishes.
Definition: genworld.h:54
static const uint MAP_HEIGHT_LIMIT_AUTO_CEILING_ROOM
When map height limit is auto, the map height limit will be the higest peak plus this value.
Definition: genworld.h:52
static const uint32_t GENERATE_NEW_SEED
Create a new random seed.
Definition: genworld.h:24
void AbortGeneratingWorld()
Initializes the abortion process.
Definition: genworld.cpp:252
bool IsGeneratingWorldAborted()
Is the generation being aborted?
Definition: genworld.cpp:261
void StartScenarioEditor()
Start with a scenario editor.
static const uint CUSTOM_TERRAIN_TYPE_NUMBER_DIFFICULTY
Value for custom terrain type in difficulty settings.
Definition: genworld.h:45
void SetGeneratingWorldProgress(GenWorldProgress cls, uint total)
Set the total of a stage of the world generation.
void PrepareGenerateWorldProgress()
Initializes the progress counters to the starting point.
void LoadTownData()
Load town data from _file_to_saveload, place towns at the appropriate locations, and expand them to t...
Definition: genworld.cpp:379
LandscapeGenerator
Constants related to world generation.
Definition: genworld.h:17
@ LG_ORIGINAL
The original landscape generator.
Definition: genworld.h:20
@ LG_TERRAGENESIS
TerraGenesis Perlin landscape generator.
Definition: genworld.h:21
void StartNewGameWithoutGUI(uint32_t seed)
Start a normal game without the GUI.
TgenSmoothness
Smoothness presets.
Definition: genworld.h:35
@ TGEN_SMOOTHNESS_BEGIN
First smoothness value.
Definition: genworld.h:36
@ TGEN_SMOOTHNESS_ROUGH
Smoothness preset 'rough'.
Definition: genworld.h:39
@ TGEN_SMOOTHNESS_VERY_SMOOTH
Smoothness preset 'very smooth'.
Definition: genworld.h:37
@ TGEN_SMOOTHNESS_VERY_ROUGH
Smoothness preset 'very rough'.
Definition: genworld.h:40
@ TGEN_SMOOTHNESS_SMOOTH
Smoothness preset 'smooth'.
Definition: genworld.h:38
@ TGEN_SMOOTHNESS_END
Used to iterate.
Definition: genworld.h:42
Properties of current genworld process.
Definition: genworld.h:58
GWDoneProc * proc
Proc that is called when done (can be nullptr)
Definition: genworld.h:64
CompanyID lc
The local_company before generating.
Definition: genworld.h:61
uint size_x
X-size of the map.
Definition: genworld.h:62
uint size_y
Y-size of the map.
Definition: genworld.h:63
bool abort
Whether to abort the thread ASAP.
Definition: genworld.h:59
GWAbortProc * abortp
Proc that is called when aborting (can be nullptr)
Definition: genworld.h:65
GenWorldMode mode
What mode are we making a world in.
Definition: genworld.h:60