Change: Only resort town directory window on population change if necessary
[openttd-github.git] / src / genworld_gui.cpp
blob154097e722f06b35ea7b761e2bc444850dd69af1
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 */
8 /** @file genworld_gui.cpp GUI to configure and show progress during map generation. */
10 #include "stdafx.h"
11 #include "heightmap.h"
12 #include "debug.h"
13 #include "genworld.h"
14 #include "network/network.h"
15 #include "strings_func.h"
16 #include "window_func.h"
17 #include "date_func.h"
18 #include "sound_func.h"
19 #include "fios.h"
20 #include "string_func.h"
21 #include "widgets/dropdown_type.h"
22 #include "widgets/dropdown_func.h"
23 #include "querystring_gui.h"
24 #include "town.h"
25 #include "core/geometry_func.hpp"
26 #include "core/random_func.hpp"
27 #include "saveload/saveload.h"
28 #include "progress.h"
29 #include "error.h"
31 #include "widgets/genworld_widget.h"
33 #include "safeguards.h"
36 extern void MakeNewgameSettingsLive();
38 /** Enum for the modes we can generate in. */
39 enum GenerateLandscapeWindowMode {
40 GLWM_GENERATE, ///< Generate new game.
41 GLWM_HEIGHTMAP, ///< Load from heightmap.
42 GLWM_SCENARIO, ///< Generate flat land.
45 /**
46 * Changes landscape type and sets genworld window dirty
47 * @param landscape new landscape type
49 void SetNewLandscapeType(byte landscape)
51 _settings_newgame.game_creation.landscape = landscape;
52 InvalidateWindowClassesData(WC_SELECT_GAME);
53 InvalidateWindowClassesData(WC_GENERATE_LANDSCAPE);
56 /** Widgets of GenerateLandscapeWindow when generating world */
57 static const NWidgetPart _nested_generate_landscape_widgets[] = {
58 NWidget(NWID_HORIZONTAL),
59 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
60 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MAPGEN_WORLD_GENERATION_CAPTION, STR_NULL),
61 EndContainer(),
62 NWidget(WWT_PANEL, COLOUR_BROWN),
63 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
64 /* Landscape selection. */
65 NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 10),
66 NWidget(NWID_SPACER), SetFill(1, 0),
67 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
68 NWidget(NWID_SPACER), SetFill(1, 0),
69 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
70 NWidget(NWID_SPACER), SetFill(1, 0),
71 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
72 NWidget(NWID_SPACER), SetFill(1, 0),
73 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
74 NWidget(NWID_SPACER), SetFill(1, 0),
75 EndContainer(),
76 NWidget(NWID_SPACER), SetMinimalSize(0, 11),
77 NWidget(NWID_HORIZONTAL), SetPIP(10, 5, 10),
78 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
79 /* Left column with labels. */
80 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
81 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 1),
82 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_LAND_GENERATOR, STR_NULL), SetFill(1, 1),
83 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_TOWNS, STR_NULL), SetFill(1, 1),
84 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_TERRAIN_TYPE, STR_NULL), SetFill(1, 1),
85 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_VARIETY, STR_NULL), SetFill(1, 1),
86 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_SEA_LAKES, STR_NULL), SetFill(1, 1),
87 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_TREE_PLACER, STR_NULL), SetFill(1, 1),
88 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BORDER_TYPE, STR_NULL), SetFill(1, 1),
89 EndContainer(),
90 /* Widgets at the right of the labels. */
91 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
92 /* Mapsize X * Y. */
93 NWidget(NWID_HORIZONTAL), SetPIP(0, 4, 0),
94 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 0),
95 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(1, 1),
96 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 0),
97 EndContainer(),
98 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_LANDSCAPE_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
99 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
100 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TERRAIN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
101 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_VARIETY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
102 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_WATER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
103 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TREE_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
104 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_BORDERS_RANDOM), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
105 EndContainer(),
106 EndContainer(),
107 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
108 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
109 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
110 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAX_HEIGHTLEVEL, STR_NULL), SetFill(1, 1),
111 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SNOW_LINE_HEIGHT, STR_NULL), SetFill(1, 1),
112 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetFill(1, 1),
113 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_INDUSTRIES, STR_NULL), SetFill(1, 1),
114 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SMOOTHNESS, STR_NULL), SetFill(1, 1),
115 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_RIVERS, STR_NULL), SetFill(1, 1),
116 EndContainer(),
117 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
118 /* Max. heightlevel. */
119 NWidget(NWID_HORIZONTAL),
120 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_MAX_HEIGHTLEVEL_DOWN), SetFill(0, 1),
121 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
122 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_MAX_HEIGHTLEVEL_UP), SetFill(0, 1),
123 EndContainer(),
124 /* Snow line. */
125 NWidget(NWID_HORIZONTAL),
126 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_SNOW_LINE_DOWN), SetFill(0, 1),
127 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
128 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_SNOW_LINE_UP), SetFill(0, 1),
129 EndContainer(),
130 /* Starting date. */
131 NWidget(NWID_HORIZONTAL),
132 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_START_DATE_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_BACKWARD), SetFill(0, 1),
133 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_GL_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL), SetFill(1, 0),
134 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_START_DATE_UP), SetDataTip(SPR_ARROW_UP, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_FORWARD), SetFill(0, 1),
135 EndContainer(),
136 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_INDUSTRY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
137 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_SMOOTHNESS_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
138 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_RIVER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
139 EndContainer(),
140 EndContainer(),
141 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_GL_GENERATE_BUTTON), SetMinimalSize(84, 0), SetDataTip(STR_MAPGEN_GENERATE, STR_NULL), SetFill(1, 1),
142 EndContainer(),
143 EndContainer(),
144 NWidget(NWID_SPACER), SetMinimalSize(0, 4),
145 /* Map borders buttons for each edge. */
146 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
147 NWidget(NWID_HORIZONTAL), SetPIP(0, 0, 3),
148 NWidget(NWID_SPACER), SetFill(1, 1),
149 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NORTHWEST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
150 EndContainer(),
151 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_NW), SetDataTip(STR_JUST_STRING, STR_MAPGEN_NORTHWEST), SetFill(1, 1),
152 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_NE), SetDataTip(STR_JUST_STRING, STR_MAPGEN_NORTHEAST), SetFill(1, 1),
153 NWidget(NWID_HORIZONTAL), SetPIP(3, 0, 0),
154 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NORTHEAST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
155 NWidget(NWID_SPACER), SetFill(1, 1),
156 EndContainer(),
157 EndContainer(),
158 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
159 NWidget(NWID_HORIZONTAL), SetPIP(0, 0, 3),
160 NWidget(NWID_SPACER), SetFill(1, 1),
161 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SOUTHWEST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
162 EndContainer(),
163 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_SW), SetDataTip(STR_JUST_STRING, STR_MAPGEN_SOUTHWEST), SetFill(1, 1),
164 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_SE), SetDataTip(STR_JUST_STRING, STR_MAPGEN_SOUTHEAST), SetFill(1, 1),
165 NWidget(NWID_HORIZONTAL), SetPIP(3, 0, 0),
166 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SOUTHEAST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
167 NWidget(NWID_SPACER), SetFill(1, 1),
168 EndContainer(),
169 EndContainer(),
170 NWidget(NWID_SPACER), SetMinimalSize(0, 9), SetFill(1, 1),
171 EndContainer(),
174 /** Widgets of GenerateLandscapeWindow when loading heightmap */
175 static const NWidgetPart _nested_heightmap_load_widgets[] = {
176 /* Window header. */
177 NWidget(NWID_HORIZONTAL),
178 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
179 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MAPGEN_WORLD_GENERATION_CAPTION, STR_NULL),
180 EndContainer(),
181 NWidget(WWT_PANEL, COLOUR_BROWN),
182 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
183 /* Landscape selection. */
184 NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 10),
185 NWidget(NWID_SPACER), SetFill(1, 0),
186 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
187 NWidget(NWID_SPACER), SetFill(1, 0),
188 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
189 NWidget(NWID_SPACER), SetFill(1, 0),
190 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
191 NWidget(NWID_SPACER), SetFill(1, 0),
192 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
193 NWidget(NWID_SPACER), SetFill(1, 0),
194 EndContainer(),
195 NWidget(NWID_SPACER), SetMinimalSize(0, 11), SetFill(0, 1),
196 NWidget(NWID_HORIZONTAL), SetPIP(10, 3, 10),
197 /* Labels at the left side. */
198 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
199 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_NAME, STR_NULL), SetFill(1, 1),
200 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_NULL), SetFill(1, 1),
201 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_ROTATION, STR_NULL), SetFill(1, 1),
202 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_TOWNS, STR_NULL), SetFill(1, 1),
203 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_INDUSTRIES, STR_NULL), SetFill(1, 1),
204 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_RIVERS, STR_NULL), SetFill(1, 1),
205 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_TREE_PLACER, STR_NULL), SetFill(1, 1),
206 EndContainer(),
207 /* Widgets at the right of the labels. */
208 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
209 NWidget(WWT_EMPTY, COLOUR_ORANGE, WID_GL_HEIGHTMAP_NAME_TEXT), SetFill(1, 0),
210 NWidget(NWID_HORIZONTAL), SetPIP(0, 5, 0),
211 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
212 /* Mapsize X * Y. */
213 NWidget(NWID_HORIZONTAL), SetPIP(0, 4, 0),
214 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetFill(1, 0),
215 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(1, 1),
216 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetFill(1, 0),
217 EndContainer(),
218 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_HEIGHTMAP_ROTATION_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
219 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
220 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_INDUSTRY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
221 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_RIVER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
222 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TREE_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
223 EndContainer(),
224 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
225 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
226 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
227 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_SIZE_LABEL, STR_NULL), SetFill(1, 1),
228 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SNOW_LINE_HEIGHT, STR_NULL), SetFill(1, 1),
229 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAX_HEIGHTLEVEL, STR_NULL), SetFill(1, 1),
230 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetFill(1, 1),
231 EndContainer(),
232 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
233 NWidget(WWT_TEXT, COLOUR_ORANGE, WID_GL_HEIGHTMAP_SIZE_TEXT), SetDataTip(STR_MAPGEN_HEIGHTMAP_SIZE, STR_NULL), SetFill(1, 0),
234 NWidget(NWID_HORIZONTAL),
235 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_SNOW_LINE_DOWN), SetFill(0, 1),
236 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
237 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_SNOW_LINE_UP), SetFill(0, 1),
238 EndContainer(),
239 NWidget(NWID_HORIZONTAL),
240 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_MAX_HEIGHTLEVEL_DOWN), SetFill(0, 1),
241 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
242 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_MAX_HEIGHTLEVEL_UP), SetFill(0, 1),
243 EndContainer(),
244 NWidget(NWID_HORIZONTAL),
245 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_START_DATE_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_BACKWARD), SetFill(0, 1),
246 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_GL_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL), SetFill(1, 0),
247 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_START_DATE_UP), SetDataTip(SPR_ARROW_UP, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_FORWARD), SetFill(0, 1),
248 EndContainer(),
249 EndContainer(),
250 EndContainer(),
251 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_GL_GENERATE_BUTTON), SetMinimalSize(84, 0), SetDataTip(STR_MAPGEN_GENERATE, STR_NULL), SetFill(1, 1),
252 EndContainer(),
253 EndContainer(),
254 EndContainer(),
255 EndContainer(),
256 NWidget(NWID_SPACER), SetMinimalSize(0, 9), SetFill(1, 1),
257 EndContainer(),
260 static void StartGeneratingLandscape(GenerateLandscapeWindowMode mode)
262 DeleteAllNonVitalWindows();
263 ClearErrorMessages();
265 /* Copy all XXX_newgame to XXX when coming from outside the editor */
266 MakeNewgameSettingsLive();
267 ResetGRFConfig(true);
269 if (_settings_client.sound.confirm) SndPlayFx(SND_15_BEEP);
270 switch (mode) {
271 case GLWM_GENERATE: _switch_mode = (_game_mode == GM_EDITOR) ? SM_GENRANDLAND : SM_NEWGAME; break;
272 case GLWM_HEIGHTMAP: _switch_mode = (_game_mode == GM_EDITOR) ? SM_LOAD_HEIGHTMAP : SM_START_HEIGHTMAP; break;
273 case GLWM_SCENARIO: _switch_mode = SM_EDITOR; break;
274 default: NOT_REACHED();
278 static void LandscapeGenerationCallback(Window *w, bool confirmed)
280 if (confirmed) StartGeneratingLandscape((GenerateLandscapeWindowMode)w->window_number);
283 static DropDownList BuildMapsizeDropDown()
285 DropDownList list;
287 for (uint i = MIN_MAP_SIZE_BITS; i <= MAX_MAP_SIZE_BITS; i++) {
288 DropDownListParamStringItem *item = new DropDownListParamStringItem(STR_JUST_INT, i, false);
289 item->SetParam(0, 1LL << i);
290 list.emplace_back(item);
293 return list;
296 static const StringID _elevations[] = {STR_TERRAIN_TYPE_VERY_FLAT, STR_TERRAIN_TYPE_FLAT, STR_TERRAIN_TYPE_HILLY, STR_TERRAIN_TYPE_MOUNTAINOUS, STR_TERRAIN_TYPE_ALPINIST, INVALID_STRING_ID};
297 static const StringID _sea_lakes[] = {STR_SEA_LEVEL_VERY_LOW, STR_SEA_LEVEL_LOW, STR_SEA_LEVEL_MEDIUM, STR_SEA_LEVEL_HIGH, STR_SEA_LEVEL_CUSTOM, INVALID_STRING_ID};
298 static const StringID _rivers[] = {STR_RIVERS_NONE, STR_RIVERS_FEW, STR_RIVERS_MODERATE, STR_RIVERS_LOT, INVALID_STRING_ID};
299 static const StringID _smoothness[] = {STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_VERY_SMOOTH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_SMOOTH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_ROUGH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_VERY_ROUGH, INVALID_STRING_ID};
300 static const StringID _tree_placer[] = {STR_CONFIG_SETTING_TREE_PLACER_NONE, STR_CONFIG_SETTING_TREE_PLACER_ORIGINAL, STR_CONFIG_SETTING_TREE_PLACER_IMPROVED, INVALID_STRING_ID};
301 static const StringID _rotation[] = {STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_COUNTER_CLOCKWISE, STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_CLOCKWISE, INVALID_STRING_ID};
302 static const StringID _landscape[] = {STR_CONFIG_SETTING_LAND_GENERATOR_ORIGINAL, STR_CONFIG_SETTING_LAND_GENERATOR_TERRA_GENESIS, INVALID_STRING_ID};
303 static const StringID _num_towns[] = {STR_NUM_VERY_LOW, STR_NUM_LOW, STR_NUM_NORMAL, STR_NUM_HIGH, STR_NUM_CUSTOM, INVALID_STRING_ID};
304 static const StringID _num_inds[] = {STR_FUNDING_ONLY, STR_MINIMAL, STR_NUM_VERY_LOW, STR_NUM_LOW, STR_NUM_NORMAL, STR_NUM_HIGH, INVALID_STRING_ID};
305 static const StringID _variety[] = {STR_VARIETY_NONE, STR_VARIETY_VERY_LOW, STR_VARIETY_LOW, STR_VARIETY_MEDIUM, STR_VARIETY_HIGH, STR_VARIETY_VERY_HIGH, INVALID_STRING_ID};
307 assert_compile(lengthof(_num_inds) == ID_END + 1);
309 struct GenerateLandscapeWindow : public Window {
310 uint widget_id;
311 uint x;
312 uint y;
313 char name[64];
314 GenerateLandscapeWindowMode mode;
316 GenerateLandscapeWindow(WindowDesc *desc, WindowNumber number = 0) : Window(desc)
318 this->InitNested(number);
320 this->LowerWidget(_settings_newgame.game_creation.landscape + WID_GL_TEMPERATE);
322 this->mode = (GenerateLandscapeWindowMode)this->window_number;
324 /* Disable town, industry and trees in SE */
325 this->SetWidgetDisabledState(WID_GL_TOWN_PULLDOWN, _game_mode == GM_EDITOR);
326 this->SetWidgetDisabledState(WID_GL_INDUSTRY_PULLDOWN, _game_mode == GM_EDITOR);
327 this->SetWidgetDisabledState(WID_GL_TREE_PULLDOWN, _game_mode == GM_EDITOR);
329 this->OnInvalidateData();
333 void SetStringParameters(int widget) const override
335 switch (widget) {
336 case WID_GL_START_DATE_TEXT: SetDParam(0, ConvertYMDToDate(_settings_newgame.game_creation.starting_year, 0, 1)); break;
337 case WID_GL_MAPSIZE_X_PULLDOWN: SetDParam(0, 1LL << _settings_newgame.game_creation.map_x); break;
338 case WID_GL_MAPSIZE_Y_PULLDOWN: SetDParam(0, 1LL << _settings_newgame.game_creation.map_y); break;
339 case WID_GL_MAX_HEIGHTLEVEL_TEXT: SetDParam(0, _settings_newgame.construction.max_heightlevel); break;
340 case WID_GL_SNOW_LEVEL_TEXT: SetDParam(0, _settings_newgame.game_creation.snow_line_height); break;
342 case WID_GL_TOWN_PULLDOWN:
343 if (_game_mode == GM_EDITOR) {
344 SetDParam(0, STR_CONFIG_SETTING_OFF);
345 } else if (_settings_newgame.difficulty.number_towns == CUSTOM_TOWN_NUMBER_DIFFICULTY) {
346 SetDParam(0, STR_NUM_CUSTOM_NUMBER);
347 SetDParam(1, _settings_newgame.game_creation.custom_town_number);
348 } else {
349 SetDParam(0, _num_towns[_settings_newgame.difficulty.number_towns]);
351 break;
353 case WID_GL_INDUSTRY_PULLDOWN: SetDParam(0, _game_mode == GM_EDITOR ? STR_CONFIG_SETTING_OFF : _num_inds[_settings_newgame.difficulty.industry_density]); break;
354 case WID_GL_LANDSCAPE_PULLDOWN: SetDParam(0, _landscape[_settings_newgame.game_creation.land_generator]); break;
355 case WID_GL_TREE_PULLDOWN: SetDParam(0, _tree_placer[_settings_newgame.game_creation.tree_placer]); break;
356 case WID_GL_TERRAIN_PULLDOWN: SetDParam(0, _elevations[_settings_newgame.difficulty.terrain_type]); break;
358 case WID_GL_WATER_PULLDOWN:
359 if (_settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
360 SetDParam(0, STR_SEA_LEVEL_CUSTOM_PERCENTAGE);
361 SetDParam(1, _settings_newgame.game_creation.custom_sea_level);
362 } else {
363 SetDParam(0, _sea_lakes[_settings_newgame.difficulty.quantity_sea_lakes]);
365 break;
367 case WID_GL_RIVER_PULLDOWN: SetDParam(0, _rivers[_settings_newgame.game_creation.amount_of_rivers]); break;
368 case WID_GL_SMOOTHNESS_PULLDOWN: SetDParam(0, _smoothness[_settings_newgame.game_creation.tgen_smoothness]); break;
369 case WID_GL_VARIETY_PULLDOWN: SetDParam(0, _variety[_settings_newgame.game_creation.variety]); break;
370 case WID_GL_BORDERS_RANDOM: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOMIZE : STR_MAPGEN_BORDER_MANUAL); break;
371 case WID_GL_WATER_NE: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOM : HasBit(_settings_newgame.game_creation.water_borders, BORDER_NE) ? STR_MAPGEN_BORDER_WATER : STR_MAPGEN_BORDER_FREEFORM); break;
372 case WID_GL_WATER_NW: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOM : HasBit(_settings_newgame.game_creation.water_borders, BORDER_NW) ? STR_MAPGEN_BORDER_WATER : STR_MAPGEN_BORDER_FREEFORM); break;
373 case WID_GL_WATER_SE: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOM : HasBit(_settings_newgame.game_creation.water_borders, BORDER_SE) ? STR_MAPGEN_BORDER_WATER : STR_MAPGEN_BORDER_FREEFORM); break;
374 case WID_GL_WATER_SW: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOM : HasBit(_settings_newgame.game_creation.water_borders, BORDER_SW) ? STR_MAPGEN_BORDER_WATER : STR_MAPGEN_BORDER_FREEFORM); break;
375 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: SetDParam(0, _rotation[_settings_newgame.game_creation.heightmap_rotation]); break;
377 case WID_GL_HEIGHTMAP_SIZE_TEXT:
378 if (_settings_newgame.game_creation.heightmap_rotation == HM_CLOCKWISE) {
379 SetDParam(0, this->y);
380 SetDParam(1, this->x);
381 } else {
382 SetDParam(0, this->x);
383 SetDParam(1, this->y);
385 break;
390 * Some data on this window has become invalid.
391 * @param data Information about the changed data.
392 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
394 void OnInvalidateData(int data = 0, bool gui_scope = true) override
396 if (!gui_scope) return;
397 /* Update the climate buttons */
398 this->SetWidgetLoweredState(WID_GL_TEMPERATE, _settings_newgame.game_creation.landscape == LT_TEMPERATE);
399 this->SetWidgetLoweredState(WID_GL_ARCTIC, _settings_newgame.game_creation.landscape == LT_ARCTIC);
400 this->SetWidgetLoweredState(WID_GL_TROPICAL, _settings_newgame.game_creation.landscape == LT_TROPIC);
401 this->SetWidgetLoweredState(WID_GL_TOYLAND, _settings_newgame.game_creation.landscape == LT_TOYLAND);
403 /* You can't select smoothness / non-water borders if not terragenesis */
404 if (mode == GLWM_GENERATE) {
405 this->SetWidgetDisabledState(WID_GL_SMOOTHNESS_PULLDOWN, _settings_newgame.game_creation.land_generator == LG_ORIGINAL);
406 this->SetWidgetDisabledState(WID_GL_VARIETY_PULLDOWN, _settings_newgame.game_creation.land_generator == LG_ORIGINAL);
407 this->SetWidgetDisabledState(WID_GL_BORDERS_RANDOM, _settings_newgame.game_creation.land_generator == LG_ORIGINAL || !_settings_newgame.construction.freeform_edges);
408 this->SetWidgetsDisabledState(_settings_newgame.game_creation.land_generator == LG_ORIGINAL || !_settings_newgame.construction.freeform_edges || _settings_newgame.game_creation.water_borders == BORDERS_RANDOM,
409 WID_GL_WATER_NW, WID_GL_WATER_NE, WID_GL_WATER_SE, WID_GL_WATER_SW, WIDGET_LIST_END);
411 this->SetWidgetLoweredState(WID_GL_BORDERS_RANDOM, _settings_newgame.game_creation.water_borders == BORDERS_RANDOM);
413 this->SetWidgetLoweredState(WID_GL_WATER_NW, HasBit(_settings_newgame.game_creation.water_borders, BORDER_NW));
414 this->SetWidgetLoweredState(WID_GL_WATER_NE, HasBit(_settings_newgame.game_creation.water_borders, BORDER_NE));
415 this->SetWidgetLoweredState(WID_GL_WATER_SE, HasBit(_settings_newgame.game_creation.water_borders, BORDER_SE));
416 this->SetWidgetLoweredState(WID_GL_WATER_SW, HasBit(_settings_newgame.game_creation.water_borders, BORDER_SW));
418 this->SetWidgetsDisabledState(_settings_newgame.game_creation.land_generator == LG_ORIGINAL && (_settings_newgame.game_creation.landscape == LT_ARCTIC || _settings_newgame.game_creation.landscape == LT_TROPIC),
419 WID_GL_TERRAIN_PULLDOWN, WID_GL_WATER_PULLDOWN, WIDGET_LIST_END);
422 /* Disable snowline if not arctic */
423 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_TEXT, _settings_newgame.game_creation.landscape != LT_ARCTIC);
425 /* Update availability of decreasing / increasing start date and snow level */
426 this->SetWidgetDisabledState(WID_GL_MAX_HEIGHTLEVEL_DOWN, _settings_newgame.construction.max_heightlevel <= MIN_MAX_HEIGHTLEVEL);
427 this->SetWidgetDisabledState(WID_GL_MAX_HEIGHTLEVEL_UP, _settings_newgame.construction.max_heightlevel >= MAX_MAX_HEIGHTLEVEL);
428 this->SetWidgetDisabledState(WID_GL_START_DATE_DOWN, _settings_newgame.game_creation.starting_year <= MIN_YEAR);
429 this->SetWidgetDisabledState(WID_GL_START_DATE_UP, _settings_newgame.game_creation.starting_year >= MAX_YEAR);
430 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_DOWN, _settings_newgame.game_creation.snow_line_height <= MIN_SNOWLINE_HEIGHT || _settings_newgame.game_creation.landscape != LT_ARCTIC);
431 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_UP, _settings_newgame.game_creation.snow_line_height >= MAX_SNOWLINE_HEIGHT || _settings_newgame.game_creation.landscape != LT_ARCTIC);
433 /* Do not allow a custom sea level with the original land generator. */
434 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL &&
435 _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
436 _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
441 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
443 const StringID *strs = nullptr;
444 switch (widget) {
445 case WID_GL_MAX_HEIGHTLEVEL_TEXT:
446 SetDParam(0, MAX_TILE_HEIGHT);
447 *size = GetStringBoundingBox(STR_JUST_INT);
448 break;
450 case WID_GL_START_DATE_TEXT:
451 SetDParam(0, ConvertYMDToDate(MAX_YEAR, 0, 1));
452 *size = maxdim(*size, GetStringBoundingBox(STR_BLACK_DATE_LONG));
453 break;
455 case WID_GL_MAPSIZE_X_PULLDOWN:
456 case WID_GL_MAPSIZE_Y_PULLDOWN:
457 SetDParamMaxValue(0, MAX_MAP_SIZE);
458 *size = maxdim(*size, GetStringBoundingBox(STR_JUST_INT));
459 break;
461 case WID_GL_SNOW_LEVEL_TEXT:
462 SetDParamMaxValue(0, MAX_TILE_HEIGHT);
463 *size = maxdim(*size, GetStringBoundingBox(STR_JUST_INT));
464 break;
466 case WID_GL_HEIGHTMAP_SIZE_TEXT:
467 SetDParam(0, this->x);
468 SetDParam(1, this->y);
469 *size = maxdim(*size, GetStringBoundingBox(STR_MAPGEN_HEIGHTMAP_SIZE));
470 break;
472 case WID_GL_TOWN_PULLDOWN:
473 strs = _num_towns;
474 SetDParamMaxValue(0, CUSTOM_TOWN_MAX_NUMBER);
475 *size = maxdim(*size, GetStringBoundingBox(STR_NUM_CUSTOM_NUMBER));
476 break;
478 case WID_GL_INDUSTRY_PULLDOWN: strs = _num_inds; break;
479 case WID_GL_LANDSCAPE_PULLDOWN: strs = _landscape; break;
480 case WID_GL_TREE_PULLDOWN: strs = _tree_placer; break;
481 case WID_GL_TERRAIN_PULLDOWN: strs = _elevations; break;
482 case WID_GL_WATER_PULLDOWN:
483 strs = _sea_lakes;
484 SetDParamMaxValue(0, CUSTOM_SEA_LEVEL_MAX_PERCENTAGE);
485 *size = maxdim(*size, GetStringBoundingBox(STR_SEA_LEVEL_CUSTOM_PERCENTAGE));
486 break;
488 case WID_GL_RIVER_PULLDOWN: strs = _rivers; break;
489 case WID_GL_SMOOTHNESS_PULLDOWN: strs = _smoothness; break;
490 case WID_GL_VARIETY_PULLDOWN: strs = _variety; break;
491 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: strs = _rotation; break;
492 case WID_GL_BORDERS_RANDOM:
493 *size = maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_RANDOMIZE), GetStringBoundingBox(STR_MAPGEN_BORDER_MANUAL));
494 break;
496 case WID_GL_WATER_NE:
497 case WID_GL_WATER_NW:
498 case WID_GL_WATER_SE:
499 case WID_GL_WATER_SW:
500 *size = maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_RANDOM), maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_WATER), GetStringBoundingBox(STR_MAPGEN_BORDER_FREEFORM)));
501 break;
503 case WID_GL_HEIGHTMAP_NAME_TEXT:
504 size->width = 0;
505 break;
507 default:
508 return;
510 if (strs != nullptr) {
511 while (*strs != INVALID_STRING_ID) {
512 *size = maxdim(*size, GetStringBoundingBox(*strs++));
515 size->width += padding.width;
516 size->height = max(size->height, (uint)(FONT_HEIGHT_NORMAL + WD_DROPDOWNTEXT_TOP + WD_DROPDOWNTEXT_BOTTOM));
519 void DrawWidget(const Rect &r, int widget) const override
521 switch (widget) {
522 case WID_GL_HEIGHTMAP_NAME_TEXT: {
523 DrawString(r.left, r.right, r.top, this->name, TC_ORANGE);
524 break;
529 void OnClick(Point pt, int widget, int click_count) override
531 switch (widget) {
532 case WID_GL_TEMPERATE:
533 case WID_GL_ARCTIC:
534 case WID_GL_TROPICAL:
535 case WID_GL_TOYLAND:
536 SetNewLandscapeType(widget - WID_GL_TEMPERATE);
537 break;
539 case WID_GL_MAPSIZE_X_PULLDOWN: // Mapsize X
540 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_x, WID_GL_MAPSIZE_X_PULLDOWN);
541 break;
543 case WID_GL_MAPSIZE_Y_PULLDOWN: // Mapsize Y
544 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_y, WID_GL_MAPSIZE_Y_PULLDOWN);
545 break;
547 case WID_GL_TOWN_PULLDOWN: // Number of towns
548 ShowDropDownMenu(this, _num_towns, _settings_newgame.difficulty.number_towns, WID_GL_TOWN_PULLDOWN, 0, 0);
549 break;
551 case WID_GL_INDUSTRY_PULLDOWN: // Number of industries
552 ShowDropDownMenu(this, _num_inds, _settings_newgame.difficulty.industry_density, WID_GL_INDUSTRY_PULLDOWN, 0, 0);
553 break;
555 case WID_GL_GENERATE_BUTTON: { // Generate
556 /* Get rotated map size. */
557 uint map_x;
558 uint map_y;
559 if (_settings_newgame.game_creation.heightmap_rotation == HM_CLOCKWISE) {
560 map_x = this->y;
561 map_y = this->x;
562 } else {
563 map_x = this->x;
564 map_y = this->y;
566 if (mode == GLWM_HEIGHTMAP &&
567 (map_x * 2 < (1U << _settings_newgame.game_creation.map_x) ||
568 map_x / 2 > (1U << _settings_newgame.game_creation.map_x) ||
569 map_y * 2 < (1U << _settings_newgame.game_creation.map_y) ||
570 map_y / 2 > (1U << _settings_newgame.game_creation.map_y))) {
571 ShowQuery(
572 STR_WARNING_HEIGHTMAP_SCALE_CAPTION,
573 STR_WARNING_HEIGHTMAP_SCALE_MESSAGE,
574 this,
575 LandscapeGenerationCallback);
576 } else {
577 StartGeneratingLandscape(mode);
579 break;
582 case WID_GL_MAX_HEIGHTLEVEL_DOWN:
583 case WID_GL_MAX_HEIGHTLEVEL_UP: // Height level buttons
584 /* Don't allow too fast scrolling */
585 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
586 this->HandleButtonClick(widget);
588 _settings_newgame.construction.max_heightlevel = Clamp(_settings_newgame.construction.max_heightlevel + widget - WID_GL_MAX_HEIGHTLEVEL_TEXT, MIN_MAX_HEIGHTLEVEL, MAX_MAX_HEIGHTLEVEL);
589 this->InvalidateData();
591 _left_button_clicked = false;
592 break;
594 case WID_GL_MAX_HEIGHTLEVEL_TEXT: // Height level text
595 this->widget_id = WID_GL_MAX_HEIGHTLEVEL_TEXT;
596 SetDParam(0, _settings_newgame.construction.max_heightlevel);
597 ShowQueryString(STR_JUST_INT, STR_MAPGEN_MAX_HEIGHTLEVEL_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
598 break;
601 case WID_GL_START_DATE_DOWN:
602 case WID_GL_START_DATE_UP: // Year buttons
603 /* Don't allow too fast scrolling */
604 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
605 this->HandleButtonClick(widget);
607 _settings_newgame.game_creation.starting_year = Clamp(_settings_newgame.game_creation.starting_year + widget - WID_GL_START_DATE_TEXT, MIN_YEAR, MAX_YEAR);
608 this->InvalidateData();
610 _left_button_clicked = false;
611 break;
613 case WID_GL_START_DATE_TEXT: // Year text
614 this->widget_id = WID_GL_START_DATE_TEXT;
615 SetDParam(0, _settings_newgame.game_creation.starting_year);
616 ShowQueryString(STR_JUST_INT, STR_MAPGEN_START_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
617 break;
619 case WID_GL_SNOW_LEVEL_DOWN:
620 case WID_GL_SNOW_LEVEL_UP: // Snow line buttons
621 /* Don't allow too fast scrolling */
622 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
623 this->HandleButtonClick(widget);
625 _settings_newgame.game_creation.snow_line_height = Clamp(_settings_newgame.game_creation.snow_line_height + widget - WID_GL_SNOW_LEVEL_TEXT, MIN_SNOWLINE_HEIGHT, MAX_SNOWLINE_HEIGHT);
626 this->InvalidateData();
628 _left_button_clicked = false;
629 break;
631 case WID_GL_SNOW_LEVEL_TEXT: // Snow line text
632 this->widget_id = WID_GL_SNOW_LEVEL_TEXT;
633 SetDParam(0, _settings_newgame.game_creation.snow_line_height);
634 ShowQueryString(STR_JUST_INT, STR_MAPGEN_SNOW_LINE_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
635 break;
637 case WID_GL_TREE_PULLDOWN: // Tree placer
638 ShowDropDownMenu(this, _tree_placer, _settings_newgame.game_creation.tree_placer, WID_GL_TREE_PULLDOWN, 0, 0);
639 break;
641 case WID_GL_LANDSCAPE_PULLDOWN: // Landscape generator
642 ShowDropDownMenu(this, _landscape, _settings_newgame.game_creation.land_generator, WID_GL_LANDSCAPE_PULLDOWN, 0, 0);
643 break;
645 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: // Heightmap rotation
646 ShowDropDownMenu(this, _rotation, _settings_newgame.game_creation.heightmap_rotation, WID_GL_HEIGHTMAP_ROTATION_PULLDOWN, 0, 0);
647 break;
649 case WID_GL_TERRAIN_PULLDOWN: // Terrain type
650 /* For the original map generation only the first four are valid. */
651 ShowDropDownMenu(this, _elevations, _settings_newgame.difficulty.terrain_type, WID_GL_TERRAIN_PULLDOWN, 0, _settings_newgame.game_creation.land_generator == LG_ORIGINAL ? ~0xF : 0);
652 break;
654 case WID_GL_WATER_PULLDOWN: { // Water quantity
655 uint32 hidden_mask = 0;
656 /* Disable custom water level when the original map generator is active. */
657 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL) {
658 SetBit(hidden_mask, CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY);
660 ShowDropDownMenu(this, _sea_lakes, _settings_newgame.difficulty.quantity_sea_lakes, WID_GL_WATER_PULLDOWN, 0, hidden_mask);
661 break;
664 case WID_GL_RIVER_PULLDOWN: // Amount of rivers
665 ShowDropDownMenu(this, _rivers, _settings_newgame.game_creation.amount_of_rivers, WID_GL_RIVER_PULLDOWN, 0, 0);
666 break;
668 case WID_GL_SMOOTHNESS_PULLDOWN: // Map smoothness
669 ShowDropDownMenu(this, _smoothness, _settings_newgame.game_creation.tgen_smoothness, WID_GL_SMOOTHNESS_PULLDOWN, 0, 0);
670 break;
672 case WID_GL_VARIETY_PULLDOWN: // Map variety
673 ShowDropDownMenu(this, _variety, _settings_newgame.game_creation.variety, WID_GL_VARIETY_PULLDOWN, 0, 0);
674 break;
676 /* Freetype map borders */
677 case WID_GL_WATER_NW:
678 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_NW);
679 this->InvalidateData();
680 break;
682 case WID_GL_WATER_NE:
683 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_NE);
684 this->InvalidateData();
685 break;
687 case WID_GL_WATER_SE:
688 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_SE);
689 this->InvalidateData();
690 break;
692 case WID_GL_WATER_SW:
693 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_SW);
694 this->InvalidateData();
695 break;
697 case WID_GL_BORDERS_RANDOM:
698 _settings_newgame.game_creation.water_borders = (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? 0 : BORDERS_RANDOM;
699 this->InvalidateData();
700 break;
704 void OnTimeout() override
706 static const int raise_widgets[] = {WID_GL_MAX_HEIGHTLEVEL_DOWN, WID_GL_MAX_HEIGHTLEVEL_UP, WID_GL_START_DATE_DOWN, WID_GL_START_DATE_UP, WID_GL_SNOW_LEVEL_UP, WID_GL_SNOW_LEVEL_DOWN, WIDGET_LIST_END};
707 for (const int *widget = raise_widgets; *widget != WIDGET_LIST_END; widget++) {
708 if (this->IsWidgetLowered(*widget)) {
709 this->RaiseWidget(*widget);
710 this->SetWidgetDirty(*widget);
715 void OnDropdownSelect(int widget, int index) override
717 switch (widget) {
718 case WID_GL_MAPSIZE_X_PULLDOWN: _settings_newgame.game_creation.map_x = index; break;
719 case WID_GL_MAPSIZE_Y_PULLDOWN: _settings_newgame.game_creation.map_y = index; break;
720 case WID_GL_TREE_PULLDOWN: _settings_newgame.game_creation.tree_placer = index; break;
721 case WID_GL_RIVER_PULLDOWN: _settings_newgame.game_creation.amount_of_rivers = index; break;
722 case WID_GL_SMOOTHNESS_PULLDOWN: _settings_newgame.game_creation.tgen_smoothness = index; break;
723 case WID_GL_VARIETY_PULLDOWN: _settings_newgame.game_creation.variety = index; break;
725 case WID_GL_LANDSCAPE_PULLDOWN: _settings_newgame.game_creation.land_generator = index;
726 /* If original landgenerator is selected and alpinist terrain_type was selected, revert to mountainous. */
727 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL) {
728 _settings_newgame.difficulty.terrain_type = Clamp(_settings_newgame.difficulty.terrain_type, 0, 3);
730 break;
732 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: _settings_newgame.game_creation.heightmap_rotation = index; break;
734 case WID_GL_TOWN_PULLDOWN:
735 if ((uint)index == CUSTOM_TOWN_NUMBER_DIFFICULTY) {
736 this->widget_id = widget;
737 SetDParam(0, _settings_newgame.game_creation.custom_town_number);
738 ShowQueryString(STR_JUST_INT, STR_MAPGEN_NUMBER_OF_TOWNS, 5, this, CS_NUMERAL, QSF_NONE);
740 _settings_newgame.difficulty.number_towns = index;
741 break;
743 case WID_GL_INDUSTRY_PULLDOWN: _settings_newgame.difficulty.industry_density = index; break;
744 case WID_GL_TERRAIN_PULLDOWN: _settings_newgame.difficulty.terrain_type = index; break;
746 case WID_GL_WATER_PULLDOWN: {
747 if ((uint)index == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
748 this->widget_id = widget;
749 SetDParam(0, _settings_newgame.game_creation.custom_sea_level);
750 ShowQueryString(STR_JUST_INT, STR_MAPGEN_QUANTITY_OF_SEA_LAKES, 3, this, CS_NUMERAL, QSF_NONE);
752 _settings_newgame.difficulty.quantity_sea_lakes = index;
753 break;
756 this->InvalidateData();
759 void OnQueryTextFinished(char *str) override
761 /* Was 'cancel' pressed? */
762 if (str == nullptr) return;
764 int32 value;
765 if (!StrEmpty(str)) {
766 value = atoi(str);
767 } else {
768 /* An empty string means revert to the default */
769 switch (this->widget_id) {
770 case WID_GL_MAX_HEIGHTLEVEL_TEXT: value = DEF_MAX_HEIGHTLEVEL; break;
771 case WID_GL_START_DATE_TEXT: value = DEF_START_YEAR; break;
772 case WID_GL_SNOW_LEVEL_TEXT: value = DEF_SNOWLINE_HEIGHT; break;
773 case WID_GL_TOWN_PULLDOWN: value = 1; break;
774 case WID_GL_WATER_PULLDOWN: value = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE; break;
775 default: NOT_REACHED();
779 switch (this->widget_id) {
780 case WID_GL_MAX_HEIGHTLEVEL_TEXT:
781 this->SetWidgetDirty(WID_GL_MAX_HEIGHTLEVEL_TEXT);
782 _settings_newgame.construction.max_heightlevel = Clamp(value, MIN_MAX_HEIGHTLEVEL, MAX_MAX_HEIGHTLEVEL);
783 break;
785 case WID_GL_START_DATE_TEXT:
786 this->SetWidgetDirty(WID_GL_START_DATE_TEXT);
787 _settings_newgame.game_creation.starting_year = Clamp(value, MIN_YEAR, MAX_YEAR);
788 break;
790 case WID_GL_SNOW_LEVEL_TEXT:
791 this->SetWidgetDirty(WID_GL_SNOW_LEVEL_TEXT);
792 _settings_newgame.game_creation.snow_line_height = Clamp(value, MIN_SNOWLINE_HEIGHT, MAX_SNOWLINE_HEIGHT);
793 break;
795 case WID_GL_TOWN_PULLDOWN:
796 _settings_newgame.game_creation.custom_town_number = Clamp(value, 1, CUSTOM_TOWN_MAX_NUMBER);
797 break;
799 case WID_GL_WATER_PULLDOWN:
800 _settings_newgame.game_creation.custom_sea_level = Clamp(value, CUSTOM_SEA_LEVEL_MIN_PERCENTAGE, CUSTOM_SEA_LEVEL_MAX_PERCENTAGE);
801 break;
804 this->InvalidateData();
808 static WindowDesc _generate_landscape_desc(
809 WDP_CENTER, nullptr, 0, 0,
810 WC_GENERATE_LANDSCAPE, WC_NONE,
812 _nested_generate_landscape_widgets, lengthof(_nested_generate_landscape_widgets)
815 static WindowDesc _heightmap_load_desc(
816 WDP_CENTER, nullptr, 0, 0,
817 WC_GENERATE_LANDSCAPE, WC_NONE,
819 _nested_heightmap_load_widgets, lengthof(_nested_heightmap_load_widgets)
822 static void _ShowGenerateLandscape(GenerateLandscapeWindowMode mode)
824 uint x = 0;
825 uint y = 0;
827 DeleteWindowByClass(WC_GENERATE_LANDSCAPE);
829 /* Generate a new seed when opening the window */
830 _settings_newgame.game_creation.generation_seed = InteractiveRandom();
832 if (mode == GLWM_HEIGHTMAP) {
833 /* If the function returns negative, it means there was a problem loading the heightmap */
834 if (!GetHeightmapDimensions(_file_to_saveload.detail_ftype, _file_to_saveload.name, &x, &y)) return;
837 WindowDesc *desc = (mode == GLWM_HEIGHTMAP) ? &_heightmap_load_desc : &_generate_landscape_desc;
838 GenerateLandscapeWindow *w = AllocateWindowDescFront<GenerateLandscapeWindow>(desc, mode, true);
840 if (mode == GLWM_HEIGHTMAP) {
841 w->x = x;
842 w->y = y;
843 strecpy(w->name, _file_to_saveload.title, lastof(w->name));
846 SetWindowDirty(WC_GENERATE_LANDSCAPE, mode);
849 /** Start with a normal game. */
850 void ShowGenerateLandscape()
852 _ShowGenerateLandscape(GLWM_GENERATE);
855 /** Start with loading a heightmap. */
856 void ShowHeightmapLoad()
858 _ShowGenerateLandscape(GLWM_HEIGHTMAP);
861 /** Start with a scenario editor. */
862 void StartScenarioEditor()
864 StartGeneratingLandscape(GLWM_SCENARIO);
868 * Start a normal game without the GUI.
869 * @param seed The seed of the new game.
871 void StartNewGameWithoutGUI(uint32 seed)
873 /* GenerateWorld takes care of the possible GENERATE_NEW_SEED value in 'seed' */
874 _settings_newgame.game_creation.generation_seed = seed;
876 StartGeneratingLandscape(GLWM_GENERATE);
879 struct CreateScenarioWindow : public Window
881 uint widget_id;
883 CreateScenarioWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
885 this->InitNested(window_number);
886 this->LowerWidget(_settings_newgame.game_creation.landscape + WID_CS_TEMPERATE);
889 void SetStringParameters(int widget) const override
891 switch (widget) {
892 case WID_CS_START_DATE_TEXT:
893 SetDParam(0, ConvertYMDToDate(_settings_newgame.game_creation.starting_year, 0, 1));
894 break;
896 case WID_CS_MAPSIZE_X_PULLDOWN:
897 SetDParam(0, 1LL << _settings_newgame.game_creation.map_x);
898 break;
900 case WID_CS_MAPSIZE_Y_PULLDOWN:
901 SetDParam(0, 1LL << _settings_newgame.game_creation.map_y);
902 break;
904 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
905 SetDParam(0, _settings_newgame.game_creation.se_flat_world_height);
906 break;
910 void OnPaint() override
912 this->SetWidgetDisabledState(WID_CS_START_DATE_DOWN, _settings_newgame.game_creation.starting_year <= MIN_YEAR);
913 this->SetWidgetDisabledState(WID_CS_START_DATE_UP, _settings_newgame.game_creation.starting_year >= MAX_YEAR);
914 this->SetWidgetDisabledState(WID_CS_FLAT_LAND_HEIGHT_DOWN, _settings_newgame.game_creation.se_flat_world_height <= 0);
915 this->SetWidgetDisabledState(WID_CS_FLAT_LAND_HEIGHT_UP, _settings_newgame.game_creation.se_flat_world_height >= MAX_TILE_HEIGHT);
917 this->SetWidgetLoweredState(WID_CS_TEMPERATE, _settings_newgame.game_creation.landscape == LT_TEMPERATE);
918 this->SetWidgetLoweredState(WID_CS_ARCTIC, _settings_newgame.game_creation.landscape == LT_ARCTIC);
919 this->SetWidgetLoweredState(WID_CS_TROPICAL, _settings_newgame.game_creation.landscape == LT_TROPIC);
920 this->SetWidgetLoweredState(WID_CS_TOYLAND, _settings_newgame.game_creation.landscape == LT_TOYLAND);
922 this->DrawWidgets();
925 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
927 StringID str = STR_JUST_INT;
928 switch (widget) {
929 case WID_CS_START_DATE_TEXT:
930 SetDParam(0, ConvertYMDToDate(MAX_YEAR, 0, 1));
931 str = STR_BLACK_DATE_LONG;
932 break;
934 case WID_CS_MAPSIZE_X_PULLDOWN:
935 case WID_CS_MAPSIZE_Y_PULLDOWN:
936 SetDParamMaxValue(0, MAX_MAP_SIZE);
937 break;
939 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
940 SetDParamMaxValue(0, MAX_TILE_HEIGHT);
941 break;
943 default:
944 return;
946 *size = maxdim(*size, GetStringBoundingBox(str));
947 size->width += padding.width;
948 size->height += padding.height;
951 void OnClick(Point pt, int widget, int click_count) override
953 switch (widget) {
954 case WID_CS_TEMPERATE:
955 case WID_CS_ARCTIC:
956 case WID_CS_TROPICAL:
957 case WID_CS_TOYLAND:
958 this->RaiseWidget(_settings_newgame.game_creation.landscape + WID_CS_TEMPERATE);
959 SetNewLandscapeType(widget - WID_CS_TEMPERATE);
960 break;
962 case WID_CS_MAPSIZE_X_PULLDOWN: // Mapsize X
963 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_x, WID_CS_MAPSIZE_X_PULLDOWN);
964 break;
966 case WID_CS_MAPSIZE_Y_PULLDOWN: // Mapsize Y
967 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_y, WID_CS_MAPSIZE_Y_PULLDOWN);
968 break;
970 case WID_CS_EMPTY_WORLD: // Empty world / flat world
971 StartGeneratingLandscape(GLWM_SCENARIO);
972 break;
974 case WID_CS_RANDOM_WORLD: // Generate
975 ShowGenerateLandscape();
976 break;
978 case WID_CS_START_DATE_DOWN:
979 case WID_CS_START_DATE_UP: // Year buttons
980 /* Don't allow too fast scrolling */
981 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
982 this->HandleButtonClick(widget);
983 this->SetDirty();
985 _settings_newgame.game_creation.starting_year = Clamp(_settings_newgame.game_creation.starting_year + widget - WID_CS_START_DATE_TEXT, MIN_YEAR, MAX_YEAR);
987 _left_button_clicked = false;
988 break;
990 case WID_CS_START_DATE_TEXT: // Year text
991 this->widget_id = WID_CS_START_DATE_TEXT;
992 SetDParam(0, _settings_newgame.game_creation.starting_year);
993 ShowQueryString(STR_JUST_INT, STR_MAPGEN_START_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_NONE);
994 break;
996 case WID_CS_FLAT_LAND_HEIGHT_DOWN:
997 case WID_CS_FLAT_LAND_HEIGHT_UP: // Height level buttons
998 /* Don't allow too fast scrolling */
999 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
1000 this->HandleButtonClick(widget);
1001 this->SetDirty();
1003 _settings_newgame.game_creation.se_flat_world_height = Clamp(_settings_newgame.game_creation.se_flat_world_height + widget - WID_CS_FLAT_LAND_HEIGHT_TEXT, 0, _settings_game.construction.max_heightlevel);
1005 _left_button_clicked = false;
1006 break;
1008 case WID_CS_FLAT_LAND_HEIGHT_TEXT: // Height level text
1009 this->widget_id = WID_CS_FLAT_LAND_HEIGHT_TEXT;
1010 SetDParam(0, _settings_newgame.game_creation.se_flat_world_height);
1011 ShowQueryString(STR_JUST_INT, STR_SE_MAPGEN_FLAT_WORLD_HEIGHT_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_NONE);
1012 break;
1016 void OnTimeout() override
1018 static const int raise_widgets[] = {WID_CS_START_DATE_DOWN, WID_CS_START_DATE_UP, WID_CS_FLAT_LAND_HEIGHT_DOWN, WID_CS_FLAT_LAND_HEIGHT_UP, WIDGET_LIST_END};
1019 for (const int *widget = raise_widgets; *widget != WIDGET_LIST_END; widget++) {
1020 if (this->IsWidgetLowered(*widget)) {
1021 this->RaiseWidget(*widget);
1022 this->SetWidgetDirty(*widget);
1027 void OnDropdownSelect(int widget, int index) override
1029 switch (widget) {
1030 case WID_CS_MAPSIZE_X_PULLDOWN: _settings_newgame.game_creation.map_x = index; break;
1031 case WID_CS_MAPSIZE_Y_PULLDOWN: _settings_newgame.game_creation.map_y = index; break;
1033 this->SetDirty();
1036 void OnQueryTextFinished(char *str) override
1038 if (!StrEmpty(str)) {
1039 int32 value = atoi(str);
1041 switch (this->widget_id) {
1042 case WID_CS_START_DATE_TEXT:
1043 this->SetWidgetDirty(WID_CS_START_DATE_TEXT);
1044 _settings_newgame.game_creation.starting_year = Clamp(value, MIN_YEAR, MAX_YEAR);
1045 break;
1047 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
1048 this->SetWidgetDirty(WID_CS_FLAT_LAND_HEIGHT_TEXT);
1049 _settings_newgame.game_creation.se_flat_world_height = Clamp(value, 0, _settings_game.construction.max_heightlevel);
1050 break;
1053 this->SetDirty();
1058 static const NWidgetPart _nested_create_scenario_widgets[] = {
1059 NWidget(NWID_HORIZONTAL),
1060 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1061 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_SE_MAPGEN_CAPTION, STR_NULL),
1062 EndContainer(),
1063 NWidget(WWT_PANEL, COLOUR_BROWN),
1064 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
1065 /* Landscape style selection. */
1066 NWidget(NWID_HORIZONTAL), SetPIP(10, 3, 10),
1067 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
1068 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
1069 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
1070 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
1071 EndContainer(),
1072 NWidget(NWID_HORIZONTAL), SetPIP(10, 8, 10),
1073 /* Green generation type buttons: 'Flat land' and 'Random land'. */
1074 NWidget(NWID_VERTICAL), SetPIP(10, 6, 10),
1075 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_CS_EMPTY_WORLD), SetDataTip(STR_SE_MAPGEN_FLAT_WORLD, STR_SE_MAPGEN_FLAT_WORLD_TOOLTIP), SetFill(1, 1),
1076 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_CS_RANDOM_WORLD), SetDataTip(STR_SE_MAPGEN_RANDOM_LAND, STR_TERRAFORM_TOOLTIP_GENERATE_RANDOM_LAND), SetFill(1, 1),
1077 EndContainer(),
1078 /* Labels + setting drop-downs */
1079 NWidget(NWID_VERTICAL), SetPIP(10, 6, 10),
1080 /* Map size. */
1081 NWidget(NWID_HORIZONTAL),
1082 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_NULL), SetPadding(1, 0, 0, 0),
1083 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1084 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_CS_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetPadding(0, 4, 0, 0),
1085 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 2, 0, 0),
1086 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_CS_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL),
1087 EndContainer(),
1088 /* Date. */
1089 NWidget(NWID_HORIZONTAL),
1090 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetPadding(1, 0, 0, 0),
1091 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1092 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_CS_START_DATE_DOWN), SetFill(0, 1), SetDataTip(SPR_ARROW_DOWN, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_BACKWARD),
1093 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CS_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL),
1094 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_CS_START_DATE_UP), SetFill(0, 1), SetDataTip(SPR_ARROW_UP, STR_SCENEDIT_TOOLBAR_TOOLTIP_MOVE_THE_STARTING_DATE_FORWARD),
1095 EndContainer(),
1096 /* Flat map height. */
1097 NWidget(NWID_HORIZONTAL),
1098 NWidget(WWT_TEXT, COLOUR_ORANGE),
1099 SetDataTip(STR_SE_MAPGEN_FLAT_WORLD_HEIGHT, STR_NULL), SetPadding(1, 0, 0, 0),
1100 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1101 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_CS_FLAT_LAND_HEIGHT_DOWN), SetFill(0, 1), SetDataTip(SPR_ARROW_DOWN, STR_SE_MAPGEN_FLAT_WORLD_HEIGHT_DOWN),
1102 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CS_FLAT_LAND_HEIGHT_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL),
1103 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_CS_FLAT_LAND_HEIGHT_UP), SetFill(0, 1), SetDataTip(SPR_ARROW_UP, STR_SE_MAPGEN_FLAT_WORLD_HEIGHT_UP),
1104 EndContainer(),
1105 EndContainer(),
1106 EndContainer(),
1107 EndContainer(),
1110 static WindowDesc _create_scenario_desc(
1111 WDP_CENTER, nullptr, 0, 0,
1112 WC_GENERATE_LANDSCAPE, WC_NONE,
1114 _nested_create_scenario_widgets, lengthof(_nested_create_scenario_widgets)
1117 /** Show the window to create a scenario. */
1118 void ShowCreateScenario()
1120 DeleteWindowByClass(WC_GENERATE_LANDSCAPE);
1121 new CreateScenarioWindow(&_create_scenario_desc, GLWM_SCENARIO);
1124 static const NWidgetPart _nested_generate_progress_widgets[] = {
1125 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GENERATION_WORLD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1126 NWidget(WWT_PANEL, COLOUR_GREY),
1127 NWidget(NWID_HORIZONTAL), SetPIP(20, 0, 20),
1128 NWidget(NWID_VERTICAL), SetPIP(11, 8, 11),
1129 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_BAR), SetFill(1, 0),
1130 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_TEXT), SetFill(1, 0),
1131 NWidget(WWT_TEXTBTN, COLOUR_WHITE, WID_GP_ABORT), SetDataTip(STR_GENERATION_ABORT, STR_NULL), SetFill(1, 0),
1132 EndContainer(),
1133 EndContainer(),
1134 EndContainer(),
1138 static WindowDesc _generate_progress_desc(
1139 WDP_CENTER, nullptr, 0, 0,
1140 WC_MODAL_PROGRESS, WC_NONE,
1142 _nested_generate_progress_widgets, lengthof(_nested_generate_progress_widgets)
1145 struct GenWorldStatus {
1146 uint percent;
1147 StringID cls;
1148 uint current;
1149 uint total;
1150 int timer;
1153 static GenWorldStatus _gws;
1155 static const StringID _generation_class_table[] = {
1156 STR_GENERATION_WORLD_GENERATION,
1157 STR_SCENEDIT_TOOLBAR_LANDSCAPE_GENERATION,
1158 STR_GENERATION_RIVER_GENERATION,
1159 STR_GENERATION_CLEARING_TILES,
1160 STR_SCENEDIT_TOOLBAR_TOWN_GENERATION,
1161 STR_SCENEDIT_TOOLBAR_INDUSTRY_GENERATION,
1162 STR_GENERATION_OBJECT_GENERATION,
1163 STR_GENERATION_TREE_GENERATION,
1164 STR_GENERATION_SETTINGUP_GAME,
1165 STR_GENERATION_PREPARING_TILELOOP,
1166 STR_GENERATION_PREPARING_SCRIPT,
1167 STR_GENERATION_PREPARING_GAME
1169 assert_compile(lengthof(_generation_class_table) == GWP_CLASS_COUNT);
1172 static void AbortGeneratingWorldCallback(Window *w, bool confirmed)
1174 if (confirmed) {
1175 AbortGeneratingWorld();
1176 } else if (HasModalProgress() && !IsGeneratingWorldAborted()) {
1177 SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1181 struct GenerateProgressWindow : public Window {
1183 GenerateProgressWindow() : Window(&_generate_progress_desc)
1185 this->InitNested();
1188 void OnClick(Point pt, int widget, int click_count) override
1190 switch (widget) {
1191 case WID_GP_ABORT:
1192 SetMouseCursorBusy(false);
1193 ShowQuery(
1194 STR_GENERATION_ABORT_CAPTION,
1195 STR_GENERATION_ABORT_MESSAGE,
1196 this,
1197 AbortGeneratingWorldCallback
1199 break;
1203 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1205 switch (widget) {
1206 case WID_GP_PROGRESS_BAR: {
1207 SetDParamMaxValue(0, 100);
1208 *size = GetStringBoundingBox(STR_GENERATION_PROGRESS);
1209 /* We need some spacing for the 'border' */
1210 size->height += 8;
1211 size->width += 8;
1212 break;
1215 case WID_GP_PROGRESS_TEXT:
1216 for (uint i = 0; i < GWP_CLASS_COUNT; i++) {
1217 size->width = max(size->width, GetStringBoundingBox(_generation_class_table[i]).width);
1219 size->height = FONT_HEIGHT_NORMAL * 2 + WD_PAR_VSEP_NORMAL;
1220 break;
1224 void DrawWidget(const Rect &r, int widget) const override
1226 switch (widget) {
1227 case WID_GP_PROGRESS_BAR:
1228 /* Draw the % complete with a bar and a text */
1229 DrawFrameRect(r.left, r.top, r.right, r.bottom, COLOUR_GREY, FR_BORDERONLY);
1230 DrawFrameRect(r.left + 1, r.top + 1, (int)((r.right - r.left - 2) * _gws.percent / 100) + r.left + 1, r.bottom - 1, COLOUR_MAUVE, FR_NONE);
1231 SetDParam(0, _gws.percent);
1232 DrawString(r.left, r.right, r.top + 5, STR_GENERATION_PROGRESS, TC_FROMSTRING, SA_HOR_CENTER);
1233 break;
1235 case WID_GP_PROGRESS_TEXT:
1236 /* Tell which class we are generating */
1237 DrawString(r.left, r.right, r.top, _gws.cls, TC_FROMSTRING, SA_HOR_CENTER);
1239 /* And say where we are in that class */
1240 SetDParam(0, _gws.current);
1241 SetDParam(1, _gws.total);
1242 DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL, STR_GENERATION_PROGRESS_NUM, TC_FROMSTRING, SA_HOR_CENTER);
1248 * Initializes the progress counters to the starting point.
1250 void PrepareGenerateWorldProgress()
1252 _gws.cls = STR_GENERATION_WORLD_GENERATION;
1253 _gws.current = 0;
1254 _gws.total = 0;
1255 _gws.percent = 0;
1256 _gws.timer = 0; // Forces to paint the progress window immediately
1260 * Show the window where a user can follow the process of the map generation.
1262 void ShowGenerateWorldProgress()
1264 if (BringWindowToFrontById(WC_MODAL_PROGRESS, 0)) return;
1265 new GenerateProgressWindow();
1268 static void _SetGeneratingWorldProgress(GenWorldProgress cls, uint progress, uint total)
1270 static const int percent_table[] = {0, 5, 14, 17, 20, 40, 60, 65, 80, 85, 95, 99, 100 };
1271 assert_compile(lengthof(percent_table) == GWP_CLASS_COUNT + 1);
1272 assert(cls < GWP_CLASS_COUNT);
1274 /* Do not run this function if we aren't in a thread */
1275 if (!IsGenerateWorldThreaded() && !_network_dedicated) return;
1277 if (IsGeneratingWorldAborted()) HandleGeneratingWorldAbortion();
1279 if (total == 0) {
1280 assert(_gws.cls == _generation_class_table[cls]);
1281 _gws.current += progress;
1282 assert(_gws.current <= _gws.total);
1283 } else {
1284 _gws.cls = _generation_class_table[cls];
1285 _gws.current = progress;
1286 _gws.total = total;
1287 _gws.percent = percent_table[cls];
1290 /* Don't update the screen too often. So update it once in every once in a while... */
1291 if (!_network_dedicated && _gws.timer != 0 && _realtime_tick - _gws.timer < MODAL_PROGRESS_REDRAW_TIMEOUT) return;
1293 /* Percentage is about the number of completed tasks, so 'current - 1' */
1294 _gws.percent = percent_table[cls] + (percent_table[cls + 1] - percent_table[cls]) * (_gws.current == 0 ? 0 : _gws.current - 1) / _gws.total;
1296 if (_network_dedicated) {
1297 static uint last_percent = 0;
1299 /* Never display 0% */
1300 if (_gws.percent == 0) return;
1301 /* Reset if percent is lower than the last recorded */
1302 if (_gws.percent < last_percent) last_percent = 0;
1303 /* Display every 5%, but 6% is also very valid.. just not smaller steps than 5% */
1304 if (_gws.percent % 5 != 0 && _gws.percent <= last_percent + 5) return;
1305 /* Never show steps smaller than 2%, even if it is a mod 5% */
1306 if (_gws.percent <= last_percent + 2) return;
1308 DEBUG(net, 1, "Map generation percentage complete: %d", _gws.percent);
1309 last_percent = _gws.percent;
1311 /* Don't continue as dedicated never has a thread running */
1312 return;
1315 SetWindowDirty(WC_MODAL_PROGRESS, 0);
1316 MarkWholeScreenDirty();
1318 /* Release the rights to the map generator, and acquire the rights to the
1319 * paint thread. The 'other' thread already has the paint thread rights so
1320 * this ensures us that we are waiting until the paint thread is done
1321 * before we reacquire the mapgen rights */
1322 _modal_progress_work_mutex.unlock();
1323 _modal_progress_paint_mutex.lock();
1324 _modal_progress_work_mutex.lock();
1325 _modal_progress_paint_mutex.unlock();
1327 _gws.timer = _realtime_tick;
1331 * Set the total of a stage of the world generation.
1332 * @param cls the current class we are in.
1333 * @param total Set the total expected items for this class.
1335 * Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always.
1336 * Also, progress works if total is zero, total works if progress is zero.
1338 void SetGeneratingWorldProgress(GenWorldProgress cls, uint total)
1340 if (total == 0) return;
1342 _SetGeneratingWorldProgress(cls, 0, total);
1346 * Increases the current stage of the world generation with one.
1347 * @param cls the current class we are in.
1349 * Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always.
1350 * Also, progress works if total is zero, total works if progress is zero.
1352 void IncreaseGeneratingWorldProgress(GenWorldProgress cls)
1354 /* In fact the param 'class' isn't needed.. but for some security reasons, we want it around */
1355 _SetGeneratingWorldProgress(cls, 1, 0);