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