src/dock_gui.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file dock_gui.cpp GUI to create amazing water objects. */
   9
  10 #include "stdafx.h"
  11 #include "terraform_gui.h"
  12 #include "window_gui.h"
  13 #include "station_gui.h"
  14 #include "command_func.h"
  15 #include "water.h"
  16 #include "window_func.h"
  17 #include "vehicle_func.h"
  18 #include "sound_func.h"
  19 #include "viewport_func.h"
  20 #include "gfx_func.h"
  21 #include "company_func.h"
  22 #include "slope_func.h"
  23 #include "tilehighlight_func.h"
  24 #include "company_base.h"
  25 #include "hotkeys.h"
  26 #include "gui.h"
  27 #include "zoom_func.h"
  28
  29 #include "widgets/dock_widget.h"
  30
  31 #include "table/sprites.h"
  32 #include "table/strings.h"
  33
  34 #include "safeguards.h"
  35
  36 static void ShowBuildDockStationPicker(Window *parent);
  37 static void ShowBuildDocksDepotPicker(Window *parent);
  38
  39 static Axis _ship_depot_direction;
  40
  41 void CcBuildDocks(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
  42 {
  43         if (result.Failed()) return;
  44
  45         if (_settings_client.sound.confirm) SndPlayTileFx(SND_02_CONSTRUCTION_WATER, tile);
  46         if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
  47 }
  48
  49 void CcPlaySound_CONSTRUCTION_WATER(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
  50 {
  51         if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_02_CONSTRUCTION_WATER, tile);
  52 }
  53
  54
  55 /**
  56  * Gets the other end of the aqueduct, if possible.
  57  * @param      tile_from The begin tile for the aqueduct.
  58  * @param[out] tile_to   The tile till where to show a selection for the aqueduct.
  59  * @return The other end of the aqueduct, or otherwise a tile in line with the aqueduct to cause the right error message.
  60  */
  61 static TileIndex GetOtherAqueductEnd(TileIndex tile_from, TileIndex *tile_to = nullptr)
  62 {
  63         int z;
  64         DiagDirection dir = GetInclinedSlopeDirection(GetTileSlope(tile_from, &z));
  65
  66         /* If the direction isn't right, just return the next tile so the command
  67          * complains about the wrong slope instead of the ends not matching up.
  68          * Make sure the coordinate is always a valid tile within the map, so we
  69          * don't go "off" the map. That would cause the wrong error message. */
  70         if (!IsValidDiagDirection(dir)) return TILE_ADDXY(tile_from, TileX(tile_from) > 2 ? -1 : 1, 0);
  71
  72         /* Direction the aqueduct is built to. */
  73         TileIndexDiff offset = TileOffsByDiagDir(ReverseDiagDir(dir));
  74         /* The maximum length of the aqueduct. */
  75         int max_length = std::min<int>(_settings_game.construction.max_bridge_length, DistanceFromEdgeDir(tile_from, ReverseDiagDir(dir)) - 1);
  76
  77         TileIndex endtile = tile_from;
  78         for (int length = 0; IsValidTile(endtile) && TileX(endtile) != 0 && TileY(endtile) != 0; length++) {
  79                 endtile = TILE_ADD(endtile, offset);
  80
  81                 if (length > max_length) break;
  82
  83                 if (GetTileMaxZ(endtile) > z) {
  84                         if (tile_to != nullptr) *tile_to = endtile;
  85                         break;
  86                 }
  87         }
  88
  89         return endtile;
  90 }
  91
  92 /** Toolbar window for constructing water infrastructure. */
  93 struct BuildDocksToolbarWindow : Window {
  94         DockToolbarWidgets last_clicked_widget; ///< Contains the last widget that has been clicked on this toolbar.
  95
  96         BuildDocksToolbarWindow(WindowDesc *desc, WindowNumber window_number) : Window(desc)
  97         {
  98                 this->last_clicked_widget = WID_DT_INVALID;
  99                 this->InitNested(window_number);
 100                 this->OnInvalidateData();
 101                 if (_settings_client.gui.link_terraform_toolbar) ShowTerraformToolbar(this);
 102         }
 103
 104         ~BuildDocksToolbarWindow()
 105         {
 106                 if (_game_mode == GM_NORMAL && this->IsWidgetLowered(WID_DT_STATION)) SetViewportCatchmentStation(nullptr, true);
 107                 if (_settings_client.gui.link_terraform_toolbar) DeleteWindowById(WC_SCEN_LAND_GEN, 0, false);
 108         }
 109
 110         /**
 111          * Some data on this window has become invalid.
 112          * @param data Information about the changed data.
 113          * @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.
 114          */
 115         void OnInvalidateData(int data = 0, bool gui_scope = true) override
 116         {
 117                 if (!gui_scope) return;
 118
 119                 bool can_build = CanBuildVehicleInfrastructure(VEH_SHIP);
 120                 this->SetWidgetsDisabledState(!can_build,
 121                         WID_DT_DEPOT,
 122                         WID_DT_STATION,
 123                         WID_DT_BUOY,
 124                         WIDGET_LIST_END);
 125                 if (!can_build) {
 126                         DeleteWindowById(WC_BUILD_STATION, TRANSPORT_WATER);
 127                         DeleteWindowById(WC_BUILD_DEPOT, TRANSPORT_WATER);
 128                 }
 129
 130                 if (_game_mode != GM_EDITOR) {
 131                         if (!can_build) {
 132                                 /* Show in the tooltip why this button is disabled. */
 133                                 this->GetWidget<NWidgetCore>(WID_DT_DEPOT)->SetToolTip(STR_TOOLBAR_DISABLED_NO_VEHICLE_AVAILABLE);
 134                                 this->GetWidget<NWidgetCore>(WID_DT_STATION)->SetToolTip(STR_TOOLBAR_DISABLED_NO_VEHICLE_AVAILABLE);
 135                                 this->GetWidget<NWidgetCore>(WID_DT_BUOY)->SetToolTip(STR_TOOLBAR_DISABLED_NO_VEHICLE_AVAILABLE);
 136                         } else {
 137                                 this->GetWidget<NWidgetCore>(WID_DT_DEPOT)->SetToolTip(STR_WATERWAYS_TOOLBAR_BUILD_DEPOT_TOOLTIP);
 138                                 this->GetWidget<NWidgetCore>(WID_DT_STATION)->SetToolTip(STR_WATERWAYS_TOOLBAR_BUILD_DOCK_TOOLTIP);
 139                                 this->GetWidget<NWidgetCore>(WID_DT_BUOY)->SetToolTip(STR_WATERWAYS_TOOLBAR_BUOY_TOOLTIP);
 140                         }
 141                 }
 142         }
 143
 144         void OnClick(Point pt, int widget, int click_count) override
 145         {
 146                 switch (widget) {
 147                         case WID_DT_CANAL: // Build canal button
 148                                 HandlePlacePushButton(this, WID_DT_CANAL, SPR_CURSOR_CANAL, HT_RECT);
 149                                 break;
 150
 151                         case WID_DT_LOCK: // Build lock button
 152                                 HandlePlacePushButton(this, WID_DT_LOCK, SPR_CURSOR_LOCK, HT_SPECIAL);
 153                                 break;
 154
 155                         case WID_DT_DEMOLISH: // Demolish aka dynamite button
 156                                 HandlePlacePushButton(this, WID_DT_DEMOLISH, ANIMCURSOR_DEMOLISH, HT_RECT | HT_DIAGONAL);
 157                                 break;
 158
 159                         case WID_DT_DEPOT: // Build depot button
 160                                 if (HandlePlacePushButton(this, WID_DT_DEPOT, SPR_CURSOR_SHIP_DEPOT, HT_RECT)) ShowBuildDocksDepotPicker(this);
 161                                 break;
 162
 163                         case WID_DT_STATION: // Build station button
 164                                 if (HandlePlacePushButton(this, WID_DT_STATION, SPR_CURSOR_DOCK, HT_SPECIAL)) ShowBuildDockStationPicker(this);
 165                                 break;
 166
 167                         case WID_DT_BUOY: // Build buoy button
 168                                 HandlePlacePushButton(this, WID_DT_BUOY, SPR_CURSOR_BUOY, HT_RECT);
 169                                 break;
 170
 171                         case WID_DT_RIVER: // Build river button (in scenario editor)
 172                                 if (_game_mode != GM_EDITOR) return;
 173                                 HandlePlacePushButton(this, WID_DT_RIVER, SPR_CURSOR_RIVER, HT_RECT);
 174                                 break;
 175
 176                         case WID_DT_BUILD_AQUEDUCT: // Build aqueduct button
 177                                 HandlePlacePushButton(this, WID_DT_BUILD_AQUEDUCT, SPR_CURSOR_AQUEDUCT, HT_SPECIAL);
 178                                 break;
 179
 180                         default: return;
 181                 }
 182                 this->last_clicked_widget = (DockToolbarWidgets)widget;
 183         }
 184
 185         void OnPlaceObject(Point pt, TileIndex tile) override
 186         {
 187                 switch (this->last_clicked_widget) {
 188                         case WID_DT_CANAL: // Build canal button
 189                                 VpStartPlaceSizing(tile, (_game_mode == GM_EDITOR) ? VPM_X_AND_Y : VPM_X_OR_Y, DDSP_CREATE_WATER);
 190                                 break;
 191
 192                         case WID_DT_LOCK: // Build lock button
 193                                 DoCommandP(tile, 0, 0, CMD_BUILD_LOCK | CMD_MSG(STR_ERROR_CAN_T_BUILD_LOCKS), CcBuildDocks);
 194                                 break;
 195
 196                         case WID_DT_DEMOLISH: // Demolish aka dynamite button
 197                                 PlaceProc_DemolishArea(tile);
 198                                 break;
 199
 200                         case WID_DT_DEPOT: // Build depot button
 201                                 DoCommandP(tile, _ship_depot_direction, 0, CMD_BUILD_SHIP_DEPOT | CMD_MSG(STR_ERROR_CAN_T_BUILD_SHIP_DEPOT), CcBuildDocks);
 202                                 break;
 203
 204                         case WID_DT_STATION: { // Build station button
 205                                 uint32 p2 = (uint32)INVALID_STATION << 16; // no station to join
 206
 207                                 /* tile is always the land tile, so need to evaluate _thd.pos */
 208                                 CommandContainer cmdcont = { tile, _ctrl_pressed, p2, CMD_BUILD_DOCK | CMD_MSG(STR_ERROR_CAN_T_BUILD_DOCK_HERE), CcBuildDocks, "" };
 209
 210                                 /* Determine the watery part of the dock. */
 211                                 DiagDirection dir = GetInclinedSlopeDirection(GetTileSlope(tile));
 212                                 TileIndex tile_to = (dir != INVALID_DIAGDIR ? TileAddByDiagDir(tile, ReverseDiagDir(dir)) : tile);
 213
 214                                 ShowSelectStationIfNeeded(cmdcont, TileArea(tile, tile_to));
 215                                 break;
 216                         }
 217
 218                         case WID_DT_BUOY: // Build buoy button
 219                                 DoCommandP(tile, 0, 0, CMD_BUILD_BUOY | CMD_MSG(STR_ERROR_CAN_T_POSITION_BUOY_HERE), CcBuildDocks);
 220                                 break;
 221
 222                         case WID_DT_RIVER: // Build river button (in scenario editor)
 223                                 VpStartPlaceSizing(tile, VPM_X_AND_Y, DDSP_CREATE_RIVER);
 224                                 break;
 225
 226                         case WID_DT_BUILD_AQUEDUCT: // Build aqueduct button
 227                                 DoCommandP(tile, GetOtherAqueductEnd(tile), TRANSPORT_WATER << 15, CMD_BUILD_BRIDGE | CMD_MSG(STR_ERROR_CAN_T_BUILD_AQUEDUCT_HERE), CcBuildBridge);
 228                                 break;
 229
 230                         default: NOT_REACHED();
 231                 }
 232         }
 233
 234         void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
 235         {
 236                 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
 237         }
 238
 239         void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
 240         {
 241                 if (pt.x != -1) {
 242                         switch (select_proc) {
 243                                 case DDSP_DEMOLISH_AREA:
 244                                         GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
 245                                         break;
 246                                 case DDSP_CREATE_WATER:
 247                                         DoCommandP(end_tile, start_tile, (_game_mode == GM_EDITOR && _ctrl_pressed) ? WATER_CLASS_SEA : WATER_CLASS_CANAL, CMD_BUILD_CANAL | CMD_MSG(STR_ERROR_CAN_T_BUILD_CANALS), CcPlaySound_CONSTRUCTION_WATER);
 248                                         break;
 249                                 case DDSP_CREATE_RIVER:
 250                                         DoCommandP(end_tile, start_tile, WATER_CLASS_RIVER, CMD_BUILD_CANAL | CMD_MSG(STR_ERROR_CAN_T_PLACE_RIVERS), CcPlaySound_CONSTRUCTION_WATER);
 251                                         break;
 252
 253                                 default: break;
 254                         }
 255                 }
 256         }
 257
 258         void OnPlaceObjectAbort() override
 259         {
 260                 if (_game_mode != GM_EDITOR && this->IsWidgetLowered(WID_DT_STATION)) SetViewportCatchmentStation(nullptr, true);
 261
 262                 this->RaiseButtons();
 263
 264                 DeleteWindowById(WC_BUILD_STATION, TRANSPORT_WATER);
 265                 DeleteWindowById(WC_BUILD_DEPOT, TRANSPORT_WATER);
 266                 DeleteWindowById(WC_SELECT_STATION, 0);
 267                 DeleteWindowByClass(WC_BUILD_BRIDGE);
 268         }
 269
 270         void OnPlacePresize(Point pt, TileIndex tile_from) override
 271         {
 272                 TileIndex tile_to = tile_from;
 273
 274                 if (this->last_clicked_widget == WID_DT_BUILD_AQUEDUCT) {
 275                         GetOtherAqueductEnd(tile_from, &tile_to);
 276                 } else {
 277                         DiagDirection dir = GetInclinedSlopeDirection(GetTileSlope(tile_from));
 278                         if (IsValidDiagDirection(dir)) {
 279                                 /* Locks and docks always select the tile "down" the slope. */
 280                                 tile_to = TileAddByDiagDir(tile_from, ReverseDiagDir(dir));
 281                                 /* Locks also select the tile "up" the slope. */
 282                                 if (this->last_clicked_widget == WID_DT_LOCK) tile_from = TileAddByDiagDir(tile_from, dir);
 283                         }
 284                 }
 285
 286                 VpSetPresizeRange(tile_from, tile_to);
 287         }
 288
 289         static HotkeyList hotkeys;
 290 };
 291
 292 /**
 293  * Handler for global hotkeys of the BuildDocksToolbarWindow.
 294  * @param hotkey Hotkey
 295  * @return ES_HANDLED if hotkey was accepted.
 296  */
 297 static EventState DockToolbarGlobalHotkeys(int hotkey)
 298 {
 299         if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
 300         Window *w = ShowBuildDocksToolbar();
 301         if (w == nullptr) return ES_NOT_HANDLED;
 302         return w->OnHotkey(hotkey);
 303 }
 304
 305 const uint16 _dockstoolbar_aqueduct_keys[] = {'B', '8', 0};
 306
 307 static Hotkey dockstoolbar_hotkeys[] = {
 308         Hotkey('1', "canal", WID_DT_CANAL),
 309         Hotkey('2', "lock", WID_DT_LOCK),
 310         Hotkey('3', "demolish", WID_DT_DEMOLISH),
 311         Hotkey('4', "depot", WID_DT_DEPOT),
 312         Hotkey('5', "dock", WID_DT_STATION),
 313         Hotkey('6', "buoy", WID_DT_BUOY),
 314         Hotkey('7', "river", WID_DT_RIVER),
 315         Hotkey(_dockstoolbar_aqueduct_keys, "aqueduct", WID_DT_BUILD_AQUEDUCT),
 316         HOTKEY_LIST_END
 317 };
 318 HotkeyList BuildDocksToolbarWindow::hotkeys("dockstoolbar", dockstoolbar_hotkeys, DockToolbarGlobalHotkeys);
 319
 320 /**
 321  * Nested widget parts of docks toolbar, game version.
 322  * Position of #WID_DT_RIVER widget has changed.
 323  */
 324 static const NWidgetPart _nested_build_docks_toolbar_widgets[] = {
 325         NWidget(NWID_HORIZONTAL),
 326                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 327                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_WATERWAYS_TOOLBAR_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 328                 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
 329         EndContainer(),
 330         NWidget(NWID_HORIZONTAL_LTR),
 331                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_CANAL), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUILD_CANAL, STR_WATERWAYS_TOOLBAR_BUILD_CANALS_TOOLTIP),
 332                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_LOCK), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUILD_LOCK, STR_WATERWAYS_TOOLBAR_BUILD_LOCKS_TOOLTIP),
 333                 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
 334                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
 335                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEPOT), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_SHIP_DEPOT, STR_WATERWAYS_TOOLBAR_BUILD_DEPOT_TOOLTIP),
 336                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_STATION), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_SHIP_DOCK, STR_WATERWAYS_TOOLBAR_BUILD_DOCK_TOOLTIP),
 337                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUOY), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUOY, STR_WATERWAYS_TOOLBAR_BUOY_TOOLTIP),
 338                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUILD_AQUEDUCT), SetMinimalSize(23, 22), SetFill(0, 1), SetDataTip(SPR_IMG_AQUEDUCT, STR_WATERWAYS_TOOLBAR_BUILD_AQUEDUCT_TOOLTIP),
 339         EndContainer(),
 340 };
 341
 342 static WindowDesc _build_docks_toolbar_desc(
 343         WDP_ALIGN_TOOLBAR, "toolbar_water", 0, 0,
 344         WC_BUILD_TOOLBAR, WC_NONE,
 345         WDF_CONSTRUCTION,
 346         _nested_build_docks_toolbar_widgets, lengthof(_nested_build_docks_toolbar_widgets),
 347         &BuildDocksToolbarWindow::hotkeys
 348 );
 349
 350 /**
 351  * Open the build water toolbar window
 352  *
 353  * If the terraform toolbar is linked to the toolbar, that window is also opened.
 354  *
 355  * @return newly opened water toolbar, or nullptr if the toolbar could not be opened.
 356  */
 357 Window *ShowBuildDocksToolbar()
 358 {
 359         if (!Company::IsValidID(_local_company)) return nullptr;
 360
 361         DeleteWindowByClass(WC_BUILD_TOOLBAR);
 362         return AllocateWindowDescFront<BuildDocksToolbarWindow>(&_build_docks_toolbar_desc, TRANSPORT_WATER);
 363 }
 364
 365 /**
 366  * Nested widget parts of docks toolbar, scenario editor version.
 367  * Positions of #WID_DT_DEPOT, #WID_DT_STATION, and #WID_DT_BUOY widgets have changed.
 368  */
 369 static const NWidgetPart _nested_build_docks_scen_toolbar_widgets[] = {
 370         NWidget(NWID_HORIZONTAL),
 371                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 372                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_WATERWAYS_TOOLBAR_CAPTION_SE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 373                 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
 374         EndContainer(),
 375         NWidget(NWID_HORIZONTAL),
 376                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_CANAL), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUILD_CANAL, STR_WATERWAYS_TOOLBAR_CREATE_LAKE_TOOLTIP),
 377                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_LOCK), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUILD_LOCK, STR_WATERWAYS_TOOLBAR_BUILD_LOCKS_TOOLTIP),
 378                 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
 379                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
 380                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_RIVER), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUILD_RIVER, STR_WATERWAYS_TOOLBAR_CREATE_RIVER_TOOLTIP),
 381                 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUILD_AQUEDUCT), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_AQUEDUCT, STR_WATERWAYS_TOOLBAR_BUILD_AQUEDUCT_TOOLTIP),
 382         EndContainer(),
 383 };
 384
 385 /** Window definition for the build docks in scenario editor window. */
 386 static WindowDesc _build_docks_scen_toolbar_desc(
 387         WDP_AUTO, "toolbar_water_scen", 0, 0,
 388         WC_SCEN_BUILD_TOOLBAR, WC_NONE,
 389         WDF_CONSTRUCTION,
 390         _nested_build_docks_scen_toolbar_widgets, lengthof(_nested_build_docks_scen_toolbar_widgets)
 391 );
 392
 393 /**
 394  * Open the build water toolbar window for the scenario editor.
 395  *
 396  * @return newly opened water toolbar, or nullptr if the toolbar could not be opened.
 397  */
 398 Window *ShowBuildDocksScenToolbar()
 399 {
 400         return AllocateWindowDescFront<BuildDocksToolbarWindow>(&_build_docks_scen_toolbar_desc, TRANSPORT_WATER);
 401 }
 402
 403 /** Widget numbers of the build-dock GUI. */
 404 enum BuildDockStationWidgets {
 405         BDSW_BACKGROUND, ///< Background panel.
 406         BDSW_LT_OFF,     ///< 'Off' button of coverage high light.
 407         BDSW_LT_ON,      ///< 'On' button of coverage high light.
 408         BDSW_INFO,       ///< 'Coverage highlight' label.
 409 };
 410
 411 struct BuildDocksStationWindow : public PickerWindowBase {
 412 public:
 413         BuildDocksStationWindow(WindowDesc *desc, Window *parent) : PickerWindowBase(desc, parent)
 414         {
 415                 this->InitNested(TRANSPORT_WATER);
 416                 this->LowerWidget(_settings_client.gui.station_show_coverage + BDSW_LT_OFF);
 417         }
 418
 419         virtual ~BuildDocksStationWindow()
 420         {
 421                 DeleteWindowById(WC_SELECT_STATION, 0);
 422         }
 423
 424         void OnPaint() override
 425         {
 426                 int rad = (_settings_game.station.modified_catchment) ? CA_DOCK : CA_UNMODIFIED;
 427
 428                 this->DrawWidgets();
 429
 430                 if (_settings_client.gui.station_show_coverage) {
 431                         SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
 432                 } else {
 433                         SetTileSelectSize(1, 1);
 434                 }
 435
 436                 /* strings such as 'Size' and 'Coverage Area' */
 437                 int top = this->GetWidget<NWidgetBase>(BDSW_LT_OFF)->pos_y + this->GetWidget<NWidgetBase>(BDSW_LT_OFF)->current_y + WD_PAR_VSEP_NORMAL;
 438                 NWidgetBase *back_nwi = this->GetWidget<NWidgetBase>(BDSW_BACKGROUND);
 439                 int right  = back_nwi->pos_x + back_nwi->current_x;
 440                 int bottom = back_nwi->pos_y + back_nwi->current_y;
 441                 top = DrawStationCoverageAreaText(back_nwi->pos_x + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, SCT_ALL, rad, false) + WD_PAR_VSEP_NORMAL;
 442                 top = DrawStationCoverageAreaText(back_nwi->pos_x + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, SCT_ALL, rad, true) + WD_PAR_VSEP_NORMAL;
 443                 /* Resize background if the window is too small.
 444                  * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
 445                  * (This is the case, if making the window bigger moves the mouse into the window.) */
 446                 if (top > bottom) {
 447                         ResizeWindow(this, 0, top - bottom, false);
 448                 }
 449         }
 450
 451         void OnClick(Point pt, int widget, int click_count) override
 452         {
 453                 switch (widget) {
 454                         case BDSW_LT_OFF:
 455                         case BDSW_LT_ON:
 456                                 this->RaiseWidget(_settings_client.gui.station_show_coverage + BDSW_LT_OFF);
 457                                 _settings_client.gui.station_show_coverage = (widget != BDSW_LT_OFF);
 458                                 this->LowerWidget(_settings_client.gui.station_show_coverage + BDSW_LT_OFF);
 459                                 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
 460                                 this->SetDirty();
 461                                 SetViewportCatchmentStation(nullptr, true);
 462                                 break;
 463                 }
 464         }
 465
 466         void OnRealtimeTick(uint delta_ms) override
 467         {
 468                 CheckRedrawStationCoverage(this);
 469         }
 470 };
 471
 472 /** Nested widget parts of a build dock station window. */
 473 static const NWidgetPart _nested_build_dock_station_widgets[] = {
 474         NWidget(NWID_HORIZONTAL),
 475                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 476                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_STATION_BUILD_DOCK_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 477         EndContainer(),
 478         NWidget(WWT_PANEL, COLOUR_DARK_GREEN, BDSW_BACKGROUND),
 479                 NWidget(NWID_SPACER), SetMinimalSize(0, 3),
 480                 NWidget(WWT_LABEL, COLOUR_DARK_GREEN, BDSW_INFO), SetMinimalSize(148, 14), SetDataTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE, STR_NULL),
 481                 NWidget(NWID_HORIZONTAL), SetPIP(14, 0, 14),
 482                         NWidget(WWT_TEXTBTN, COLOUR_GREY, BDSW_LT_OFF), SetMinimalSize(40, 12), SetFill(1, 0), SetDataTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
 483                         NWidget(WWT_TEXTBTN, COLOUR_GREY, BDSW_LT_ON), SetMinimalSize(40, 12), SetFill(1, 0), SetDataTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
 484                 EndContainer(),
 485                 NWidget(NWID_SPACER), SetMinimalSize(0, 20), SetResize(0, 1),
 486         EndContainer(),
 487 };
 488
 489 static WindowDesc _build_dock_station_desc(
 490         WDP_AUTO, nullptr, 0, 0,
 491         WC_BUILD_STATION, WC_BUILD_TOOLBAR,
 492         WDF_CONSTRUCTION,
 493         _nested_build_dock_station_widgets, lengthof(_nested_build_dock_station_widgets)
 494 );
 495
 496 static void ShowBuildDockStationPicker(Window *parent)
 497 {
 498         new BuildDocksStationWindow(&_build_dock_station_desc, parent);
 499 }
 500
 501 struct BuildDocksDepotWindow : public PickerWindowBase {
 502 private:
 503         static void UpdateDocksDirection()
 504         {
 505                 if (_ship_depot_direction != AXIS_X) {
 506                         SetTileSelectSize(1, 2);
 507                 } else {
 508                         SetTileSelectSize(2, 1);
 509                 }
 510         }
 511
 512 public:
 513         BuildDocksDepotWindow(WindowDesc *desc, Window *parent) : PickerWindowBase(desc, parent)
 514         {
 515                 this->InitNested(TRANSPORT_WATER);
 516                 this->LowerWidget(_ship_depot_direction + WID_BDD_X);
 517                 UpdateDocksDirection();
 518         }
 519
 520         void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
 521         {
 522                 switch (widget) {
 523                         case WID_BDD_X:
 524                         case WID_BDD_Y:
 525                                 size->width  = ScaleGUITrad(96) + 2;
 526                                 size->height = ScaleGUITrad(64) + 2;
 527                                 break;
 528                 }
 529         }
 530
 531         void OnPaint() override
 532         {
 533                 this->DrawWidgets();
 534
 535                 int x1 = ScaleGUITrad(63) + 1;
 536                 int x2 = ScaleGUITrad(31) + 1;
 537                 int y1 = ScaleGUITrad(17) + 1;
 538                 int y2 = ScaleGUITrad(33) + 1;
 539
 540                 DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_x + x1, this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_y + y1, AXIS_X, DEPOT_PART_NORTH);
 541                 DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_x + x2, this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_y + y2, AXIS_X, DEPOT_PART_SOUTH);
 542                 DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_x + x2, this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_y + y1, AXIS_Y, DEPOT_PART_NORTH);
 543                 DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_x + x1, this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_y + y2, AXIS_Y, DEPOT_PART_SOUTH);
 544         }
 545
 546         void OnClick(Point pt, int widget, int click_count) override
 547         {
 548                 switch (widget) {
 549                         case WID_BDD_X:
 550                         case WID_BDD_Y:
 551                                 this->RaiseWidget(_ship_depot_direction + WID_BDD_X);
 552                                 _ship_depot_direction = (widget == WID_BDD_X ? AXIS_X : AXIS_Y);
 553                                 this->LowerWidget(_ship_depot_direction + WID_BDD_X);
 554                                 if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
 555                                 UpdateDocksDirection();
 556                                 this->SetDirty();
 557                                 break;
 558                 }
 559         }
 560 };
 561
 562 static const NWidgetPart _nested_build_docks_depot_widgets[] = {
 563         NWidget(NWID_HORIZONTAL),
 564                 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
 565                 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_DEPOT_BUILD_SHIP_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
 566         EndContainer(),
 567         NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BDD_BACKGROUND),
 568                 NWidget(NWID_SPACER), SetMinimalSize(0, 3),
 569                 NWidget(NWID_HORIZONTAL_LTR),
 570                         NWidget(NWID_SPACER), SetMinimalSize(3, 0),
 571                         NWidget(WWT_PANEL, COLOUR_GREY, WID_BDD_X), SetMinimalSize(98, 66), SetDataTip(0x0, STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
 572                         EndContainer(),
 573                         NWidget(NWID_SPACER), SetMinimalSize(2, 0),
 574                         NWidget(WWT_PANEL, COLOUR_GREY, WID_BDD_Y), SetMinimalSize(98, 66), SetDataTip(0x0, STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
 575                         EndContainer(),
 576                         NWidget(NWID_SPACER), SetMinimalSize(3, 0),
 577                 EndContainer(),
 578                 NWidget(NWID_SPACER), SetMinimalSize(0, 3),
 579         EndContainer(),
 580 };
 581
 582 static WindowDesc _build_docks_depot_desc(
 583         WDP_AUTO, nullptr, 0, 0,
 584         WC_BUILD_DEPOT, WC_BUILD_TOOLBAR,
 585         WDF_CONSTRUCTION,
 586         _nested_build_docks_depot_widgets, lengthof(_nested_build_docks_depot_widgets)
 587 );
 588
 589
 590 static void ShowBuildDocksDepotPicker(Window *parent)
 591 {
 592         new BuildDocksDepotWindow(&_build_docks_depot_desc, parent);
 593 }
 594
 595
 596 void InitializeDockGui()
 597 {
 598         _ship_depot_direction = AXIS_X;
 599 }