OpenTTD Source: src/genworld.h Source File

OpenTTD Source 12.0-beta1

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
17 enum LandscapeGenerator {
18 /* Order of these enums has to be the same as in lang/english.txt
19 * Otherwise you will get inconsistent behaviour. */
20 LG_ORIGINAL = 0,
21 LG_TERRAGENESIS = 1,
22 };
23
24 static const uint32 GENERATE_NEW_SEED = UINT32_MAX;
25
27 enum GenWorldMode {
28 GWM_NEWGAME = 0,
29 GWM_EMPTY = 1,
30 GWM_RANDOM = 2,
31 GWM_HEIGHTMAP = 3,
32 };
33
35 enum TgenSmoothness {
36 TGEN_SMOOTHNESS_BEGIN,
37 TGEN_SMOOTHNESS_VERY_SMOOTH = TGEN_SMOOTHNESS_BEGIN,
38 TGEN_SMOOTHNESS_SMOOTH,
39 TGEN_SMOOTHNESS_ROUGH,
40 TGEN_SMOOTHNESS_VERY_ROUGH,
41
42 TGEN_SMOOTHNESS_END,
43 };
44
45 static const uint CUSTOM_TERRAIN_TYPE_NUMBER_DIFFICULTY = 5;
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;
60 GenWorldMode mode;
61 CompanyID lc;
62 uint size_x;
63 uint size_y;
64 GWDoneProc *proc;
65 GWAbortProc *abortp;
66 };
67
69 enum GenWorldProgress {
70 GWP_MAP_INIT,
71 GWP_LANDSCAPE,
72 GWP_RIVER,
73 GWP_ROUGH_ROCKY,
74 GWP_TOWN,
75 GWP_INDUSTRY,
76 GWP_OBJECT,
77 GWP_TREE,
78 GWP_GAME_INIT,
79 GWP_RUNTILELOOP,
80 GWP_RUNSCRIPT,
81 GWP_GAME_START,
82 GWP_CLASS_COUNT
83 };
84
85 /* genworld.cpp */
86 void GenerateWorldSetCallback(GWDoneProc *proc);
87 void GenerateWorldSetAbortCallback(GWAbortProc *proc);
88 void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings = true);
89 void AbortGeneratingWorld();
90 bool IsGeneratingWorldAborted();
91 void HandleGeneratingWorldAbortion();
92
93 /* genworld_gui.cpp */
94 void SetNewLandscapeType(byte landscape);
95 void SetGeneratingWorldProgress(GenWorldProgress cls, uint total);
96 void IncreaseGeneratingWorldProgress(GenWorldProgress cls);
97 void PrepareGenerateWorldProgress();
98 void ShowGenerateWorldProgress();
99 void StartNewGameWithoutGUI(uint32 seed);
100 void ShowCreateScenario();
101 void StartScenarioEditor();
102
103 extern bool _generating_world;
104
105 #endif /* GENWORLD_H */
GenWorldInfo::size_y
uint size_y
Y-size of the map.
Definition: genworld.h:63
GWP_GAME_INIT
@ GWP_GAME_INIT
Initialize the game.
Definition: genworld.h:78
ShowGenerateWorldProgress
void ShowGenerateWorldProgress()
Show the window where a user can follow the process of the map generation.
Definition: genworld_gui.cpp:1412
GWP_RUNTILELOOP
@ GWP_RUNTILELOOP
Runs the tile loop 1280 times to make snow etc.
Definition: genworld.h:79
GenWorldInfo::abort
bool abort
Whether to abort the thread ASAP.
Definition: genworld.h:59
GenWorldInfo::lc
CompanyID lc
The local_company before generating.
Definition: genworld.h:61
GenerateWorld
void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings=true)
Generate a world.
Definition: genworld.cpp:272
GenWorldInfo::abortp
GWAbortProc * abortp
Proc that is called when aborting (can be nullptr)
Definition: genworld.h:65
CUSTOM_SEA_LEVEL_MIN_PERCENTAGE
static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE
Minimum percentage a user can specify for custom sea level.
Definition: genworld.h:48
LandscapeGenerator
LandscapeGenerator
Constants related to world generation.
Definition: genworld.h:17
_generating_world
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:61
GenWorldInfo::mode
GenWorldMode mode
What mode are we making a world in.
Definition: genworld.h:60
GenerateWorldSetCallback
void GenerateWorldSetCallback(GWDoneProc *proc)
Set here the function, if any, that you want to be called when landscape generation is done.
Definition: genworld.cpp:220
LG_ORIGINAL
@ LG_ORIGINAL
The original landscape generator.
Definition: genworld.h:20
GWAbortProc
void GWAbortProc()
Called when genworld is aborted.
Definition: genworld.h:55
GWP_INDUSTRY
@ GWP_INDUSTRY
Generate industries.
Definition: genworld.h:75
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
StartScenarioEditor
void StartScenarioEditor()
Start with a scenario editor.
Definition: genworld_gui.cpp:1012
TGEN_SMOOTHNESS_BEGIN
@ TGEN_SMOOTHNESS_BEGIN
First smoothness value.
Definition: genworld.h:36
GENERATE_NEW_SEED
static const uint32 GENERATE_NEW_SEED
Create a new random seed.
Definition: genworld.h:24
IncreaseGeneratingWorldProgress
void IncreaseGeneratingWorldProgress(GenWorldProgress cls)
Increases the current stage of the world generation with one.
Definition: genworld_gui.cpp:1494
GWP_LANDSCAPE
@ GWP_LANDSCAPE
Create the landscape.
Definition: genworld.h:71
GenWorldInfo::proc
GWDoneProc * proc
Proc that is called when done (can be nullptr)
Definition: genworld.h:64
TGEN_SMOOTHNESS_ROUGH
@ TGEN_SMOOTHNESS_ROUGH
Smoothness preset 'rough'.
Definition: genworld.h:39
GWM_HEIGHTMAP
@ GWM_HEIGHTMAP
Generate a newgame from a heightmap.
Definition: genworld.h:31
ShowCreateScenario
void ShowCreateScenario()
Show the window to create a scenario.
Definition: genworld_gui.cpp:1268
GWM_RANDOM
@ GWM_RANDOM
Generate a random map for SE.
Definition: genworld.h:30
CUSTOM_SEA_LEVEL_MAX_PERCENTAGE
static const uint CUSTOM_SEA_LEVEL_MAX_PERCENTAGE
Maximum percentage a user can specify for custom sea level.
Definition: genworld.h:49
MAP_HEIGHT_LIMIT_AUTO_MINIMUM
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
GWP_ROUGH_ROCKY
@ GWP_ROUGH_ROCKY
Make rough and rocky areas.
Definition: genworld.h:73
GWP_GAME_START
@ GWP_GAME_START
Really prepare to start the game.
Definition: genworld.h:81
GWP_OBJECT
@ GWP_OBJECT
Generate objects (radio tower, light houses)
Definition: genworld.h:76
TGEN_SMOOTHNESS_VERY_SMOOTH
@ TGEN_SMOOTHNESS_VERY_SMOOTH
Smoothness preset 'very smooth'.
Definition: genworld.h:37
GWP_MAP_INIT
@ GWP_MAP_INIT
Initialize/allocate the map, start economy.
Definition: genworld.h:70
MAP_HEIGHT_LIMIT_AUTO_CEILING_ROOM
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
StartNewGameWithoutGUI
void StartNewGameWithoutGUI(uint32 seed)
Start a normal game without the GUI.
Definition: genworld_gui.cpp:1021
GenWorldInfo
Properties of current genworld process.
Definition: genworld.h:58
GenWorldProgress
GenWorldProgress
Current stage of world generation process.
Definition: genworld.h:69
TgenSmoothness
TgenSmoothness
Smoothness presets.
Definition: genworld.h:35
TGEN_SMOOTHNESS_END
@ TGEN_SMOOTHNESS_END
Used to iterate.
Definition: genworld.h:42
PrepareGenerateWorldProgress
void PrepareGenerateWorldProgress()
Initializes the progress counters to the starting point.
Definition: genworld_gui.cpp:1400
TGEN_SMOOTHNESS_VERY_ROUGH
@ TGEN_SMOOTHNESS_VERY_ROUGH
Smoothness preset 'very rough'.
Definition: genworld.h:40
SetGeneratingWorldProgress
void SetGeneratingWorldProgress(GenWorldProgress cls, uint total)
Set the total of a stage of the world generation.
Definition: genworld_gui.cpp:1480
SetNewLandscapeType
void SetNewLandscapeType(byte landscape)
Changes landscape type and sets genworld window dirty.
Definition: genworld_gui.cpp:61
CUSTOM_TERRAIN_TYPE_NUMBER_DIFFICULTY
static const uint CUSTOM_TERRAIN_TYPE_NUMBER_DIFFICULTY
Value for custom terrain type in difficulty settings.
Definition: genworld.h:45
GWM_EMPTY
@ GWM_EMPTY
Generate an empty map (sea-level)
Definition: genworld.h:29
LG_TERRAGENESIS
@ LG_TERRAGENESIS
TerraGenesis Perlin landscape generator.
Definition: genworld.h:21
IsGeneratingWorldAborted
bool IsGeneratingWorldAborted()
Is the generation being aborted?
Definition: genworld.cpp:247
GWM_NEWGAME
@ GWM_NEWGAME
Generate a map for a new game.
Definition: genworld.h:28
GenWorldInfo::size_x
uint size_x
X-size of the map.
Definition: genworld.h:62
GWP_RIVER
@ GWP_RIVER
Create the rivers.
Definition: genworld.h:72
GenWorldMode
GenWorldMode
Modes for GenerateWorld.
Definition: genworld.h:27
GWDoneProc
void GWDoneProc()
Procedure called when the genworld process finishes.
Definition: genworld.h:54
HandleGeneratingWorldAbortion
void HandleGeneratingWorldAbortion()
Really handle the abortion, i.e.
Definition: genworld.cpp:255
CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY
static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY
Value for custom sea level in difficulty settings.
Definition: genworld.h:47
GenerateWorldSetAbortCallback
void GenerateWorldSetAbortCallback(GWAbortProc *proc)
Set here the function, if any, that you want to be called when landscape generation is aborted.
Definition: genworld.cpp:230
GWP_TOWN
@ GWP_TOWN
Generate towns.
Definition: genworld.h:74
company_type.h
AbortGeneratingWorld
void AbortGeneratingWorld()
Initializes the abortion process.
Definition: genworld.cpp:238
TGEN_SMOOTHNESS_SMOOTH
@ TGEN_SMOOTHNESS_SMOOTH
Smoothness preset 'smooth'.
Definition: genworld.h:38
GWP_RUNSCRIPT
@ GWP_RUNSCRIPT
Runs the game script at most 2500 times, or when ever the script sleeps.
Definition: genworld.h:80
GWP_TREE
@ GWP_TREE
Generate trees.
Definition: genworld.h:77