src/terraform_gui.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file terraform_gui.cpp GUI related to terraforming the map. */
  11
  12 #include "stdafx.h"
  13 #include "clear_map.h"
  14 #include "company_func.h"
  15 #include "company_base.h"
  16 #include "gui.h"
  17 #include "window_gui.h"
  18 #include "window_func.h"
  19 #include "viewport_func.h"
  20 #include "command_func.h"
  21 #include "signs_func.h"
  22 #include "sound_func.h"
  23 #include "base_station_base.h"
  24 #include "textbuf_gui.h"
  25 #include "genworld.h"
  26 #include "tree_map.h"
  27 #include "landscape_type.h"
  28 #include "tilehighlight_func.h"
  29 #include "strings_func.h"
  30 #include "newgrf_object.h"
  31 #include "object.h"
  32 #include "hotkeys.h"
  33 #include "engine_base.h"
  34 #include "terraform_gui.h"
  35 #include "zoom_func.h"
  36
  37 #include "widgets/terraform_widget.h"
  38
  39 #include "table/strings.h"
  40
  41 #include "safeguards.h"
  42
  43 void CcTerraform(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
  44 {
  45         if (result.Succeeded()) {
  46                 if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_SPLAT_OTHER, tile);
  47         } else {
  48                 extern TileIndex _terraform_err_tile;
  49                 SetRedErrorSquare(_terraform_err_tile);
  50         }
  51 }
  52
  53
  54 /** Scenario editor command that generates desert areas */
  55 static void GenerateDesertArea(TileIndex end, TileIndex start)
  56 {
  57         if (_game_mode != GM_EDITOR) return;
  58
  59         _generating_world = true;
  60
  61         TileArea ta(start, end);
  62         TILE_AREA_LOOP(tile, ta) {
  63                 SetTropicZone(tile, (_ctrl_pressed) ? TROPICZONE_NORMAL : TROPICZONE_DESERT);
  64                 DoCommandP(tile, 0, 0, CMD_LANDSCAPE_CLEAR);
  65                 MarkTileDirtyByTile(tile);
  66         }
  67         _generating_world = false;
  68         InvalidateWindowClassesData(WC_TOWN_VIEW, 0);
  69 }
  70
  71 /** Scenario editor command that generates rocky areas */
  72 static void GenerateRockyArea(TileIndex end, TileIndex start)
  73 {
  74         if (_game_mode != GM_EDITOR) return;
  75
  76         bool success = false;
  77         TileArea ta(start, end);
  78
  79         TILE_AREA_LOOP(tile, ta) {
  80                 switch (GetTileType(tile)) {
  81                         case MP_TREES:
  82                                 if (GetTreeGround(tile) == TREE_GROUND_SHORE) continue;
  83                                 FALLTHROUGH;
  84
  85                         case MP_CLEAR:
  86                                 MakeClear(tile, CLEAR_ROCKS, 3);
  87                                 break;
  88
  89                         default:
  90                                 continue;
  91                 }
  92                 MarkTileDirtyByTile(tile);
  93                 success = true;
  94         }
  95
  96         if (success && _settings_client.sound.confirm) SndPlayTileFx(SND_1F_SPLAT_OTHER, end);
  97 }
  98
  99 /**
 100  * A central place to handle all X_AND_Y dragged GUI functions.
 101  * @param proc       Procedure related to the dragging
 102  * @param start_tile Begin of the dragging
 103  * @param end_tile   End of the dragging
 104  * @return Returns true if the action was found and handled, and false otherwise. This
 105  * allows for additional implements that are more local. For example X_Y drag
 106  * of convertrail which belongs in rail_gui.cpp and not terraform_gui.cpp
 107  */
 108 bool GUIPlaceProcDragXY(ViewportDragDropSelectionProcess proc, TileIndex start_tile, TileIndex end_tile)
 109 {
 110         if (!_settings_game.construction.freeform_edges) {
 111                 /* When end_tile is MP_VOID, the error tile will not be visible to the
 112                  * user. This happens when terraforming at the southern border. */
 113                 if (TileX(end_tile) == MapMaxX()) end_tile += TileDiffXY(-1, 0);
 114                 if (TileY(end_tile) == MapMaxY()) end_tile += TileDiffXY(0, -1);
 115         }
 116
 117         switch (proc) {
 118                 case DDSP_DEMOLISH_AREA:
 119                         DoCommandP(end_tile, start_tile, _ctrl_pressed ? 1 : 0, CMD_CLEAR_AREA | CMD_MSG(STR_ERROR_CAN_T_CLEAR_THIS_AREA), CcPlaySound_EXPLOSION);
 120                         break;
 121                 case DDSP_RAISE_AND_LEVEL_AREA:
 122                         DoCommandP(end_tile, start_tile, LM_RAISE << 1 | (_ctrl_pressed ? 1 : 0), CMD_LEVEL_LAND | CMD_MSG(STR_ERROR_CAN_T_RAISE_LAND_HERE), CcTerraform);
 123                         break;
 124                 case DDSP_LOWER_AND_LEVEL_AREA:
 125                         DoCommandP(end_tile, start_tile, LM_LOWER << 1 | (_ctrl_pressed ? 1 : 0), CMD_LEVEL_LAND | CMD_MSG(STR_ERROR_CAN_T_LOWER_LAND_HERE), CcTerraform);
 126                         break;
 127                 case DDSP_LEVEL_AREA:
 128                         DoCommandP(end_tile, start_tile, LM_LEVEL << 1 | (_ctrl_pressed ? 1 : 0), CMD_LEVEL_LAND | CMD_MSG(STR_ERROR_CAN_T_LEVEL_LAND_HERE), CcTerraform);
 129                         break;
 130                 case DDSP_CREATE_ROCKS:
 131                         GenerateRockyArea(end_tile, start_tile);
 132                         break;
 133                 case DDSP_CREATE_DESERT:
 134                         GenerateDesertArea(end_tile, start_tile);
 135                         break;
 136                 default:
 137                         return false;
 138         }
 139
 140         return true;
 141 }
 142
 143 /**
 144  * Start a drag for demolishing an area.
 145  * @param tile Position of one corner.
 146  */
 147 void PlaceProc_DemolishArea(TileIndex tile)
 148 {
 149         VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_DEMOLISH_AREA);
 150 }
 151
 152 /** Terra form toolbar managing class. */
 153 struct TerraformToolbarWindow : Window {
 154         int last_user_action; ///< Last started user action.
 155
 156         TerraformToolbarWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
 157         {
 158                 /* This is needed as we like to have the tree available on OnInit. */
 159                 this->CreateNestedTree();
 160                 this->FinishInitNested(window_number);
 161                 this->last_user_action = WIDGET_LIST_END;
 162         }
 163
 164         ~TerraformToolbarWindow()
 165         {
 166         }
 167
 168         virtual void OnInit()
 169         {
 170                 /* Don't show the place object button when there are no objects to place. */
 171                 NWidgetStacked *show_object = this->GetWidget<NWidgetStacked>(WID_TT_SHOW_PLACE_OBJECT);
 172                 show_object->SetDisplayedPlane(ObjectClass::GetUIClassCount() != 0 ? 0 : SZSP_NONE);
 173         }
 174
 175         virtual void OnClick(Point pt, int widget, int click_count)
 176         {
 177                 if (widget < WID_TT_BUTTONS_START) return;
 178
 179                 switch (widget) {
 180                         case WID_TT_LOWER_LAND: // Lower land button
 181                                 HandlePlacePushButton(this, WID_TT_LOWER_LAND, ANIMCURSOR_LOWERLAND, HT_POINT | HT_DIAGONAL);
 182                                 this->last_user_action = widget;
 183                                 break;
 184
 185                         case WID_TT_RAISE_LAND: // Raise land button
 186                                 HandlePlacePushButton(this, WID_TT_RAISE_LAND, ANIMCURSOR_RAISELAND, HT_POINT | HT_DIAGONAL);
 187                                 this->last_user_action = widget;
 188                                 break;
 189
 190                         case WID_TT_LEVEL_LAND: // Level land button
 191                                 HandlePlacePushButton(this, WID_TT_LEVEL_LAND, SPR_CURSOR_LEVEL_LAND, HT_POINT | HT_DIAGONAL);
 192                                 this->last_user_action = widget;
 193                                 break;
 194
 195                         case WID_TT_DEMOLISH: // Demolish aka dynamite button
 196                                 HandlePlacePushButton(this, WID_TT_DEMOLISH, ANIMCURSOR_DEMOLISH, HT_RECT | HT_DIAGONAL);
 197                                 this->last_user_action = widget;
 198                                 break;
 199
 200                         case WID_TT_BUY_LAND: // Buy land button
 201                                 HandlePlacePushButton(this, WID_TT_BUY_LAND, SPR_CURSOR_BUY_LAND, HT_RECT);
 202                                 this->last_user_action = widget;
 203                                 break;
 204
 205                         case WID_TT_PLANT_TREES: // Plant trees button
 206                                 ShowBuildTreesToolbar();
 207                                 break;
 208
 209                         case WID_TT_PLACE_SIGN: // Place sign button
 210                                 HandlePlacePushButton(this, WID_TT_PLACE_SIGN, SPR_CURSOR_SIGN, HT_RECT);
 211                                 this->last_user_action = widget;
 212                                 break;
 213
 214                         case WID_TT_PLACE_OBJECT: // Place object button
 215                                 ShowBuildObjectPicker();
 216                                 break;
 217
 218                         default: NOT_REACHED();
 219                 }
 220         }
 221
 222         virtual void OnPlaceObject(Point pt, TileIndex tile)
 223         {
 224                 switch (this->last_user_action) {
 225                         case WID_TT_LOWER_LAND: // Lower land button
 226                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_LOWER_AND_LEVEL_AREA);
 227                                 break;
 228
 229                         case WID_TT_RAISE_LAND: // Raise land button
 230                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_RAISE_AND_LEVEL_AREA);
 231                                 break;
 232
 233                         case WID_TT_LEVEL_LAND: // Level land button
 234                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_LEVEL_AREA);
 235                                 break;
 236
 237                         case WID_TT_DEMOLISH: // Demolish aka dynamite button
 238                                 PlaceProc_DemolishArea(tile);
 239                                 break;
 240
 241                         case WID_TT_BUY_LAND: // Buy land button
 242                                 DoCommandP(tile, OBJECT_OWNED_LAND, 0, CMD_BUILD_OBJECT | CMD_MSG(STR_ERROR_CAN_T_PURCHASE_THIS_LAND), CcPlaySound_SPLAT_RAIL);
 243                                 break;
 244
 245                         case WID_TT_PLACE_SIGN: // Place sign button
 246                                 PlaceProc_Sign(tile);
 247                                 break;
 248
 249                         default: NOT_REACHED();
 250                 }
 251         }
 252
 253         virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 254         {
 255                 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
 256         }
 257
 258         virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
 259         {
 260                 Point pt = GetToolbarAlignedWindowPosition(sm_width);
 261                 pt.y += sm_height;
 262                 return pt;
 263         }
 264
 265         virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
 266         {
 267                 if (pt.x != -1) {
 268                         switch (select_proc) {
 269                                 default: NOT_REACHED();
 270                                 case DDSP_DEMOLISH_AREA:
 271                                 case DDSP_RAISE_AND_LEVEL_AREA:
 272                                 case DDSP_LOWER_AND_LEVEL_AREA:
 273                                 case DDSP_LEVEL_AREA:
 274                                         GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
 275                                         break;
 276                         }
 277                 }
 278         }
 279
 280         virtual void OnPlaceObjectAbort()
 281         {
 282                 this->RaiseButtons();
 283         }
 284
 285         static HotkeyList hotkeys;
 286 };
 287
 288 /**
 289  * Handler for global hotkeys of the TerraformToolbarWindow.
 290  * @param hotkey Hotkey
 291  * @return ES_HANDLED if hotkey was accepted.
 292  */
 293 static EventState TerraformToolbarGlobalHotkeys(int hotkey)
 294 {
 295         if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
 296         Window *w = ShowTerraformToolbar(NULL);
 297         if (w == NULL) return ES_NOT_HANDLED;
 298         return w->OnHotkey(hotkey);
 299 }
 300
 301 static Hotkey terraform_hotkeys[] = {
 302         Hotkey('Q' | WKC_GLOBAL_HOTKEY, "lower", WID_TT_LOWER_LAND),
 303         Hotkey('W' | WKC_GLOBAL_HOTKEY, "raise", WID_TT_RAISE_LAND),
 304         Hotkey('E' | WKC_GLOBAL_HOTKEY, "level", WID_TT_LEVEL_LAND),
 305         Hotkey('D' | WKC_GLOBAL_HOTKEY, "dynamite", WID_TT_DEMOLISH),
 306         Hotkey('U', "buyland", WID_TT_BUY_LAND),
 307         Hotkey('I', "trees", WID_TT_PLANT_TREES),
 308         Hotkey('O', "placesign", WID_TT_PLACE_SIGN),
 309         Hotkey('P', "placeobject", WID_TT_PLACE_OBJECT),
 310         HOTKEY_LIST_END
 311 };
 312 HotkeyList TerraformToolbarWindow::hotkeys("terraform", terraform_hotkeys, TerraformToolbarGlobalHotkeys);
 313
 314 static const NWidgetPart _nested_terraform_widgets[] = {
 315         NWidget(NWID_HORIZONTAL),
 316                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 317                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_LANDSCAPING_TOOLBAR, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 318                 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
 319         EndContainer(),
 320         NWidget(NWID_HORIZONTAL),
 321                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_LOWER_LAND), SetMinimalSize(22, 22),
 322                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TERRAFORM_DOWN, STR_LANDSCAPING_TOOLTIP_LOWER_A_CORNER_OF_LAND),
 323                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_RAISE_LAND), SetMinimalSize(22, 22),
 324                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TERRAFORM_UP, STR_LANDSCAPING_TOOLTIP_RAISE_A_CORNER_OF_LAND),
 325                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_LEVEL_LAND), SetMinimalSize(22, 22),
 326                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_LEVEL_LAND, STR_LANDSCAPING_LEVEL_LAND_TOOLTIP),
 327
 328                 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(4, 22), EndContainer(),
 329
 330                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_DEMOLISH), SetMinimalSize(22, 22),
 331                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
 332                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_BUY_LAND), SetMinimalSize(22, 22),
 333                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_BUY_LAND, STR_LANDSCAPING_TOOLTIP_PURCHASE_LAND),
 334                 NWidget(WWT_PUSHIMGBTN, COLOUR_DARK_GREEN, WID_TT_PLANT_TREES), SetMinimalSize(22, 22),
 335                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_PLANTTREES, STR_SCENEDIT_TOOLBAR_PLANT_TREES),
 336                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_TT_PLACE_SIGN), SetMinimalSize(22, 22),
 337                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_SIGN, STR_SCENEDIT_TOOLBAR_PLACE_SIGN),
 338                 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_TT_SHOW_PLACE_OBJECT),
 339                         NWidget(WWT_PUSHIMGBTN, COLOUR_DARK_GREEN, WID_TT_PLACE_OBJECT), SetMinimalSize(22, 22),
 340                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TRANSMITTER, STR_SCENEDIT_TOOLBAR_PLACE_OBJECT),
 341                 EndContainer(),
 342         EndContainer(),
 343 };
 344
 345 static WindowDesc _terraform_desc(
 346         WDP_MANUAL, "toolbar_landscape", 0, 0,
 347         WC_SCEN_LAND_GEN, WC_NONE,
 348         WDF_CONSTRUCTION,
 349         _nested_terraform_widgets, lengthof(_nested_terraform_widgets),
 350         &TerraformToolbarWindow::hotkeys
 351 );
 352
 353 /**
 354  * Show the toolbar for terraforming in the game.
 355  * @param link The toolbar we might want to link to.
 356  * @return The allocated toolbar if the window was newly opened, else \c NULL.
 357  */
 358 Window *ShowTerraformToolbar(Window *link)
 359 {
 360         if (!Company::IsValidID(_local_company)) return NULL;
 361
 362         Window *w;
 363         if (link == NULL) {
 364                 w = AllocateWindowDescFront<TerraformToolbarWindow>(&_terraform_desc, 0);
 365                 return w;
 366         }
 367
 368         /* Delete the terraform toolbar to place it again. */
 369         DeleteWindowById(WC_SCEN_LAND_GEN, 0, true);
 370         w = AllocateWindowDescFront<TerraformToolbarWindow>(&_terraform_desc, 0);
 371         /* Align the terraform toolbar under the main toolbar. */
 372         w->top -= w->height;
 373         w->SetDirty();
 374         /* Put the linked toolbar to the left / right of it. */
 375         link->left = w->left + (_current_text_dir == TD_RTL ? w->width : -link->width);
 376         link->top  = w->top;
 377         link->SetDirty();
 378
 379         return w;
 380 }
 381
 382 static byte _terraform_size = 1;
 383
 384 /**
 385  * Raise/Lower a bigger chunk of land at the same time in the editor. When
 386  * raising get the lowest point, when lowering the highest point, and set all
 387  * tiles in the selection to that height.
 388  * @todo : Incorporate into game itself to allow for ingame raising/lowering of
 389  *         larger chunks at the same time OR remove altogether, as we have 'level land' ?
 390  * @param tile The top-left tile where the terraforming will start
 391  * @param mode 1 for raising, 0 for lowering land
 392  */
 393 static void CommonRaiseLowerBigLand(TileIndex tile, int mode)
 394 {
 395         if (_terraform_size == 1) {
 396                 StringID msg =
 397                         mode ? STR_ERROR_CAN_T_RAISE_LAND_HERE : STR_ERROR_CAN_T_LOWER_LAND_HERE;
 398
 399                 DoCommandP(tile, SLOPE_N, (uint32)mode, CMD_TERRAFORM_LAND | CMD_MSG(msg), CcTerraform);
 400         } else {
 401                 assert(_terraform_size != 0);
 402                 TileArea ta(tile, _terraform_size, _terraform_size);
 403                 ta.ClampToMap();
 404
 405                 if (ta.w == 0 || ta.h == 0) return;
 406
 407                 if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_SPLAT_OTHER, tile);
 408
 409                 uint h;
 410                 if (mode != 0) {
 411                         /* Raise land */
 412                         h = MAX_TILE_HEIGHT;
 413                         TILE_AREA_LOOP(tile2, ta) {
 414                                 h = min(h, TileHeight(tile2));
 415                         }
 416                 } else {
 417                         /* Lower land */
 418                         h = 0;
 419                         TILE_AREA_LOOP(tile2, ta) {
 420                                 h = max(h, TileHeight(tile2));
 421                         }
 422                 }
 423
 424                 TILE_AREA_LOOP(tile2, ta) {
 425                         if (TileHeight(tile2) == h) {
 426                                 DoCommandP(tile2, SLOPE_N, (uint32)mode, CMD_TERRAFORM_LAND);
 427                         }
 428                 }
 429         }
 430 }
 431
 432 static const int8 _multi_terraform_coords[][2] = {
 433         {  0, -2},
 434         {  4,  0}, { -4,  0}, {  0,  2},
 435         { -8,  2}, { -4,  4}, {  0,  6}, {  4,  4}, {  8,  2},
 436         {-12,  0}, { -8, -2}, { -4, -4}, {  0, -6}, {  4, -4}, {  8, -2}, { 12,  0},
 437         {-16,  2}, {-12,  4}, { -8,  6}, { -4,  8}, {  0, 10}, {  4,  8}, {  8,  6}, { 12,  4}, { 16,  2},
 438         {-20,  0}, {-16, -2}, {-12, -4}, { -8, -6}, { -4, -8}, {  0,-10}, {  4, -8}, {  8, -6}, { 12, -4}, { 16, -2}, { 20,  0},
 439         {-24,  2}, {-20,  4}, {-16,  6}, {-12,  8}, { -8, 10}, { -4, 12}, {  0, 14}, {  4, 12}, {  8, 10}, { 12,  8}, { 16,  6}, { 20,  4}, { 24,  2},
 440         {-28,  0}, {-24, -2}, {-20, -4}, {-16, -6}, {-12, -8}, { -8,-10}, { -4,-12}, {  0,-14}, {  4,-12}, {  8,-10}, { 12, -8}, { 16, -6}, { 20, -4}, { 24, -2}, { 28,  0},
 441 };
 442
 443 static const NWidgetPart _nested_scen_edit_land_gen_widgets[] = {
 444         NWidget(NWID_HORIZONTAL),
 445                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 446                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_TERRAFORM_TOOLBAR_LAND_GENERATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 447                 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
 448                 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
 449         EndContainer(),
 450         NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
 451                 NWidget(NWID_HORIZONTAL), SetPadding(2, 2, 7, 2),
 452                         NWidget(NWID_SPACER), SetFill(1, 0),
 453                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_DEMOLISH), SetMinimalSize(22, 22),
 454                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
 455                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_LOWER_LAND), SetMinimalSize(22, 22),
 456                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TERRAFORM_DOWN, STR_LANDSCAPING_TOOLTIP_LOWER_A_CORNER_OF_LAND),
 457                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_RAISE_LAND), SetMinimalSize(22, 22),
 458                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TERRAFORM_UP, STR_LANDSCAPING_TOOLTIP_RAISE_A_CORNER_OF_LAND),
 459                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_LEVEL_LAND), SetMinimalSize(22, 22),
 460                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_LEVEL_LAND, STR_LANDSCAPING_LEVEL_LAND_TOOLTIP),
 461                         NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_PLACE_ROCKS), SetMinimalSize(22, 22),
 462                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_ROCKS, STR_TERRAFORM_TOOLTIP_PLACE_ROCKY_AREAS_ON_LANDSCAPE),
 463                         NWidget(NWID_SELECTION, INVALID_COLOUR, WID_ETT_SHOW_PLACE_DESERT),
 464                                 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_PLACE_DESERT), SetMinimalSize(22, 22),
 465                                                                                         SetFill(0, 1), SetDataTip(SPR_IMG_DESERT, STR_TERRAFORM_TOOLTIP_DEFINE_DESERT_AREA),
 466                         EndContainer(),
 467                         NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_ETT_PLACE_OBJECT), SetMinimalSize(23, 22),
 468                                                                                 SetFill(0, 1), SetDataTip(SPR_IMG_TRANSMITTER, STR_SCENEDIT_TOOLBAR_PLACE_OBJECT),
 469                         NWidget(NWID_SPACER), SetFill(1, 0),
 470                 EndContainer(),
 471                 NWidget(NWID_HORIZONTAL),
 472                         NWidget(NWID_SPACER), SetFill(1, 0),
 473                         NWidget(WWT_EMPTY, COLOUR_DARK_GREEN, WID_ETT_DOTS), SetMinimalSize(59, 31), SetDataTip(STR_EMPTY, STR_NULL),
 474                         NWidget(NWID_SPACER), SetFill(1, 0),
 475                         NWidget(NWID_VERTICAL),
 476                                 NWidget(NWID_SPACER), SetFill(0, 1),
 477                                 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_INCREASE_SIZE), SetMinimalSize(12, 12), SetDataTip(SPR_ARROW_UP, STR_TERRAFORM_TOOLTIP_INCREASE_SIZE_OF_LAND_AREA),
 478                                 NWidget(NWID_SPACER), SetMinimalSize(0, 1),
 479                                 NWidget(WWT_IMGBTN, COLOUR_GREY, WID_ETT_DECREASE_SIZE), SetMinimalSize(12, 12), SetDataTip(SPR_ARROW_DOWN, STR_TERRAFORM_TOOLTIP_DECREASE_SIZE_OF_LAND_AREA),
 480                                 NWidget(NWID_SPACER), SetFill(0, 1),
 481                         EndContainer(),
 482                         NWidget(NWID_SPACER), SetMinimalSize(2, 0),
 483                 EndContainer(),
 484                 NWidget(NWID_SPACER), SetMinimalSize(0, 6),
 485                 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_ETT_NEW_SCENARIO), SetMinimalSize(160, 12),
 486                                                                 SetFill(1, 0), SetDataTip(STR_TERRAFORM_SE_NEW_WORLD, STR_TERRAFORM_TOOLTIP_GENERATE_RANDOM_LAND), SetPadding(0, 2, 0, 2),
 487                 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_ETT_RESET_LANDSCAPE), SetMinimalSize(160, 12),
 488                                                                 SetFill(1, 0), SetDataTip(STR_TERRAFORM_RESET_LANDSCAPE, STR_TERRAFORM_RESET_LANDSCAPE_TOOLTIP), SetPadding(1, 2, 2, 2),
 489         EndContainer(),
 490 };
 491
 492 /**
 493  * Callback function for the scenario editor 'reset landscape' confirmation window
 494  * @param w Window unused
 495  * @param confirmed boolean value, true when yes was clicked, false otherwise
 496  */
 497 static void ResetLandscapeConfirmationCallback(Window *w, bool confirmed)
 498 {
 499         if (confirmed) {
 500                 /* Set generating_world to true to get instant-green grass after removing
 501                  * company property. */
 502                 _generating_world = true;
 503
 504                 /* Delete all companies */
 505                 Company *c;
 506                 FOR_ALL_COMPANIES(c) {
 507                         ChangeOwnershipOfCompanyItems(c->index, INVALID_OWNER);
 508                         delete c;
 509                 }
 510
 511                 _generating_world = false;
 512
 513                 /* Delete all station signs */
 514                 BaseStation *st;
 515                 FOR_ALL_BASE_STATIONS(st) {
 516                         /* There can be buoys, remove them */
 517                         if (IsBuoyTile(st->xy)) DoCommand(st->xy, 0, 0, DC_EXEC | DC_BANKRUPT, CMD_LANDSCAPE_CLEAR);
 518                         if (!st->IsInUse()) delete st;
 519                 }
 520
 521                 /* Now that all vehicles are gone, we can reset the engine pool. Maybe it reduces some NewGRF changing-mess */
 522                 EngineOverrideManager::ResetToCurrentNewGRFConfig();
 523
 524                 MarkWholeScreenDirty();
 525         }
 526 }
 527
 528 /** Landscape generation window handler in the scenario editor. */
 529 struct ScenarioEditorLandscapeGenerationWindow : Window {
 530         int last_user_action; ///< Last started user action.
 531
 532         ScenarioEditorLandscapeGenerationWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
 533         {
 534                 this->CreateNestedTree();
 535                 NWidgetStacked *show_desert = this->GetWidget<NWidgetStacked>(WID_ETT_SHOW_PLACE_DESERT);
 536                 show_desert->SetDisplayedPlane(_settings_game.game_creation.landscape == LT_TROPIC ? 0 : SZSP_NONE);
 537                 this->FinishInitNested(window_number);
 538                 this->last_user_action = WIDGET_LIST_END;
 539         }
 540
 541         virtual void OnPaint()
 542         {
 543                 this->DrawWidgets();
 544
 545                 if (this->IsWidgetLowered(WID_ETT_LOWER_LAND) || this->IsWidgetLowered(WID_ETT_RAISE_LAND)) { // change area-size if raise/lower corner is selected
 546                         SetTileSelectSize(_terraform_size, _terraform_size);
 547                 }
 548         }
 549
 550         virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 551         {
 552                 if (widget != WID_ETT_DOTS) return;
 553
 554                 size->width  = max<uint>(size->width,  ScaleGUITrad(59));
 555                 size->height = max<uint>(size->height, ScaleGUITrad(31));
 556         }
 557
 558         virtual void DrawWidget(const Rect &r, int widget) const
 559         {
 560                 if (widget != WID_ETT_DOTS) return;
 561
 562                 int center_x = RoundDivSU(r.left + r.right, 2);
 563                 int center_y = RoundDivSU(r.top + r.bottom, 2);
 564
 565                 int n = _terraform_size * _terraform_size;
 566                 const int8 *coords = &_multi_terraform_coords[0][0];
 567
 568                 assert(n != 0);
 569                 do {
 570                         DrawSprite(SPR_WHITE_POINT, PAL_NONE, center_x + ScaleGUITrad(coords[0]), center_y + ScaleGUITrad(coords[1]));
 571                         coords += 2;
 572                 } while (--n);
 573         }
 574
 575         virtual void OnClick(Point pt, int widget, int click_count)
 576         {
 577                 if (widget < WID_ETT_BUTTONS_START) return;
 578
 579                 switch (widget) {
 580                         case WID_ETT_DEMOLISH: // Demolish aka dynamite button
 581                                 HandlePlacePushButton(this, WID_ETT_DEMOLISH, ANIMCURSOR_DEMOLISH, HT_RECT | HT_DIAGONAL);
 582                                 this->last_user_action = widget;
 583                                 break;
 584
 585                         case WID_ETT_LOWER_LAND: // Lower land button
 586                                 HandlePlacePushButton(this, WID_ETT_LOWER_LAND, ANIMCURSOR_LOWERLAND, HT_POINT);
 587                                 this->last_user_action = widget;
 588                                 break;
 589
 590                         case WID_ETT_RAISE_LAND: // Raise land button
 591                                 HandlePlacePushButton(this, WID_ETT_RAISE_LAND, ANIMCURSOR_RAISELAND, HT_POINT);
 592                                 this->last_user_action = widget;
 593                                 break;
 594
 595                         case WID_ETT_LEVEL_LAND: // Level land button
 596                                 HandlePlacePushButton(this, WID_ETT_LEVEL_LAND, SPR_CURSOR_LEVEL_LAND, HT_POINT | HT_DIAGONAL);
 597                                 this->last_user_action = widget;
 598                                 break;
 599
 600                         case WID_ETT_PLACE_ROCKS: // Place rocks button
 601                                 HandlePlacePushButton(this, WID_ETT_PLACE_ROCKS, SPR_CURSOR_ROCKY_AREA, HT_RECT);
 602                                 this->last_user_action = widget;
 603                                 break;
 604
 605                         case WID_ETT_PLACE_DESERT: // Place desert button (in tropical climate)
 606                                 HandlePlacePushButton(this, WID_ETT_PLACE_DESERT, SPR_CURSOR_DESERT, HT_RECT);
 607                                 this->last_user_action = widget;
 608                                 break;
 609
 610                         case WID_ETT_PLACE_OBJECT: // Place transmitter button
 611                                 ShowBuildObjectPicker();
 612                                 break;
 613
 614                         case WID_ETT_INCREASE_SIZE:
 615                         case WID_ETT_DECREASE_SIZE: { // Increase/Decrease terraform size
 616                                 int size = (widget == WID_ETT_INCREASE_SIZE) ? 1 : -1;
 617                                 this->HandleButtonClick(widget);
 618                                 size += _terraform_size;
 619
 620                                 if (!IsInsideMM(size, 1, 8 + 1)) return;
 621                                 _terraform_size = size;
 622
 623                                 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
 624                                 this->SetDirty();
 625                                 break;
 626                         }
 627
 628                         case WID_ETT_NEW_SCENARIO: // gen random land
 629                                 this->HandleButtonClick(widget);
 630                                 ShowCreateScenario();
 631                                 break;
 632
 633                         case WID_ETT_RESET_LANDSCAPE: // Reset landscape
 634                                 ShowQuery(STR_QUERY_RESET_LANDSCAPE_CAPTION, STR_RESET_LANDSCAPE_CONFIRMATION_TEXT, NULL, ResetLandscapeConfirmationCallback);
 635                                 break;
 636
 637                         default: NOT_REACHED();
 638                 }
 639         }
 640
 641         virtual void OnTimeout()
 642         {
 643                 for (uint i = WID_ETT_START; i < this->nested_array_size; i++) {
 644                         if (i == WID_ETT_BUTTONS_START) i = WID_ETT_BUTTONS_END; // skip the buttons
 645                         if (this->IsWidgetLowered(i)) {
 646                                 this->RaiseWidget(i);
 647                                 this->SetWidgetDirty(i);
 648                         }
 649                 }
 650         }
 651
 652         virtual void OnPlaceObject(Point pt, TileIndex tile)
 653         {
 654                 switch (this->last_user_action) {
 655                         case WID_ETT_DEMOLISH: // Demolish aka dynamite button
 656                                 PlaceProc_DemolishArea(tile);
 657                                 break;
 658
 659                         case WID_ETT_LOWER_LAND: // Lower land button
 660                                 CommonRaiseLowerBigLand(tile, 0);
 661                                 break;
 662
 663                         case WID_ETT_RAISE_LAND: // Raise land button
 664                                 CommonRaiseLowerBigLand(tile, 1);
 665                                 break;
 666
 667                         case WID_ETT_LEVEL_LAND: // Level land button
 668                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_LEVEL_AREA);
 669                                 break;
 670
 671                         case WID_ETT_PLACE_ROCKS: // Place rocks button
 672                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CREATE_ROCKS);
 673                                 break;
 674
 675                         case WID_ETT_PLACE_DESERT: // Place desert button (in tropical climate)
 676                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CREATE_DESERT);
 677                                 break;
 678
 679                         default: NOT_REACHED();
 680                 }
 681         }
 682
 683         virtual void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 684         {
 685                 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
 686         }
 687
 688         virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
 689         {
 690                 if (pt.x != -1) {
 691                         switch (select_proc) {
 692                                 default: NOT_REACHED();
 693                                 case DDSP_CREATE_ROCKS:
 694                                 case DDSP_CREATE_DESERT:
 695                                 case DDSP_RAISE_AND_LEVEL_AREA:
 696                                 case DDSP_LOWER_AND_LEVEL_AREA:
 697                                 case DDSP_LEVEL_AREA:
 698                                 case DDSP_DEMOLISH_AREA:
 699                                         GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
 700                                         break;
 701                         }
 702                 }
 703         }
 704
 705         virtual void OnPlaceObjectAbort()
 706         {
 707                 this->RaiseButtons();
 708                 this->SetDirty();
 709         }
 710
 711         static HotkeyList hotkeys;
 712 };
 713
 714 /**
 715  * Handler for global hotkeys of the ScenarioEditorLandscapeGenerationWindow.
 716  * @param hotkey Hotkey
 717  * @return ES_HANDLED if hotkey was accepted.
 718  */
 719 static EventState TerraformToolbarEditorGlobalHotkeys(int hotkey)
 720 {
 721         if (_game_mode != GM_EDITOR) return ES_NOT_HANDLED;
 722         Window *w = ShowEditorTerraformToolbar();
 723         if (w == NULL) return ES_NOT_HANDLED;
 724         return w->OnHotkey(hotkey);
 725 }
 726
 727 static Hotkey terraform_editor_hotkeys[] = {
 728         Hotkey('D' | WKC_GLOBAL_HOTKEY, "dynamite", WID_ETT_DEMOLISH),
 729         Hotkey('Q' | WKC_GLOBAL_HOTKEY, "lower", WID_ETT_LOWER_LAND),
 730         Hotkey('W' | WKC_GLOBAL_HOTKEY, "raise", WID_ETT_RAISE_LAND),
 731         Hotkey('E' | WKC_GLOBAL_HOTKEY, "level", WID_ETT_LEVEL_LAND),
 732         Hotkey('R', "rocky", WID_ETT_PLACE_ROCKS),
 733         Hotkey('T', "desert", WID_ETT_PLACE_DESERT),
 734         Hotkey('O', "object", WID_ETT_PLACE_OBJECT),
 735         HOTKEY_LIST_END
 736 };
 737
 738 HotkeyList ScenarioEditorLandscapeGenerationWindow::hotkeys("terraform_editor", terraform_editor_hotkeys, TerraformToolbarEditorGlobalHotkeys);
 739
 740 static WindowDesc _scen_edit_land_gen_desc(
 741         WDP_AUTO, "toolbar_landscape_scen", 0, 0,
 742         WC_SCEN_LAND_GEN, WC_NONE,
 743         WDF_CONSTRUCTION,
 744         _nested_scen_edit_land_gen_widgets, lengthof(_nested_scen_edit_land_gen_widgets),
 745         &ScenarioEditorLandscapeGenerationWindow::hotkeys
 746 );
 747
 748 /**
 749  * Show the toolbar for terraforming in the scenario editor.
 750  * @return The allocated toolbar if the window was newly opened, else \c NULL.
 751  */
 752 Window *ShowEditorTerraformToolbar()
 753 {
 754         return AllocateWindowDescFront<ScenarioEditorLandscapeGenerationWindow>(&_scen_edit_land_gen_desc, 0);
 755 }