Codechange: [Win32] simplify when/where GdiFlush() is called
[openttd-github.git] / src / genworld_gui.cpp
blobbf4d327a7e4786e2eecf0676d3a45975d17d2523
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"
30 #include "newgrf_townname.h"
31 #include "townname_type.h"
33 #include "widgets/genworld_widget.h"
35 #include "safeguards.h"
38 extern void MakeNewgameSettingsLive();
40 /** Enum for the modes we can generate in. */
41 enum GenerateLandscapeWindowMode {
42 GLWM_GENERATE, ///< Generate new game.
43 GLWM_HEIGHTMAP, ///< Load from heightmap.
44 GLWM_SCENARIO, ///< Generate flat land.
47 /**
48 * Changes landscape type and sets genworld window dirty
49 * @param landscape new landscape type
51 void SetNewLandscapeType(byte landscape)
53 _settings_newgame.game_creation.landscape = landscape;
54 InvalidateWindowClassesData(WC_SELECT_GAME);
55 InvalidateWindowClassesData(WC_GENERATE_LANDSCAPE);
58 /** Widgets of GenerateLandscapeWindow when generating world */
59 static const NWidgetPart _nested_generate_landscape_widgets[] = {
60 NWidget(NWID_HORIZONTAL),
61 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
62 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MAPGEN_WORLD_GENERATION_CAPTION, STR_NULL),
63 EndContainer(),
64 NWidget(WWT_PANEL, COLOUR_BROWN),
65 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
66 /* Landscape selection. */
67 NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 10),
68 NWidget(NWID_SPACER), SetFill(1, 0),
69 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
70 NWidget(NWID_SPACER), SetFill(1, 0),
71 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
72 NWidget(NWID_SPACER), SetFill(1, 0),
73 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
74 NWidget(NWID_SPACER), SetFill(1, 0),
75 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
76 NWidget(NWID_SPACER), SetFill(1, 0),
77 EndContainer(),
78 NWidget(NWID_SPACER), SetMinimalSize(0, 11),
79 NWidget(NWID_HORIZONTAL), SetPIP(10, 5, 10),
80 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
81 /* Left column with labels. */
82 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
83 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 1),
84 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_LAND_GENERATOR, STR_NULL), SetFill(1, 1),
85 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_TERRAIN_TYPE, STR_NULL), SetFill(1, 1),
86 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_VARIETY, STR_NULL), SetFill(1, 1),
87 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_SEA_LAKES, STR_NULL), SetFill(1, 1),
88 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_TOWNS, STR_NULL), SetFill(1, 1),
89 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_INDUSTRIES, STR_NULL), SetFill(1, 1),
90 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BORDER_TYPE, STR_NULL), SetFill(1, 1),
91 EndContainer(),
92 /* Widgets at the right of the labels. */
93 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
94 /* Mapsize X * Y. */
95 NWidget(NWID_HORIZONTAL), SetPIP(0, 4, 0),
96 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 0),
97 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(1, 1),
98 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_MAPGEN_MAPSIZE_TOOLTIP), SetFill(1, 0),
99 EndContainer(),
100 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_LANDSCAPE_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
101 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TERRAIN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
102 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_VARIETY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
103 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_WATER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
104 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
105 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_INDUSTRY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
106 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_BORDERS_RANDOM), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
107 EndContainer(),
108 EndContainer(),
109 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
110 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
111 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
112 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAX_HEIGHTLEVEL, STR_NULL), SetFill(1, 1),
113 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SNOW_LINE_HEIGHT, STR_NULL), SetFill(1, 1),
114 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetFill(1, 1),
115 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SMOOTHNESS, STR_NULL), SetFill(1, 1),
116 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_RIVERS, STR_NULL), SetFill(1, 1),
117 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_GAME_OPTIONS_TOWN_NAMES_FRAME, STR_NULL), SetFill(1, 1),
118 EndContainer(),
119 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
120 /* Max. heightlevel. */
121 NWidget(NWID_HORIZONTAL),
122 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_MAX_HEIGHTLEVEL_DOWN), SetFill(0, 1),
123 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
124 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_MAX_HEIGHTLEVEL_UP), SetFill(0, 1),
125 EndContainer(),
126 /* Snow line. */
127 NWidget(NWID_HORIZONTAL),
128 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_SNOW_LINE_DOWN), SetFill(0, 1),
129 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
130 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_SNOW_LINE_UP), SetFill(0, 1),
131 EndContainer(),
132 /* Starting date. */
133 NWidget(NWID_HORIZONTAL),
134 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),
135 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_GL_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL), SetFill(1, 0),
136 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),
137 EndContainer(),
138 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_SMOOTHNESS_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
139 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_RIVER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
140 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWNNAME_DROPDOWN), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_TOWN_NAMES_DROPDOWN_TOOLTIP), SetFill(1, 0),
141 EndContainer(),
142 EndContainer(),
143 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_GL_GENERATE_BUTTON), SetMinimalSize(84, 0), SetDataTip(STR_MAPGEN_GENERATE, STR_NULL), SetFill(1, 1),
144 EndContainer(),
145 EndContainer(),
146 NWidget(NWID_SPACER), SetMinimalSize(0, 4),
147 /* Map borders buttons for each edge. */
148 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
149 NWidget(NWID_HORIZONTAL), SetPIP(0, 0, 3),
150 NWidget(NWID_SPACER), SetFill(1, 1),
151 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NORTHWEST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
152 EndContainer(),
153 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_NW), SetDataTip(STR_JUST_STRING, STR_MAPGEN_NORTHWEST), SetFill(1, 1),
154 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_NE), SetDataTip(STR_JUST_STRING, STR_MAPGEN_NORTHEAST), SetFill(1, 1),
155 NWidget(NWID_HORIZONTAL), SetPIP(3, 0, 0),
156 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NORTHEAST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
157 NWidget(NWID_SPACER), SetFill(1, 1),
158 EndContainer(),
159 EndContainer(),
160 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE), SetPIP(10, 0, 10),
161 NWidget(NWID_HORIZONTAL), SetPIP(0, 0, 3),
162 NWidget(NWID_SPACER), SetFill(1, 1),
163 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SOUTHWEST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
164 EndContainer(),
165 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_SW), SetDataTip(STR_JUST_STRING, STR_MAPGEN_SOUTHWEST), SetFill(1, 1),
166 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_WATER_SE), SetDataTip(STR_JUST_STRING, STR_MAPGEN_SOUTHEAST), SetFill(1, 1),
167 NWidget(NWID_HORIZONTAL), SetPIP(3, 0, 0),
168 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_SOUTHEAST, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(0, 1),
169 NWidget(NWID_SPACER), SetFill(1, 1),
170 EndContainer(),
171 EndContainer(),
172 NWidget(NWID_SPACER), SetMinimalSize(0, 9), SetFill(1, 1),
173 EndContainer(),
176 /** Widgets of GenerateLandscapeWindow when loading heightmap */
177 static const NWidgetPart _nested_heightmap_load_widgets[] = {
178 /* Window header. */
179 NWidget(NWID_HORIZONTAL),
180 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
181 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MAPGEN_WORLD_GENERATION_CAPTION, STR_NULL),
182 EndContainer(),
183 NWidget(WWT_PANEL, COLOUR_BROWN),
184 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
185 /* Landscape selection. */
186 NWidget(NWID_HORIZONTAL), SetPIP(10, 0, 10),
187 NWidget(NWID_SPACER), SetFill(1, 0),
188 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
189 NWidget(NWID_SPACER), SetFill(1, 0),
190 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
191 NWidget(NWID_SPACER), SetFill(1, 0),
192 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
193 NWidget(NWID_SPACER), SetFill(1, 0),
194 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_GL_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
195 NWidget(NWID_SPACER), SetFill(1, 0),
196 EndContainer(),
197 NWidget(NWID_SPACER), SetMinimalSize(0, 11), SetFill(0, 1),
198 NWidget(NWID_HORIZONTAL), SetPIP(10, 3, 10),
199 /* Labels at the left side. */
200 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
201 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_NAME, STR_NULL), SetFill(1, 1),
202 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_SIZE_LABEL, STR_NULL), SetFill(1, 1),
203 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_NULL), SetFill(1, 1),
204 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_HEIGHTMAP_ROTATION, STR_NULL), SetFill(1, 1),
205 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_TOWNS, STR_NULL), SetFill(1, 1),
206 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_NUMBER_OF_INDUSTRIES, STR_NULL), SetFill(1, 1),
207 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_QUANTITY_OF_RIVERS, STR_NULL), SetFill(1, 1),
208 EndContainer(),
209 /* Widgets at the right of the labels. */
210 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
211 NWidget(WWT_EMPTY, COLOUR_ORANGE, WID_GL_HEIGHTMAP_NAME_TEXT), SetFill(1, 0),
212 NWidget(NWID_HORIZONTAL), SetPIP(0, 5, 0),
213 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
214 NWidget(WWT_TEXT, COLOUR_ORANGE, WID_GL_HEIGHTMAP_SIZE_TEXT), SetDataTip(STR_MAPGEN_HEIGHTMAP_SIZE, STR_NULL), SetFill(1, 0),
215 /* Mapsize X * Y. */
216 NWidget(NWID_HORIZONTAL), SetPIP(0, 4, 0),
217 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetFill(1, 0),
218 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 0, 0, 0), SetFill(1, 1),
219 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetFill(1, 0),
220 EndContainer(),
221 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_HEIGHTMAP_ROTATION_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
222 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWN_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
223 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_INDUSTRY_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
224 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_RIVER_PULLDOWN), SetDataTip(STR_JUST_STRING, STR_NULL), SetFill(1, 0),
225 EndContainer(),
226 NWidget(NWID_VERTICAL), SetPIP(0, 4, 0),
227 NWidget(NWID_HORIZONTAL), SetPIP(0, 3, 0),
228 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
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_SNOW_LINE_HEIGHT, STR_NULL), SetFill(1, 1),
231 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetFill(1, 1),
232 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_GAME_OPTIONS_TOWN_NAMES_FRAME, STR_NULL), SetFill(1, 1),
233 EndContainer(),
234 NWidget(NWID_VERTICAL, NC_EQUALSIZE), SetPIP(0, 4, 0),
235 NWidget(NWID_HORIZONTAL),
236 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_MAX_HEIGHTLEVEL_DOWN), SetFill(0, 1),
237 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
238 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_MAX_HEIGHTLEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_MAX_HEIGHTLEVEL_UP), SetFill(0, 1),
239 EndContainer(),
240 NWidget(NWID_HORIZONTAL),
241 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_DOWN), SetDataTip(SPR_ARROW_DOWN, STR_MAPGEN_SNOW_LINE_DOWN), SetFill(0, 1),
242 NWidget(WWT_TEXTBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL), SetFill(1, 0),
243 NWidget(WWT_IMGBTN, COLOUR_ORANGE, WID_GL_SNOW_LEVEL_UP), SetDataTip(SPR_ARROW_UP, STR_MAPGEN_SNOW_LINE_UP), SetFill(0, 1),
244 EndContainer(),
245 NWidget(NWID_HORIZONTAL),
246 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),
247 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_GL_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL), SetFill(1, 0),
248 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),
249 EndContainer(),
250 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_GL_TOWNNAME_DROPDOWN), SetDataTip(STR_BLACK_STRING, STR_GAME_OPTIONS_TOWN_NAMES_DROPDOWN_TOOLTIP), SetFill(1, 0),
251 EndContainer(),
252 EndContainer(),
253 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_GL_GENERATE_BUTTON), SetMinimalSize(84, 0), SetDataTip(STR_MAPGEN_GENERATE, STR_NULL), SetFill(1, 1),
254 EndContainer(),
255 EndContainer(),
256 EndContainer(),
257 EndContainer(),
258 NWidget(NWID_SPACER), SetMinimalSize(0, 9), SetFill(1, 1),
259 EndContainer(),
262 static void StartGeneratingLandscape(GenerateLandscapeWindowMode mode)
264 DeleteAllNonVitalWindows();
265 ClearErrorMessages();
267 /* Copy all XXX_newgame to XXX when coming from outside the editor */
268 MakeNewgameSettingsLive();
269 ResetGRFConfig(true);
271 if (_settings_client.sound.confirm) SndPlayFx(SND_15_BEEP);
272 switch (mode) {
273 case GLWM_GENERATE: _switch_mode = (_game_mode == GM_EDITOR) ? SM_GENRANDLAND : SM_NEWGAME; break;
274 case GLWM_HEIGHTMAP: _switch_mode = (_game_mode == GM_EDITOR) ? SM_LOAD_HEIGHTMAP : SM_START_HEIGHTMAP; break;
275 case GLWM_SCENARIO: _switch_mode = SM_EDITOR; break;
276 default: NOT_REACHED();
280 static void LandscapeGenerationCallback(Window *w, bool confirmed)
282 if (confirmed) StartGeneratingLandscape((GenerateLandscapeWindowMode)w->window_number);
285 static DropDownList BuildMapsizeDropDown()
287 DropDownList list;
289 for (uint i = MIN_MAP_SIZE_BITS; i <= MAX_MAP_SIZE_BITS; i++) {
290 DropDownListParamStringItem *item = new DropDownListParamStringItem(STR_JUST_INT, i, false);
291 item->SetParam(0, 1LL << i);
292 list.emplace_back(item);
295 return list;
298 static DropDownList BuildTownNameDropDown()
300 DropDownList list;
302 /* Add and sort newgrf townnames generators */
303 const auto &grf_names = GetGRFTownNameList();
304 for (uint i = 0; i < grf_names.size(); i++) {
305 list.emplace_back(new DropDownListStringItem(grf_names[i], BUILTIN_TOWNNAME_GENERATOR_COUNT + i, false));
307 std::sort(list.begin(), list.end(), DropDownListStringItem::NatSortFunc);
309 size_t newgrf_size = list.size();
310 /* Insert newgrf_names at the top of the list */
311 if (newgrf_size > 0) {
312 list.emplace_back(new DropDownListItem(-1, false)); // separator line
313 newgrf_size++;
316 /* Add and sort original townnames generators */
317 for (uint i = 0; i < BUILTIN_TOWNNAME_GENERATOR_COUNT; i++) {
318 list.emplace_back(new DropDownListStringItem(STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + i, i, false));
320 std::sort(list.begin() + newgrf_size, list.end(), DropDownListStringItem::NatSortFunc);
322 return list;
326 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};
327 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};
328 static const StringID _rivers[] = {STR_RIVERS_NONE, STR_RIVERS_FEW, STR_RIVERS_MODERATE, STR_RIVERS_LOT, INVALID_STRING_ID};
329 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};
330 static const StringID _rotation[] = {STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_COUNTER_CLOCKWISE, STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_CLOCKWISE, INVALID_STRING_ID};
331 static const StringID _landscape[] = {STR_CONFIG_SETTING_LAND_GENERATOR_ORIGINAL, STR_CONFIG_SETTING_LAND_GENERATOR_TERRA_GENESIS, INVALID_STRING_ID};
332 static const StringID _num_towns[] = {STR_NUM_VERY_LOW, STR_NUM_LOW, STR_NUM_NORMAL, STR_NUM_HIGH, STR_NUM_CUSTOM, INVALID_STRING_ID};
333 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};
334 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};
336 static_assert(lengthof(_num_inds) == ID_END + 1);
338 struct GenerateLandscapeWindow : public Window {
339 uint widget_id;
340 uint x;
341 uint y;
342 char name[64];
343 GenerateLandscapeWindowMode mode;
345 GenerateLandscapeWindow(WindowDesc *desc, WindowNumber number = 0) : Window(desc)
347 this->InitNested(number);
349 this->LowerWidget(_settings_newgame.game_creation.landscape + WID_GL_TEMPERATE);
351 this->mode = (GenerateLandscapeWindowMode)this->window_number;
353 /* Disable town and industry in SE */
354 this->SetWidgetDisabledState(WID_GL_TOWN_PULLDOWN, _game_mode == GM_EDITOR);
355 this->SetWidgetDisabledState(WID_GL_INDUSTRY_PULLDOWN, _game_mode == GM_EDITOR);
357 this->OnInvalidateData();
361 void SetStringParameters(int widget) const override
363 switch (widget) {
364 case WID_GL_START_DATE_TEXT: SetDParam(0, ConvertYMDToDate(_settings_newgame.game_creation.starting_year, 0, 1)); break;
365 case WID_GL_MAPSIZE_X_PULLDOWN: SetDParam(0, 1LL << _settings_newgame.game_creation.map_x); break;
366 case WID_GL_MAPSIZE_Y_PULLDOWN: SetDParam(0, 1LL << _settings_newgame.game_creation.map_y); break;
367 case WID_GL_MAX_HEIGHTLEVEL_TEXT: SetDParam(0, _settings_newgame.construction.max_heightlevel); break;
368 case WID_GL_SNOW_LEVEL_TEXT: SetDParam(0, _settings_newgame.game_creation.snow_line_height); break;
370 case WID_GL_TOWN_PULLDOWN:
371 if (_game_mode == GM_EDITOR) {
372 SetDParam(0, STR_CONFIG_SETTING_OFF);
373 } else if (_settings_newgame.difficulty.number_towns == CUSTOM_TOWN_NUMBER_DIFFICULTY) {
374 SetDParam(0, STR_NUM_CUSTOM_NUMBER);
375 SetDParam(1, _settings_newgame.game_creation.custom_town_number);
376 } else {
377 SetDParam(0, _num_towns[_settings_newgame.difficulty.number_towns]);
379 break;
381 case WID_GL_TOWNNAME_DROPDOWN: {
382 uint gen = _settings_newgame.game_creation.town_name;
383 StringID name = gen < BUILTIN_TOWNNAME_GENERATOR_COUNT ?
384 STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + gen :
385 GetGRFTownNameName(gen - BUILTIN_TOWNNAME_GENERATOR_COUNT);
386 SetDParam(0, name);
387 break;
390 case WID_GL_INDUSTRY_PULLDOWN: SetDParam(0, _game_mode == GM_EDITOR ? STR_CONFIG_SETTING_OFF : _num_inds[_settings_newgame.difficulty.industry_density]); break;
391 case WID_GL_LANDSCAPE_PULLDOWN: SetDParam(0, _landscape[_settings_newgame.game_creation.land_generator]); break;
392 case WID_GL_TERRAIN_PULLDOWN: SetDParam(0, _elevations[_settings_newgame.difficulty.terrain_type]); break;
394 case WID_GL_WATER_PULLDOWN:
395 if (_settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
396 SetDParam(0, STR_SEA_LEVEL_CUSTOM_PERCENTAGE);
397 SetDParam(1, _settings_newgame.game_creation.custom_sea_level);
398 } else {
399 SetDParam(0, _sea_lakes[_settings_newgame.difficulty.quantity_sea_lakes]);
401 break;
403 case WID_GL_RIVER_PULLDOWN: SetDParam(0, _rivers[_settings_newgame.game_creation.amount_of_rivers]); break;
404 case WID_GL_SMOOTHNESS_PULLDOWN: SetDParam(0, _smoothness[_settings_newgame.game_creation.tgen_smoothness]); break;
405 case WID_GL_VARIETY_PULLDOWN: SetDParam(0, _variety[_settings_newgame.game_creation.variety]); break;
406 case WID_GL_BORDERS_RANDOM: SetDParam(0, (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? STR_MAPGEN_BORDER_RANDOMIZE : STR_MAPGEN_BORDER_MANUAL); break;
407 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;
408 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;
409 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;
410 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;
411 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: SetDParam(0, _rotation[_settings_newgame.game_creation.heightmap_rotation]); break;
413 case WID_GL_HEIGHTMAP_SIZE_TEXT:
414 if (_settings_newgame.game_creation.heightmap_rotation == HM_CLOCKWISE) {
415 SetDParam(0, this->y);
416 SetDParam(1, this->x);
417 } else {
418 SetDParam(0, this->x);
419 SetDParam(1, this->y);
421 break;
426 * Some data on this window has become invalid.
427 * @param data Information about the changed data.
428 * @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.
430 void OnInvalidateData(int data = 0, bool gui_scope = true) override
432 if (!gui_scope) return;
433 /* Update the climate buttons */
434 this->SetWidgetLoweredState(WID_GL_TEMPERATE, _settings_newgame.game_creation.landscape == LT_TEMPERATE);
435 this->SetWidgetLoweredState(WID_GL_ARCTIC, _settings_newgame.game_creation.landscape == LT_ARCTIC);
436 this->SetWidgetLoweredState(WID_GL_TROPICAL, _settings_newgame.game_creation.landscape == LT_TROPIC);
437 this->SetWidgetLoweredState(WID_GL_TOYLAND, _settings_newgame.game_creation.landscape == LT_TOYLAND);
439 /* You can't select smoothness / non-water borders if not terragenesis */
440 if (mode == GLWM_GENERATE) {
441 this->SetWidgetDisabledState(WID_GL_SMOOTHNESS_PULLDOWN, _settings_newgame.game_creation.land_generator == LG_ORIGINAL);
442 this->SetWidgetDisabledState(WID_GL_VARIETY_PULLDOWN, _settings_newgame.game_creation.land_generator == LG_ORIGINAL);
443 this->SetWidgetDisabledState(WID_GL_BORDERS_RANDOM, _settings_newgame.game_creation.land_generator == LG_ORIGINAL || !_settings_newgame.construction.freeform_edges);
444 this->SetWidgetsDisabledState(_settings_newgame.game_creation.land_generator == LG_ORIGINAL || !_settings_newgame.construction.freeform_edges || _settings_newgame.game_creation.water_borders == BORDERS_RANDOM,
445 WID_GL_WATER_NW, WID_GL_WATER_NE, WID_GL_WATER_SE, WID_GL_WATER_SW, WIDGET_LIST_END);
447 this->SetWidgetLoweredState(WID_GL_BORDERS_RANDOM, _settings_newgame.game_creation.water_borders == BORDERS_RANDOM);
449 this->SetWidgetLoweredState(WID_GL_WATER_NW, HasBit(_settings_newgame.game_creation.water_borders, BORDER_NW));
450 this->SetWidgetLoweredState(WID_GL_WATER_NE, HasBit(_settings_newgame.game_creation.water_borders, BORDER_NE));
451 this->SetWidgetLoweredState(WID_GL_WATER_SE, HasBit(_settings_newgame.game_creation.water_borders, BORDER_SE));
452 this->SetWidgetLoweredState(WID_GL_WATER_SW, HasBit(_settings_newgame.game_creation.water_borders, BORDER_SW));
454 this->SetWidgetsDisabledState(_settings_newgame.game_creation.land_generator == LG_ORIGINAL && (_settings_newgame.game_creation.landscape == LT_ARCTIC || _settings_newgame.game_creation.landscape == LT_TROPIC),
455 WID_GL_TERRAIN_PULLDOWN, WID_GL_WATER_PULLDOWN, WIDGET_LIST_END);
458 /* Disable snowline if not arctic */
459 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_TEXT, _settings_newgame.game_creation.landscape != LT_ARCTIC);
461 /* Update availability of decreasing / increasing start date and snow level */
462 this->SetWidgetDisabledState(WID_GL_MAX_HEIGHTLEVEL_DOWN, _settings_newgame.construction.max_heightlevel <= MIN_MAX_HEIGHTLEVEL);
463 this->SetWidgetDisabledState(WID_GL_MAX_HEIGHTLEVEL_UP, _settings_newgame.construction.max_heightlevel >= MAX_MAX_HEIGHTLEVEL);
464 this->SetWidgetDisabledState(WID_GL_START_DATE_DOWN, _settings_newgame.game_creation.starting_year <= MIN_YEAR);
465 this->SetWidgetDisabledState(WID_GL_START_DATE_UP, _settings_newgame.game_creation.starting_year >= MAX_YEAR);
466 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_DOWN, _settings_newgame.game_creation.snow_line_height <= MIN_SNOWLINE_HEIGHT || _settings_newgame.game_creation.landscape != LT_ARCTIC);
467 this->SetWidgetDisabledState(WID_GL_SNOW_LEVEL_UP, _settings_newgame.game_creation.snow_line_height >= MAX_SNOWLINE_HEIGHT || _settings_newgame.game_creation.landscape != LT_ARCTIC);
469 /* Do not allow a custom sea level with the original land generator. */
470 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL &&
471 _settings_newgame.difficulty.quantity_sea_lakes == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
472 _settings_newgame.difficulty.quantity_sea_lakes = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE;
477 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
479 const StringID *strs = nullptr;
480 switch (widget) {
481 case WID_GL_MAX_HEIGHTLEVEL_TEXT:
482 SetDParam(0, MAX_TILE_HEIGHT);
483 *size = GetStringBoundingBox(STR_JUST_INT);
484 break;
486 case WID_GL_START_DATE_TEXT:
487 SetDParam(0, ConvertYMDToDate(MAX_YEAR, 0, 1));
488 *size = maxdim(*size, GetStringBoundingBox(STR_BLACK_DATE_LONG));
489 break;
491 case WID_GL_MAPSIZE_X_PULLDOWN:
492 case WID_GL_MAPSIZE_Y_PULLDOWN:
493 SetDParamMaxValue(0, MAX_MAP_SIZE);
494 *size = maxdim(*size, GetStringBoundingBox(STR_JUST_INT));
495 break;
497 case WID_GL_SNOW_LEVEL_TEXT:
498 SetDParamMaxValue(0, MAX_TILE_HEIGHT);
499 *size = maxdim(*size, GetStringBoundingBox(STR_JUST_INT));
500 break;
502 case WID_GL_HEIGHTMAP_SIZE_TEXT:
503 SetDParam(0, this->x);
504 SetDParam(1, this->y);
505 *size = maxdim(*size, GetStringBoundingBox(STR_MAPGEN_HEIGHTMAP_SIZE));
506 break;
508 case WID_GL_TOWN_PULLDOWN:
509 strs = _num_towns;
510 SetDParamMaxValue(0, CUSTOM_TOWN_MAX_NUMBER);
511 *size = maxdim(*size, GetStringBoundingBox(STR_NUM_CUSTOM_NUMBER));
512 break;
514 case WID_GL_INDUSTRY_PULLDOWN: strs = _num_inds; break;
515 case WID_GL_LANDSCAPE_PULLDOWN: strs = _landscape; break;
516 case WID_GL_TERRAIN_PULLDOWN: strs = _elevations; break;
517 case WID_GL_WATER_PULLDOWN:
518 strs = _sea_lakes;
519 SetDParamMaxValue(0, CUSTOM_SEA_LEVEL_MAX_PERCENTAGE);
520 *size = maxdim(*size, GetStringBoundingBox(STR_SEA_LEVEL_CUSTOM_PERCENTAGE));
521 break;
523 case WID_GL_RIVER_PULLDOWN: strs = _rivers; break;
524 case WID_GL_SMOOTHNESS_PULLDOWN: strs = _smoothness; break;
525 case WID_GL_VARIETY_PULLDOWN: strs = _variety; break;
526 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: strs = _rotation; break;
527 case WID_GL_BORDERS_RANDOM:
528 *size = maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_RANDOMIZE), GetStringBoundingBox(STR_MAPGEN_BORDER_MANUAL));
529 break;
531 case WID_GL_WATER_NE:
532 case WID_GL_WATER_NW:
533 case WID_GL_WATER_SE:
534 case WID_GL_WATER_SW:
535 *size = maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_RANDOM), maxdim(GetStringBoundingBox(STR_MAPGEN_BORDER_WATER), GetStringBoundingBox(STR_MAPGEN_BORDER_FREEFORM)));
536 break;
538 case WID_GL_HEIGHTMAP_NAME_TEXT:
539 size->width = 0;
540 break;
542 default:
543 return;
545 if (strs != nullptr) {
546 while (*strs != INVALID_STRING_ID) {
547 *size = maxdim(*size, GetStringBoundingBox(*strs++));
550 size->width += padding.width;
551 size->height = std::max(size->height, (uint)(FONT_HEIGHT_NORMAL + WD_DROPDOWNTEXT_TOP + WD_DROPDOWNTEXT_BOTTOM));
554 void DrawWidget(const Rect &r, int widget) const override
556 switch (widget) {
557 case WID_GL_HEIGHTMAP_NAME_TEXT: {
558 DrawString(r.left, r.right, r.top, this->name, TC_ORANGE);
559 break;
564 void OnClick(Point pt, int widget, int click_count) override
566 switch (widget) {
567 case WID_GL_TEMPERATE:
568 case WID_GL_ARCTIC:
569 case WID_GL_TROPICAL:
570 case WID_GL_TOYLAND:
571 SetNewLandscapeType(widget - WID_GL_TEMPERATE);
572 break;
574 case WID_GL_MAPSIZE_X_PULLDOWN: // Mapsize X
575 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_x, WID_GL_MAPSIZE_X_PULLDOWN);
576 break;
578 case WID_GL_MAPSIZE_Y_PULLDOWN: // Mapsize Y
579 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_y, WID_GL_MAPSIZE_Y_PULLDOWN);
580 break;
582 case WID_GL_TOWN_PULLDOWN: // Number of towns
583 ShowDropDownMenu(this, _num_towns, _settings_newgame.difficulty.number_towns, WID_GL_TOWN_PULLDOWN, 0, 0);
584 break;
586 case WID_GL_TOWNNAME_DROPDOWN: // Townname generator
587 ShowDropDownList(this, BuildTownNameDropDown(), _settings_newgame.game_creation.town_name, WID_GL_TOWNNAME_DROPDOWN);
588 break;
590 case WID_GL_INDUSTRY_PULLDOWN: // Number of industries
591 ShowDropDownMenu(this, _num_inds, _settings_newgame.difficulty.industry_density, WID_GL_INDUSTRY_PULLDOWN, 0, 0);
592 break;
594 case WID_GL_GENERATE_BUTTON: { // Generate
595 /* Get rotated map size. */
596 uint map_x;
597 uint map_y;
598 if (_settings_newgame.game_creation.heightmap_rotation == HM_CLOCKWISE) {
599 map_x = this->y;
600 map_y = this->x;
601 } else {
602 map_x = this->x;
603 map_y = this->y;
605 if (mode == GLWM_HEIGHTMAP &&
606 (map_x * 2 < (1U << _settings_newgame.game_creation.map_x) ||
607 map_x / 2 > (1U << _settings_newgame.game_creation.map_x) ||
608 map_y * 2 < (1U << _settings_newgame.game_creation.map_y) ||
609 map_y / 2 > (1U << _settings_newgame.game_creation.map_y))) {
610 ShowQuery(
611 STR_WARNING_HEIGHTMAP_SCALE_CAPTION,
612 STR_WARNING_HEIGHTMAP_SCALE_MESSAGE,
613 this,
614 LandscapeGenerationCallback);
615 } else {
616 StartGeneratingLandscape(mode);
618 break;
621 case WID_GL_MAX_HEIGHTLEVEL_DOWN:
622 case WID_GL_MAX_HEIGHTLEVEL_UP: // Height level buttons
623 /* Don't allow too fast scrolling */
624 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
625 this->HandleButtonClick(widget);
627 _settings_newgame.construction.max_heightlevel = Clamp(_settings_newgame.construction.max_heightlevel + widget - WID_GL_MAX_HEIGHTLEVEL_TEXT, MIN_MAX_HEIGHTLEVEL, MAX_MAX_HEIGHTLEVEL);
628 this->InvalidateData();
630 _left_button_clicked = false;
631 break;
633 case WID_GL_MAX_HEIGHTLEVEL_TEXT: // Height level text
634 this->widget_id = WID_GL_MAX_HEIGHTLEVEL_TEXT;
635 SetDParam(0, _settings_newgame.construction.max_heightlevel);
636 ShowQueryString(STR_JUST_INT, STR_MAPGEN_MAX_HEIGHTLEVEL_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
637 break;
640 case WID_GL_START_DATE_DOWN:
641 case WID_GL_START_DATE_UP: // Year buttons
642 /* Don't allow too fast scrolling */
643 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
644 this->HandleButtonClick(widget);
646 _settings_newgame.game_creation.starting_year = Clamp(_settings_newgame.game_creation.starting_year + widget - WID_GL_START_DATE_TEXT, MIN_YEAR, MAX_YEAR);
647 this->InvalidateData();
649 _left_button_clicked = false;
650 break;
652 case WID_GL_START_DATE_TEXT: // Year text
653 this->widget_id = WID_GL_START_DATE_TEXT;
654 SetDParam(0, _settings_newgame.game_creation.starting_year);
655 ShowQueryString(STR_JUST_INT, STR_MAPGEN_START_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
656 break;
658 case WID_GL_SNOW_LEVEL_DOWN:
659 case WID_GL_SNOW_LEVEL_UP: // Snow line buttons
660 /* Don't allow too fast scrolling */
661 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
662 this->HandleButtonClick(widget);
664 _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);
665 this->InvalidateData();
667 _left_button_clicked = false;
668 break;
670 case WID_GL_SNOW_LEVEL_TEXT: // Snow line text
671 this->widget_id = WID_GL_SNOW_LEVEL_TEXT;
672 SetDParam(0, _settings_newgame.game_creation.snow_line_height);
673 ShowQueryString(STR_JUST_INT, STR_MAPGEN_SNOW_LINE_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_ENABLE_DEFAULT);
674 break;
676 case WID_GL_LANDSCAPE_PULLDOWN: // Landscape generator
677 ShowDropDownMenu(this, _landscape, _settings_newgame.game_creation.land_generator, WID_GL_LANDSCAPE_PULLDOWN, 0, 0);
678 break;
680 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: // Heightmap rotation
681 ShowDropDownMenu(this, _rotation, _settings_newgame.game_creation.heightmap_rotation, WID_GL_HEIGHTMAP_ROTATION_PULLDOWN, 0, 0);
682 break;
684 case WID_GL_TERRAIN_PULLDOWN: // Terrain type
685 /* For the original map generation only the first four are valid. */
686 ShowDropDownMenu(this, _elevations, _settings_newgame.difficulty.terrain_type, WID_GL_TERRAIN_PULLDOWN, 0, _settings_newgame.game_creation.land_generator == LG_ORIGINAL ? ~0xF : 0);
687 break;
689 case WID_GL_WATER_PULLDOWN: { // Water quantity
690 uint32 hidden_mask = 0;
691 /* Disable custom water level when the original map generator is active. */
692 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL) {
693 SetBit(hidden_mask, CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY);
695 ShowDropDownMenu(this, _sea_lakes, _settings_newgame.difficulty.quantity_sea_lakes, WID_GL_WATER_PULLDOWN, 0, hidden_mask);
696 break;
699 case WID_GL_RIVER_PULLDOWN: // Amount of rivers
700 ShowDropDownMenu(this, _rivers, _settings_newgame.game_creation.amount_of_rivers, WID_GL_RIVER_PULLDOWN, 0, 0);
701 break;
703 case WID_GL_SMOOTHNESS_PULLDOWN: // Map smoothness
704 ShowDropDownMenu(this, _smoothness, _settings_newgame.game_creation.tgen_smoothness, WID_GL_SMOOTHNESS_PULLDOWN, 0, 0);
705 break;
707 case WID_GL_VARIETY_PULLDOWN: // Map variety
708 ShowDropDownMenu(this, _variety, _settings_newgame.game_creation.variety, WID_GL_VARIETY_PULLDOWN, 0, 0);
709 break;
711 /* Freetype map borders */
712 case WID_GL_WATER_NW:
713 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_NW);
714 this->InvalidateData();
715 break;
717 case WID_GL_WATER_NE:
718 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_NE);
719 this->InvalidateData();
720 break;
722 case WID_GL_WATER_SE:
723 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_SE);
724 this->InvalidateData();
725 break;
727 case WID_GL_WATER_SW:
728 _settings_newgame.game_creation.water_borders = ToggleBit(_settings_newgame.game_creation.water_borders, BORDER_SW);
729 this->InvalidateData();
730 break;
732 case WID_GL_BORDERS_RANDOM:
733 _settings_newgame.game_creation.water_borders = (_settings_newgame.game_creation.water_borders == BORDERS_RANDOM) ? 0 : BORDERS_RANDOM;
734 this->InvalidateData();
735 break;
739 void OnTimeout() override
741 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};
742 for (const int *widget = raise_widgets; *widget != WIDGET_LIST_END; widget++) {
743 if (this->IsWidgetLowered(*widget)) {
744 this->RaiseWidget(*widget);
745 this->SetWidgetDirty(*widget);
750 void OnDropdownSelect(int widget, int index) override
752 switch (widget) {
753 case WID_GL_MAPSIZE_X_PULLDOWN: _settings_newgame.game_creation.map_x = index; break;
754 case WID_GL_MAPSIZE_Y_PULLDOWN: _settings_newgame.game_creation.map_y = index; break;
755 case WID_GL_RIVER_PULLDOWN: _settings_newgame.game_creation.amount_of_rivers = index; break;
756 case WID_GL_SMOOTHNESS_PULLDOWN: _settings_newgame.game_creation.tgen_smoothness = index; break;
757 case WID_GL_VARIETY_PULLDOWN: _settings_newgame.game_creation.variety = index; break;
759 case WID_GL_LANDSCAPE_PULLDOWN: _settings_newgame.game_creation.land_generator = index;
760 /* If original landgenerator is selected and alpinist terrain_type was selected, revert to mountainous. */
761 if (_settings_newgame.game_creation.land_generator == LG_ORIGINAL) {
762 _settings_newgame.difficulty.terrain_type = Clamp(_settings_newgame.difficulty.terrain_type, 0, 3);
764 break;
766 case WID_GL_HEIGHTMAP_ROTATION_PULLDOWN: _settings_newgame.game_creation.heightmap_rotation = index; break;
768 case WID_GL_TOWN_PULLDOWN:
769 if ((uint)index == CUSTOM_TOWN_NUMBER_DIFFICULTY) {
770 this->widget_id = widget;
771 SetDParam(0, _settings_newgame.game_creation.custom_town_number);
772 ShowQueryString(STR_JUST_INT, STR_MAPGEN_NUMBER_OF_TOWNS, 5, this, CS_NUMERAL, QSF_NONE);
774 _settings_newgame.difficulty.number_towns = index;
775 break;
777 case WID_GL_TOWNNAME_DROPDOWN: // Town names
778 if (_game_mode == GM_MENU || Town::GetNumItems() == 0) {
779 _settings_newgame.game_creation.town_name = index;
780 SetWindowDirty(WC_GAME_OPTIONS, WN_GAME_OPTIONS_GAME_OPTIONS);
782 break;
784 case WID_GL_INDUSTRY_PULLDOWN: _settings_newgame.difficulty.industry_density = index; break;
785 case WID_GL_TERRAIN_PULLDOWN: _settings_newgame.difficulty.terrain_type = index; break;
787 case WID_GL_WATER_PULLDOWN: {
788 if ((uint)index == CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY) {
789 this->widget_id = widget;
790 SetDParam(0, _settings_newgame.game_creation.custom_sea_level);
791 ShowQueryString(STR_JUST_INT, STR_MAPGEN_QUANTITY_OF_SEA_LAKES, 3, this, CS_NUMERAL, QSF_NONE);
793 _settings_newgame.difficulty.quantity_sea_lakes = index;
794 break;
797 this->InvalidateData();
800 void OnQueryTextFinished(char *str) override
802 /* Was 'cancel' pressed? */
803 if (str == nullptr) return;
805 int32 value;
806 if (!StrEmpty(str)) {
807 value = atoi(str);
808 } else {
809 /* An empty string means revert to the default */
810 switch (this->widget_id) {
811 case WID_GL_MAX_HEIGHTLEVEL_TEXT: value = DEF_MAX_HEIGHTLEVEL; break;
812 case WID_GL_START_DATE_TEXT: value = DEF_START_YEAR; break;
813 case WID_GL_SNOW_LEVEL_TEXT: value = DEF_SNOWLINE_HEIGHT; break;
814 case WID_GL_TOWN_PULLDOWN: value = 1; break;
815 case WID_GL_WATER_PULLDOWN: value = CUSTOM_SEA_LEVEL_MIN_PERCENTAGE; break;
816 default: NOT_REACHED();
820 switch (this->widget_id) {
821 case WID_GL_MAX_HEIGHTLEVEL_TEXT:
822 this->SetWidgetDirty(WID_GL_MAX_HEIGHTLEVEL_TEXT);
823 _settings_newgame.construction.max_heightlevel = Clamp(value, MIN_MAX_HEIGHTLEVEL, MAX_MAX_HEIGHTLEVEL);
824 break;
826 case WID_GL_START_DATE_TEXT:
827 this->SetWidgetDirty(WID_GL_START_DATE_TEXT);
828 _settings_newgame.game_creation.starting_year = Clamp(value, MIN_YEAR, MAX_YEAR);
829 break;
831 case WID_GL_SNOW_LEVEL_TEXT:
832 this->SetWidgetDirty(WID_GL_SNOW_LEVEL_TEXT);
833 _settings_newgame.game_creation.snow_line_height = Clamp(value, MIN_SNOWLINE_HEIGHT, MAX_SNOWLINE_HEIGHT);
834 break;
836 case WID_GL_TOWN_PULLDOWN:
837 _settings_newgame.game_creation.custom_town_number = Clamp(value, 1, CUSTOM_TOWN_MAX_NUMBER);
838 break;
840 case WID_GL_WATER_PULLDOWN:
841 _settings_newgame.game_creation.custom_sea_level = Clamp(value, CUSTOM_SEA_LEVEL_MIN_PERCENTAGE, CUSTOM_SEA_LEVEL_MAX_PERCENTAGE);
842 break;
845 this->InvalidateData();
849 static WindowDesc _generate_landscape_desc(
850 WDP_CENTER, nullptr, 0, 0,
851 WC_GENERATE_LANDSCAPE, WC_NONE,
853 _nested_generate_landscape_widgets, lengthof(_nested_generate_landscape_widgets)
856 static WindowDesc _heightmap_load_desc(
857 WDP_CENTER, nullptr, 0, 0,
858 WC_GENERATE_LANDSCAPE, WC_NONE,
860 _nested_heightmap_load_widgets, lengthof(_nested_heightmap_load_widgets)
863 static void _ShowGenerateLandscape(GenerateLandscapeWindowMode mode)
865 uint x = 0;
866 uint y = 0;
868 DeleteWindowByClass(WC_GENERATE_LANDSCAPE);
870 /* Generate a new seed when opening the window */
871 _settings_newgame.game_creation.generation_seed = InteractiveRandom();
873 if (mode == GLWM_HEIGHTMAP) {
874 /* If the function returns negative, it means there was a problem loading the heightmap */
875 if (!GetHeightmapDimensions(_file_to_saveload.detail_ftype, _file_to_saveload.name.c_str(), &x, &y)) return;
878 WindowDesc *desc = (mode == GLWM_HEIGHTMAP) ? &_heightmap_load_desc : &_generate_landscape_desc;
879 GenerateLandscapeWindow *w = AllocateWindowDescFront<GenerateLandscapeWindow>(desc, mode, true);
881 if (mode == GLWM_HEIGHTMAP) {
882 w->x = x;
883 w->y = y;
884 strecpy(w->name, _file_to_saveload.title, lastof(w->name));
887 SetWindowDirty(WC_GENERATE_LANDSCAPE, mode);
890 /** Start with a normal game. */
891 void ShowGenerateLandscape()
893 _ShowGenerateLandscape(GLWM_GENERATE);
896 /** Start with loading a heightmap. */
897 void ShowHeightmapLoad()
899 _ShowGenerateLandscape(GLWM_HEIGHTMAP);
902 /** Start with a scenario editor. */
903 void StartScenarioEditor()
905 StartGeneratingLandscape(GLWM_SCENARIO);
909 * Start a normal game without the GUI.
910 * @param seed The seed of the new game.
912 void StartNewGameWithoutGUI(uint32 seed)
914 /* GenerateWorld takes care of the possible GENERATE_NEW_SEED value in 'seed' */
915 _settings_newgame.game_creation.generation_seed = seed;
917 StartGeneratingLandscape(GLWM_GENERATE);
920 struct CreateScenarioWindow : public Window
922 uint widget_id;
924 CreateScenarioWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
926 this->InitNested(window_number);
927 this->LowerWidget(_settings_newgame.game_creation.landscape + WID_CS_TEMPERATE);
930 void SetStringParameters(int widget) const override
932 switch (widget) {
933 case WID_CS_START_DATE_TEXT:
934 SetDParam(0, ConvertYMDToDate(_settings_newgame.game_creation.starting_year, 0, 1));
935 break;
937 case WID_CS_MAPSIZE_X_PULLDOWN:
938 SetDParam(0, 1LL << _settings_newgame.game_creation.map_x);
939 break;
941 case WID_CS_MAPSIZE_Y_PULLDOWN:
942 SetDParam(0, 1LL << _settings_newgame.game_creation.map_y);
943 break;
945 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
946 SetDParam(0, _settings_newgame.game_creation.se_flat_world_height);
947 break;
951 void OnPaint() override
953 this->SetWidgetDisabledState(WID_CS_START_DATE_DOWN, _settings_newgame.game_creation.starting_year <= MIN_YEAR);
954 this->SetWidgetDisabledState(WID_CS_START_DATE_UP, _settings_newgame.game_creation.starting_year >= MAX_YEAR);
955 this->SetWidgetDisabledState(WID_CS_FLAT_LAND_HEIGHT_DOWN, _settings_newgame.game_creation.se_flat_world_height <= 0);
956 this->SetWidgetDisabledState(WID_CS_FLAT_LAND_HEIGHT_UP, _settings_newgame.game_creation.se_flat_world_height >= MAX_TILE_HEIGHT);
958 this->SetWidgetLoweredState(WID_CS_TEMPERATE, _settings_newgame.game_creation.landscape == LT_TEMPERATE);
959 this->SetWidgetLoweredState(WID_CS_ARCTIC, _settings_newgame.game_creation.landscape == LT_ARCTIC);
960 this->SetWidgetLoweredState(WID_CS_TROPICAL, _settings_newgame.game_creation.landscape == LT_TROPIC);
961 this->SetWidgetLoweredState(WID_CS_TOYLAND, _settings_newgame.game_creation.landscape == LT_TOYLAND);
963 this->DrawWidgets();
966 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
968 StringID str = STR_JUST_INT;
969 switch (widget) {
970 case WID_CS_START_DATE_TEXT:
971 SetDParam(0, ConvertYMDToDate(MAX_YEAR, 0, 1));
972 str = STR_BLACK_DATE_LONG;
973 break;
975 case WID_CS_MAPSIZE_X_PULLDOWN:
976 case WID_CS_MAPSIZE_Y_PULLDOWN:
977 SetDParamMaxValue(0, MAX_MAP_SIZE);
978 break;
980 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
981 SetDParamMaxValue(0, MAX_TILE_HEIGHT);
982 break;
984 default:
985 return;
987 *size = maxdim(*size, GetStringBoundingBox(str));
988 size->width += padding.width;
989 size->height += padding.height;
992 void OnClick(Point pt, int widget, int click_count) override
994 switch (widget) {
995 case WID_CS_TEMPERATE:
996 case WID_CS_ARCTIC:
997 case WID_CS_TROPICAL:
998 case WID_CS_TOYLAND:
999 this->RaiseWidget(_settings_newgame.game_creation.landscape + WID_CS_TEMPERATE);
1000 SetNewLandscapeType(widget - WID_CS_TEMPERATE);
1001 break;
1003 case WID_CS_MAPSIZE_X_PULLDOWN: // Mapsize X
1004 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_x, WID_CS_MAPSIZE_X_PULLDOWN);
1005 break;
1007 case WID_CS_MAPSIZE_Y_PULLDOWN: // Mapsize Y
1008 ShowDropDownList(this, BuildMapsizeDropDown(), _settings_newgame.game_creation.map_y, WID_CS_MAPSIZE_Y_PULLDOWN);
1009 break;
1011 case WID_CS_EMPTY_WORLD: // Empty world / flat world
1012 StartGeneratingLandscape(GLWM_SCENARIO);
1013 break;
1015 case WID_CS_RANDOM_WORLD: // Generate
1016 ShowGenerateLandscape();
1017 break;
1019 case WID_CS_START_DATE_DOWN:
1020 case WID_CS_START_DATE_UP: // Year buttons
1021 /* Don't allow too fast scrolling */
1022 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
1023 this->HandleButtonClick(widget);
1024 this->SetDirty();
1026 _settings_newgame.game_creation.starting_year = Clamp(_settings_newgame.game_creation.starting_year + widget - WID_CS_START_DATE_TEXT, MIN_YEAR, MAX_YEAR);
1028 _left_button_clicked = false;
1029 break;
1031 case WID_CS_START_DATE_TEXT: // Year text
1032 this->widget_id = WID_CS_START_DATE_TEXT;
1033 SetDParam(0, _settings_newgame.game_creation.starting_year);
1034 ShowQueryString(STR_JUST_INT, STR_MAPGEN_START_DATE_QUERY_CAPT, 8, this, CS_NUMERAL, QSF_NONE);
1035 break;
1037 case WID_CS_FLAT_LAND_HEIGHT_DOWN:
1038 case WID_CS_FLAT_LAND_HEIGHT_UP: // Height level buttons
1039 /* Don't allow too fast scrolling */
1040 if (!(this->flags & WF_TIMEOUT) || this->timeout_timer <= 1) {
1041 this->HandleButtonClick(widget);
1042 this->SetDirty();
1044 _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);
1046 _left_button_clicked = false;
1047 break;
1049 case WID_CS_FLAT_LAND_HEIGHT_TEXT: // Height level text
1050 this->widget_id = WID_CS_FLAT_LAND_HEIGHT_TEXT;
1051 SetDParam(0, _settings_newgame.game_creation.se_flat_world_height);
1052 ShowQueryString(STR_JUST_INT, STR_SE_MAPGEN_FLAT_WORLD_HEIGHT_QUERY_CAPT, 4, this, CS_NUMERAL, QSF_NONE);
1053 break;
1057 void OnTimeout() override
1059 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};
1060 for (const int *widget = raise_widgets; *widget != WIDGET_LIST_END; widget++) {
1061 if (this->IsWidgetLowered(*widget)) {
1062 this->RaiseWidget(*widget);
1063 this->SetWidgetDirty(*widget);
1068 void OnDropdownSelect(int widget, int index) override
1070 switch (widget) {
1071 case WID_CS_MAPSIZE_X_PULLDOWN: _settings_newgame.game_creation.map_x = index; break;
1072 case WID_CS_MAPSIZE_Y_PULLDOWN: _settings_newgame.game_creation.map_y = index; break;
1074 this->SetDirty();
1077 void OnQueryTextFinished(char *str) override
1079 if (!StrEmpty(str)) {
1080 int32 value = atoi(str);
1082 switch (this->widget_id) {
1083 case WID_CS_START_DATE_TEXT:
1084 this->SetWidgetDirty(WID_CS_START_DATE_TEXT);
1085 _settings_newgame.game_creation.starting_year = Clamp(value, MIN_YEAR, MAX_YEAR);
1086 break;
1088 case WID_CS_FLAT_LAND_HEIGHT_TEXT:
1089 this->SetWidgetDirty(WID_CS_FLAT_LAND_HEIGHT_TEXT);
1090 _settings_newgame.game_creation.se_flat_world_height = Clamp(value, 0, _settings_game.construction.max_heightlevel);
1091 break;
1094 this->SetDirty();
1099 static const NWidgetPart _nested_create_scenario_widgets[] = {
1100 NWidget(NWID_HORIZONTAL),
1101 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1102 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_SE_MAPGEN_CAPTION, STR_NULL),
1103 EndContainer(),
1104 NWidget(WWT_PANEL, COLOUR_BROWN),
1105 NWidget(NWID_SPACER), SetMinimalSize(0, 10),
1106 /* Landscape style selection. */
1107 NWidget(NWID_HORIZONTAL), SetPIP(10, 3, 10),
1108 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TEMPERATE), SetDataTip(SPR_SELECT_TEMPERATE, STR_INTRO_TOOLTIP_TEMPERATE),
1109 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_ARCTIC), SetDataTip(SPR_SELECT_SUB_ARCTIC, STR_INTRO_TOOLTIP_SUB_ARCTIC_LANDSCAPE),
1110 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TROPICAL), SetDataTip(SPR_SELECT_SUB_TROPICAL, STR_INTRO_TOOLTIP_SUB_TROPICAL_LANDSCAPE),
1111 NWidget(WWT_IMGBTN_2, COLOUR_ORANGE, WID_CS_TOYLAND), SetDataTip(SPR_SELECT_TOYLAND, STR_INTRO_TOOLTIP_TOYLAND_LANDSCAPE),
1112 EndContainer(),
1113 NWidget(NWID_HORIZONTAL), SetPIP(10, 8, 10),
1114 /* Green generation type buttons: 'Flat land' and 'Random land'. */
1115 NWidget(NWID_VERTICAL), SetPIP(10, 6, 10),
1116 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_CS_EMPTY_WORLD), SetDataTip(STR_SE_MAPGEN_FLAT_WORLD, STR_SE_MAPGEN_FLAT_WORLD_TOOLTIP), SetFill(1, 1),
1117 NWidget(WWT_PUSHTXTBTN, COLOUR_GREEN, WID_CS_RANDOM_WORLD), SetDataTip(STR_SE_MAPGEN_RANDOM_LAND, STR_TERRAFORM_TOOLTIP_GENERATE_RANDOM_LAND), SetFill(1, 1),
1118 EndContainer(),
1119 /* Labels + setting drop-downs */
1120 NWidget(NWID_VERTICAL), SetPIP(10, 6, 10),
1121 /* Map size. */
1122 NWidget(NWID_HORIZONTAL),
1123 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_MAPSIZE, STR_NULL), SetPadding(1, 0, 0, 0),
1124 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1125 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_CS_MAPSIZE_X_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL), SetPadding(0, 4, 0, 0),
1126 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_BY, STR_NULL), SetPadding(1, 2, 0, 0),
1127 NWidget(WWT_DROPDOWN, COLOUR_ORANGE, WID_CS_MAPSIZE_Y_PULLDOWN), SetDataTip(STR_JUST_INT, STR_NULL),
1128 EndContainer(),
1129 /* Date. */
1130 NWidget(NWID_HORIZONTAL),
1131 NWidget(WWT_TEXT, COLOUR_ORANGE), SetDataTip(STR_MAPGEN_DATE, STR_NULL), SetPadding(1, 0, 0, 0),
1132 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1133 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),
1134 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CS_START_DATE_TEXT), SetDataTip(STR_BLACK_DATE_LONG, STR_NULL),
1135 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),
1136 EndContainer(),
1137 /* Flat map height. */
1138 NWidget(NWID_HORIZONTAL),
1139 NWidget(WWT_TEXT, COLOUR_ORANGE),
1140 SetDataTip(STR_SE_MAPGEN_FLAT_WORLD_HEIGHT, STR_NULL), SetPadding(1, 0, 0, 0),
1141 NWidget(NWID_SPACER), SetMinimalSize(6, 0), SetFill(1, 0),
1142 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),
1143 NWidget(WWT_PUSHTXTBTN, COLOUR_ORANGE, WID_CS_FLAT_LAND_HEIGHT_TEXT), SetDataTip(STR_BLACK_INT, STR_NULL),
1144 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),
1145 EndContainer(),
1146 EndContainer(),
1147 EndContainer(),
1148 EndContainer(),
1151 static WindowDesc _create_scenario_desc(
1152 WDP_CENTER, nullptr, 0, 0,
1153 WC_GENERATE_LANDSCAPE, WC_NONE,
1155 _nested_create_scenario_widgets, lengthof(_nested_create_scenario_widgets)
1158 /** Show the window to create a scenario. */
1159 void ShowCreateScenario()
1161 DeleteWindowByClass(WC_GENERATE_LANDSCAPE);
1162 new CreateScenarioWindow(&_create_scenario_desc, GLWM_SCENARIO);
1165 static const NWidgetPart _nested_generate_progress_widgets[] = {
1166 NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GENERATION_WORLD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1167 NWidget(WWT_PANEL, COLOUR_GREY),
1168 NWidget(NWID_HORIZONTAL), SetPIP(20, 0, 20),
1169 NWidget(NWID_VERTICAL), SetPIP(11, 8, 11),
1170 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_BAR), SetFill(1, 0),
1171 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_TEXT), SetFill(1, 0),
1172 NWidget(WWT_TEXTBTN, COLOUR_WHITE, WID_GP_ABORT), SetDataTip(STR_GENERATION_ABORT, STR_NULL), SetFill(1, 0),
1173 EndContainer(),
1174 EndContainer(),
1175 EndContainer(),
1179 static WindowDesc _generate_progress_desc(
1180 WDP_CENTER, nullptr, 0, 0,
1181 WC_MODAL_PROGRESS, WC_NONE,
1183 _nested_generate_progress_widgets, lengthof(_nested_generate_progress_widgets)
1186 struct GenWorldStatus {
1187 uint percent;
1188 StringID cls;
1189 uint current;
1190 uint total;
1191 std::chrono::steady_clock::time_point next_update;
1194 static GenWorldStatus _gws;
1196 static const StringID _generation_class_table[] = {
1197 STR_GENERATION_WORLD_GENERATION,
1198 STR_SCENEDIT_TOOLBAR_LANDSCAPE_GENERATION,
1199 STR_GENERATION_RIVER_GENERATION,
1200 STR_GENERATION_CLEARING_TILES,
1201 STR_SCENEDIT_TOOLBAR_TOWN_GENERATION,
1202 STR_SCENEDIT_TOOLBAR_INDUSTRY_GENERATION,
1203 STR_GENERATION_OBJECT_GENERATION,
1204 STR_GENERATION_TREE_GENERATION,
1205 STR_GENERATION_SETTINGUP_GAME,
1206 STR_GENERATION_PREPARING_TILELOOP,
1207 STR_GENERATION_PREPARING_SCRIPT,
1208 STR_GENERATION_PREPARING_GAME
1210 static_assert(lengthof(_generation_class_table) == GWP_CLASS_COUNT);
1213 static void AbortGeneratingWorldCallback(Window *w, bool confirmed)
1215 if (confirmed) {
1216 AbortGeneratingWorld();
1217 } else if (HasModalProgress() && !IsGeneratingWorldAborted()) {
1218 SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1222 struct GenerateProgressWindow : public Window {
1224 GenerateProgressWindow() : Window(&_generate_progress_desc)
1226 this->InitNested();
1229 void OnClick(Point pt, int widget, int click_count) override
1231 switch (widget) {
1232 case WID_GP_ABORT:
1233 SetMouseCursorBusy(false);
1234 ShowQuery(
1235 STR_GENERATION_ABORT_CAPTION,
1236 STR_GENERATION_ABORT_MESSAGE,
1237 this,
1238 AbortGeneratingWorldCallback
1240 break;
1244 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1246 switch (widget) {
1247 case WID_GP_PROGRESS_BAR: {
1248 SetDParamMaxValue(0, 100);
1249 *size = GetStringBoundingBox(STR_GENERATION_PROGRESS);
1250 /* We need some spacing for the 'border' */
1251 size->height += 8;
1252 size->width += 8;
1253 break;
1256 case WID_GP_PROGRESS_TEXT:
1257 for (uint i = 0; i < GWP_CLASS_COUNT; i++) {
1258 size->width = std::max(size->width, GetStringBoundingBox(_generation_class_table[i]).width);
1260 size->height = FONT_HEIGHT_NORMAL * 2 + WD_PAR_VSEP_NORMAL;
1261 break;
1265 void DrawWidget(const Rect &r, int widget) const override
1267 switch (widget) {
1268 case WID_GP_PROGRESS_BAR:
1269 /* Draw the % complete with a bar and a text */
1270 DrawFrameRect(r.left, r.top, r.right, r.bottom, COLOUR_GREY, FR_BORDERONLY);
1271 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);
1272 SetDParam(0, _gws.percent);
1273 DrawString(r.left, r.right, r.top + 5, STR_GENERATION_PROGRESS, TC_FROMSTRING, SA_HOR_CENTER);
1274 break;
1276 case WID_GP_PROGRESS_TEXT:
1277 /* Tell which class we are generating */
1278 DrawString(r.left, r.right, r.top, _gws.cls, TC_FROMSTRING, SA_HOR_CENTER);
1280 /* And say where we are in that class */
1281 SetDParam(0, _gws.current);
1282 SetDParam(1, _gws.total);
1283 DrawString(r.left, r.right, r.top + FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL, STR_GENERATION_PROGRESS_NUM, TC_FROMSTRING, SA_HOR_CENTER);
1289 * Initializes the progress counters to the starting point.
1291 void PrepareGenerateWorldProgress()
1293 _gws.cls = STR_GENERATION_WORLD_GENERATION;
1294 _gws.current = 0;
1295 _gws.total = 0;
1296 _gws.percent = 0;
1297 _gws.next_update = std::chrono::steady_clock::now();
1301 * Show the window where a user can follow the process of the map generation.
1303 void ShowGenerateWorldProgress()
1305 if (BringWindowToFrontById(WC_MODAL_PROGRESS, 0)) return;
1306 new GenerateProgressWindow();
1309 static void _SetGeneratingWorldProgress(GenWorldProgress cls, uint progress, uint total)
1311 static const int percent_table[] = {0, 5, 14, 17, 20, 40, 60, 65, 80, 85, 95, 99, 100 };
1312 static_assert(lengthof(percent_table) == GWP_CLASS_COUNT + 1);
1313 assert(cls < GWP_CLASS_COUNT);
1315 /* Do not run this function if we aren't in a thread */
1316 if (!IsGenerateWorldThreaded() && !_network_dedicated) return;
1318 if (IsGeneratingWorldAborted()) HandleGeneratingWorldAbortion();
1320 if (total == 0) {
1321 assert(_gws.cls == _generation_class_table[cls]);
1322 _gws.current += progress;
1323 assert(_gws.current <= _gws.total);
1324 } else {
1325 _gws.cls = _generation_class_table[cls];
1326 _gws.current = progress;
1327 _gws.total = total;
1328 _gws.percent = percent_table[cls];
1331 /* Don't update the screen too often. So update it once in every once in a while... */
1332 if (!_network_dedicated && std::chrono::steady_clock::now() < _gws.next_update) return;
1333 _gws.next_update = std::chrono::steady_clock::now() + std::chrono::milliseconds(MODAL_PROGRESS_REDRAW_TIMEOUT);
1335 /* Percentage is about the number of completed tasks, so 'current - 1' */
1336 _gws.percent = percent_table[cls] + (percent_table[cls + 1] - percent_table[cls]) * (_gws.current == 0 ? 0 : _gws.current - 1) / _gws.total;
1338 if (_network_dedicated) {
1339 static uint last_percent = 0;
1341 /* Never display 0% */
1342 if (_gws.percent == 0) return;
1343 /* Reset if percent is lower than the last recorded */
1344 if (_gws.percent < last_percent) last_percent = 0;
1345 /* Display every 5%, but 6% is also very valid.. just not smaller steps than 5% */
1346 if (_gws.percent % 5 != 0 && _gws.percent <= last_percent + 5) return;
1347 /* Never show steps smaller than 2%, even if it is a mod 5% */
1348 if (_gws.percent <= last_percent + 2) return;
1350 DEBUG(net, 1, "Map generation percentage complete: %d", _gws.percent);
1351 last_percent = _gws.percent;
1353 /* Don't continue as dedicated never has a thread running */
1354 return;
1357 SetWindowDirty(WC_MODAL_PROGRESS, 0);
1358 MarkWholeScreenDirty();
1360 /* Release the rights to the map generator, and acquire the rights to the
1361 * paint thread. The 'other' thread already has the paint thread rights so
1362 * this ensures us that we are waiting until the paint thread is done
1363 * before we reacquire the mapgen rights */
1364 _modal_progress_work_mutex.unlock();
1365 _modal_progress_paint_mutex.lock();
1366 _modal_progress_work_mutex.lock();
1367 _modal_progress_paint_mutex.unlock();
1371 * Set the total of a stage of the world generation.
1372 * @param cls the current class we are in.
1373 * @param total Set the total expected items for this class.
1375 * Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always.
1376 * Also, progress works if total is zero, total works if progress is zero.
1378 void SetGeneratingWorldProgress(GenWorldProgress cls, uint total)
1380 if (total == 0) return;
1382 _SetGeneratingWorldProgress(cls, 0, total);
1386 * Increases the current stage of the world generation with one.
1387 * @param cls the current class we are in.
1389 * Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always.
1390 * Also, progress works if total is zero, total works if progress is zero.
1392 void IncreaseGeneratingWorldProgress(GenWorldProgress cls)
1394 /* In fact the param 'class' isn't needed.. but for some security reasons, we want it around */
1395 _SetGeneratingWorldProgress(cls, 1, 0);