OpenTTD
dock_gui.cpp
Go to the documentation of this file.
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 
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_SPLAT_WATER, tile);
47 }
48 
49 void CcPlaySound_SPLAT_WATER(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
50 {
51  if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_02_SPLAT_WATER, tile);
52 }
53 
54 
61 static TileIndex GetOtherAqueductEnd(TileIndex tile_from, TileIndex *tile_to = nullptr)
62 {
63  int 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. */
74  /* The maximum length of the aqueduct. */
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 
95 
97  {
98  this->last_clicked_widget = WID_DT_INVALID;
99  this->InitNested(window_number);
100  this->OnInvalidateData();
102  }
103 
105  {
106  if (_game_mode == GM_NORMAL && this->IsWidgetLowered(WID_DT_STATION)) SetViewportCatchmentStation(nullptr, true);
108  }
109 
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,
123  WID_DT_BUOY,
125  if (!can_build) {
128  }
129  }
130 
131  void OnClick(Point pt, int widget, int click_count) override
132  {
133  switch (widget) {
134  case WID_DT_CANAL: // Build canal button
135  HandlePlacePushButton(this, WID_DT_CANAL, SPR_CURSOR_CANAL, HT_RECT);
136  break;
137 
138  case WID_DT_LOCK: // Build lock button
139  HandlePlacePushButton(this, WID_DT_LOCK, SPR_CURSOR_LOCK, HT_SPECIAL);
140  break;
141 
142  case WID_DT_DEMOLISH: // Demolish aka dynamite button
144  break;
145 
146  case WID_DT_DEPOT: // Build depot button
148  if (HandlePlacePushButton(this, WID_DT_DEPOT, SPR_CURSOR_SHIP_DEPOT, HT_RECT)) ShowBuildDocksDepotPicker(this);
149  break;
150 
151  case WID_DT_STATION: // Build station button
153  if (HandlePlacePushButton(this, WID_DT_STATION, SPR_CURSOR_DOCK, HT_SPECIAL)) ShowBuildDockStationPicker(this);
154  break;
155 
156  case WID_DT_BUOY: // Build buoy button
158  HandlePlacePushButton(this, WID_DT_BUOY, SPR_CURSOR_BUOY, HT_RECT);
159  break;
160 
161  case WID_DT_RIVER: // Build river button (in scenario editor)
162  if (_game_mode != GM_EDITOR) return;
163  HandlePlacePushButton(this, WID_DT_RIVER, SPR_CURSOR_RIVER, HT_RECT);
164  break;
165 
166  case WID_DT_BUILD_AQUEDUCT: // Build aqueduct button
167  HandlePlacePushButton(this, WID_DT_BUILD_AQUEDUCT, SPR_CURSOR_AQUEDUCT, HT_SPECIAL);
168  break;
169 
170  default: return;
171  }
172  this->last_clicked_widget = (DockToolbarWidgets)widget;
173  }
174 
175  void OnPlaceObject(Point pt, TileIndex tile) override
176  {
177  switch (this->last_clicked_widget) {
178  case WID_DT_CANAL: // Build canal button
179  VpStartPlaceSizing(tile, (_game_mode == GM_EDITOR) ? VPM_X_AND_Y : VPM_X_OR_Y, DDSP_CREATE_WATER);
180  break;
181 
182  case WID_DT_LOCK: // Build lock button
183  DoCommandP(tile, 0, 0, CMD_BUILD_LOCK | CMD_MSG(STR_ERROR_CAN_T_BUILD_LOCKS), CcBuildDocks);
184  break;
185 
186  case WID_DT_DEMOLISH: // Demolish aka dynamite button
188  break;
189 
190  case WID_DT_DEPOT: // Build depot button
191  DoCommandP(tile, _ship_depot_direction, 0, CMD_BUILD_SHIP_DEPOT | CMD_MSG(STR_ERROR_CAN_T_BUILD_SHIP_DEPOT), CcBuildDocks);
192  break;
193 
194  case WID_DT_STATION: { // Build station button
195  uint32 p2 = (uint32)INVALID_STATION << 16; // no station to join
196 
197  /* tile is always the land tile, so need to evaluate _thd.pos */
198  CommandContainer cmdcont = { tile, _ctrl_pressed, p2, CMD_BUILD_DOCK | CMD_MSG(STR_ERROR_CAN_T_BUILD_DOCK_HERE), CcBuildDocks, "" };
199 
200  /* Determine the watery part of the dock. */
202  TileIndex tile_to = (dir != INVALID_DIAGDIR ? TileAddByDiagDir(tile, ReverseDiagDir(dir)) : tile);
203 
204  ShowSelectStationIfNeeded(cmdcont, TileArea(tile, tile_to));
205  break;
206  }
207 
208  case WID_DT_BUOY: // Build buoy button
209  DoCommandP(tile, 0, 0, CMD_BUILD_BUOY | CMD_MSG(STR_ERROR_CAN_T_POSITION_BUOY_HERE), CcBuildDocks);
210  break;
211 
212  case WID_DT_RIVER: // Build river button (in scenario editor)
214  break;
215 
216  case WID_DT_BUILD_AQUEDUCT: // Build aqueduct button
217  DoCommandP(tile, GetOtherAqueductEnd(tile), TRANSPORT_WATER << 15, CMD_BUILD_BRIDGE | CMD_MSG(STR_ERROR_CAN_T_BUILD_AQUEDUCT_HERE), CcBuildBridge);
218  break;
219 
220  default: NOT_REACHED();
221  }
222  }
223 
224  void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
225  {
226  VpSelectTilesWithMethod(pt.x, pt.y, select_method);
227  }
228 
229  void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
230  {
231  if (pt.x != -1) {
232  switch (select_proc) {
233  case DDSP_DEMOLISH_AREA:
234  GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
235  break;
236  case DDSP_CREATE_WATER:
237  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_SPLAT_WATER);
238  break;
239  case DDSP_CREATE_RIVER:
240  DoCommandP(end_tile, start_tile, WATER_CLASS_RIVER, CMD_BUILD_CANAL | CMD_MSG(STR_ERROR_CAN_T_PLACE_RIVERS), CcPlaySound_SPLAT_WATER);
241  break;
242 
243  default: break;
244  }
245  }
246  }
247 
248  void OnPlaceObjectAbort() override
249  {
250  if (_game_mode != GM_EDITOR && this->IsWidgetLowered(WID_DT_STATION)) SetViewportCatchmentStation(nullptr, true);
251 
252  this->RaiseButtons();
253 
258  }
259 
260  void OnPlacePresize(Point pt, TileIndex tile_from) override
261  {
262  TileIndex tile_to = tile_from;
263 
264  if (this->last_clicked_widget == WID_DT_BUILD_AQUEDUCT) {
265  GetOtherAqueductEnd(tile_from, &tile_to);
266  } else {
268  if (IsValidDiagDirection(dir)) {
269  /* Locks and docks always select the tile "down" the slope. */
270  tile_to = TileAddByDiagDir(tile_from, ReverseDiagDir(dir));
271  /* Locks also select the tile "up" the slope. */
272  if (this->last_clicked_widget == WID_DT_LOCK) tile_from = TileAddByDiagDir(tile_from, dir);
273  }
274  }
275 
276  VpSetPresizeRange(tile_from, tile_to);
277  }
278 
279  static HotkeyList hotkeys;
280 };
281 
288 {
289  if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
291  if (w == nullptr) return ES_NOT_HANDLED;
292  return w->OnHotkey(hotkey);
293 }
294 
295 const uint16 _dockstoolbar_aqueduct_keys[] = {'B', '8', 0};
296 
297 static Hotkey dockstoolbar_hotkeys[] = {
298  Hotkey('1', "canal", WID_DT_CANAL),
299  Hotkey('2', "lock", WID_DT_LOCK),
300  Hotkey('3', "demolish", WID_DT_DEMOLISH),
301  Hotkey('4', "depot", WID_DT_DEPOT),
302  Hotkey('5', "dock", WID_DT_STATION),
303  Hotkey('6', "buoy", WID_DT_BUOY),
304  Hotkey('7', "river", WID_DT_RIVER),
305  Hotkey(_dockstoolbar_aqueduct_keys, "aqueduct", WID_DT_BUILD_AQUEDUCT),
306  HOTKEY_LIST_END
307 };
308 HotkeyList BuildDocksToolbarWindow::hotkeys("dockstoolbar", dockstoolbar_hotkeys, DockToolbarGlobalHotkeys);
309 
316  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
317  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_WATERWAYS_TOOLBAR_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
318  NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
319  EndContainer(),
321  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),
322  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),
323  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
324  NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
325  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),
326  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),
327  NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUOY), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_BUOY, STR_WATERWAYS_TOOLBAR_BUOY_TOOLTIP),
328  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),
329  EndContainer(),
330 };
331 
332 static WindowDesc _build_docks_toolbar_desc(
333  WDP_ALIGN_TOOLBAR, "toolbar_water", 0, 0,
336  _nested_build_docks_toolbar_widgets, lengthof(_nested_build_docks_toolbar_widgets),
337  &BuildDocksToolbarWindow::hotkeys
338 );
339 
348 {
349  if (!Company::IsValidID(_local_company)) return nullptr;
350 
352  return AllocateWindowDescFront<BuildDocksToolbarWindow>(&_build_docks_toolbar_desc, TRANSPORT_WATER);
353 }
354 
361  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
362  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_WATERWAYS_TOOLBAR_CAPTION_SE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
363  NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
364  EndContainer(),
366  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),
367  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),
368  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
369  NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
370  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),
371  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),
372  EndContainer(),
373 };
374 
377  WDP_AUTO, "toolbar_water_scen", 0, 0,
380  _nested_build_docks_scen_toolbar_widgets, lengthof(_nested_build_docks_scen_toolbar_widgets)
381 );
382 
389 {
390  return AllocateWindowDescFront<BuildDocksToolbarWindow>(&_build_docks_scen_toolbar_desc, TRANSPORT_WATER);
391 }
392 
399 };
400 
402 public:
404  {
407  }
408 
409  virtual ~BuildDocksStationWindow()
410  {
412  }
413 
414  void OnPaint() override
415  {
417 
418  this->DrawWidgets();
419 
421  SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
422  } else {
423  SetTileSelectSize(1, 1);
424  }
425 
426  /* strings such as 'Size' and 'Coverage Area' */
427  int top = this->GetWidget<NWidgetBase>(BDSW_LT_OFF)->pos_y + this->GetWidget<NWidgetBase>(BDSW_LT_OFF)->current_y + WD_PAR_VSEP_NORMAL;
428  NWidgetBase *back_nwi = this->GetWidget<NWidgetBase>(BDSW_BACKGROUND);
429  int right = back_nwi->pos_x + back_nwi->current_x;
430  int bottom = back_nwi->pos_y + back_nwi->current_y;
433  /* Resize background if the window is too small.
434  * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
435  * (This is the case, if making the window bigger moves the mouse into the window.) */
436  if (top > bottom) {
437  ResizeWindow(this, 0, top - bottom, false);
438  }
439  }
440 
441  void OnClick(Point pt, int widget, int click_count) override
442  {
443  switch (widget) {
444  case BDSW_LT_OFF:
445  case BDSW_LT_ON:
449  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
450  this->SetDirty();
451  break;
452  }
453  }
454 
455  void OnRealtimeTick(uint delta_ms) override
456  {
458  }
459 };
460 
464  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
465  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_STATION_BUILD_DOCK_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
466  EndContainer(),
467  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, BDSW_BACKGROUND),
469  NWidget(WWT_LABEL, COLOUR_DARK_GREEN, BDSW_INFO), SetMinimalSize(148, 14), SetDataTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE, STR_NULL),
470  NWidget(NWID_HORIZONTAL), SetPIP(14, 0, 14),
471  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),
472  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),
473  EndContainer(),
475  EndContainer(),
476 };
477 
478 static WindowDesc _build_dock_station_desc(
479  WDP_AUTO, nullptr, 0, 0,
482  _nested_build_dock_station_widgets, lengthof(_nested_build_dock_station_widgets)
483 );
484 
485 static void ShowBuildDockStationPicker(Window *parent)
486 {
487  new BuildDocksStationWindow(&_build_dock_station_desc, parent);
488 }
489 
491 private:
492  static void UpdateDocksDirection()
493  {
494  if (_ship_depot_direction != AXIS_X) {
495  SetTileSelectSize(1, 2);
496  } else {
497  SetTileSelectSize(2, 1);
498  }
499  }
500 
501 public:
502  BuildDocksDepotWindow(WindowDesc *desc, Window *parent) : PickerWindowBase(desc, parent)
503  {
505  this->LowerWidget(_ship_depot_direction + WID_BDD_X);
506  UpdateDocksDirection();
507  }
508 
509  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
510  {
511  switch (widget) {
512  case WID_BDD_X:
513  case WID_BDD_Y:
514  size->width = ScaleGUITrad(96) + 2;
515  size->height = ScaleGUITrad(64) + 2;
516  break;
517  }
518  }
519 
520  void OnPaint() override
521  {
522  this->DrawWidgets();
523 
524  int x1 = ScaleGUITrad(63) + 1;
525  int x2 = ScaleGUITrad(31) + 1;
526  int y1 = ScaleGUITrad(17) + 1;
527  int y2 = ScaleGUITrad(33) + 1;
528 
529  DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_x + x1, this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_y + y1, AXIS_X, DEPOT_PART_NORTH);
530  DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_x + x2, this->GetWidget<NWidgetBase>(WID_BDD_X)->pos_y + y2, AXIS_X, DEPOT_PART_SOUTH);
531  DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_x + x2, this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_y + y1, AXIS_Y, DEPOT_PART_NORTH);
532  DrawShipDepotSprite(this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_x + x1, this->GetWidget<NWidgetBase>(WID_BDD_Y)->pos_y + y2, AXIS_Y, DEPOT_PART_SOUTH);
533  }
534 
535  void OnClick(Point pt, int widget, int click_count) override
536  {
537  switch (widget) {
538  case WID_BDD_X:
539  case WID_BDD_Y:
540  this->RaiseWidget(_ship_depot_direction + WID_BDD_X);
541  _ship_depot_direction = (widget == WID_BDD_X ? AXIS_X : AXIS_Y);
542  this->LowerWidget(_ship_depot_direction + WID_BDD_X);
543  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
544  UpdateDocksDirection();
545  this->SetDirty();
546  break;
547  }
548  }
549 };
550 
551 static const NWidgetPart _nested_build_docks_depot_widgets[] = {
553  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
554  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_DEPOT_BUILD_SHIP_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
555  EndContainer(),
556  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BDD_BACKGROUND),
560  NWidget(WWT_PANEL, COLOUR_GREY, WID_BDD_X), SetMinimalSize(98, 66), SetDataTip(0x0, STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
561  EndContainer(),
563  NWidget(WWT_PANEL, COLOUR_GREY, WID_BDD_Y), SetMinimalSize(98, 66), SetDataTip(0x0, STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
564  EndContainer(),
566  EndContainer(),
568  EndContainer(),
569 };
570 
571 static WindowDesc _build_docks_depot_desc(
572  WDP_AUTO, nullptr, 0, 0,
575  _nested_build_docks_depot_widgets, lengthof(_nested_build_docks_depot_widgets)
576 );
577 
578 
579 static void ShowBuildDocksDepotPicker(Window *parent)
580 {
581  new BuildDocksDepotWindow(&_build_docks_depot_desc, parent);
582 }
583 
584 
585 void InitializeDockGui()
586 {
587  _ship_depot_direction = AXIS_X;
588 }
EventState
State of handling an event.
Definition: window_type.h:711
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you&#39;ve selected it...
Draw all cargoes.
Definition: station_gui.h:22
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:79
Definition of stuff that is very close to a company, like the company struct itself.
Select station (when joining stations); Window numbers:
Definition: window_type.h:235
bool link_terraform_toolbar
display terraform toolbar when displaying rail, road, water and airport toolbars
Definition: settings_type.h:94
ResizeInfo resize
Resize information.
Definition: window_gui.h:322
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition: window.cpp:610
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:928
Build river button (in scenario editor).
Definition: dock_widget.h:28
void CheckRedrawStationCoverage(const Window *w)
Check whether we need to redraw the station coverage text.
build a dock
Definition: command_type.h:207
Window * parent
Parent window.
Definition: window_gui.h:337
All data for a single hotkey.
Definition: hotkeys.h:22
High level window description.
Definition: window_gui.h:166
static const CursorID ANIMCURSOR_DEMOLISH
704 - 707 - demolish dynamite
Definition: sprites.h:1485
Landscape generation (in Scenario Editor); Window numbers:
Definition: window_type.h:442
int32 TileIndexDiff
An offset value between to tiles.
Definition: map_func.h:154
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
bool station_show_coverage
whether to highlight coverage area
Scenario build toolbar; Window numbers:
Definition: window_type.h:73
Hotkey related functions.
Build depot button.
Definition: dock_widget.h:25
Centered label.
Definition: widget_type.h:55
&#39;Coverage highlight&#39; label.
Definition: dock_gui.cpp:398
void ShowSelectStationIfNeeded(const CommandContainer &cmd, TileArea ta)
Show the station selection window when needed.
Contains enums and function declarations connected with stations GUI.
Window * ShowTerraformToolbar(Window *link)
Show the toolbar for terraforming in the game.
Build station button.
Definition: dock_widget.h:26
Normal amount of vertical space between two paragraphs of text.
Definition: window_gui.h:137
Horizontal container.
Definition: widget_type.h:73
The passed event is not handled.
Definition: window_type.h:713
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
Definition: viewport.cpp:2423
void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets,...)
Sets the enabled/disabled status of a list of widgets.
Definition: window.cpp:536
Background of the window.
Definition: dock_widget.h:15
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
Ship vehicle type.
Definition: vehicle_type.h:26
Transport over water.
void OnPlacePresize(Point pt, TileIndex tile_from) override
The user moves over the map when a tile highlight mode has been set when the special mouse mode has b...
Definition: dock_gui.cpp:260
DockToolbarWidgets last_clicked_widget
Contains the last widget that has been clicked on this toolbar.
Definition: dock_gui.cpp:94
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition: dock_gui.cpp:248
Functions related to vehicles.
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
Y-direction button.
Definition: dock_widget.h:17
Window * ShowBuildDocksToolbar()
Open the build water toolbar window.
Definition: dock_gui.cpp:347
static TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition: map_func.h:382
int top
y position of top edge of the window
Definition: window_gui.h:318
X-direction button.
Definition: dock_widget.h:16
Build depot; Window numbers:
Definition: window_type.h:410
Close box (at top-left of a window)
Definition: widget_type.h:67
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
Definition: viewport.cpp:2648
static EventState DockToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildDocksToolbarWindow.
Definition: dock_gui.cpp:287
Flag for an invalid DiagDirection.
bool persistent_buildingtools
keep the building tools active after usage
Common return value for all commands.
Definition: command_type.h:23
void CcBuildBridge(const CommandCost &result, TileIndex end_tile, uint32 p1, uint32 p2, uint32 cmd)
Callback executed after a build Bridge CMD has been called.
Definition: bridge_gui.cpp:61
Build buoy button.
Definition: dock_widget.h:27
Water construction.
Definition: sound_type.h:39
void RaiseWidget(byte widget_index)
Marks a widget as raised.
Definition: window_gui.h:483
static const NWidgetPart _nested_build_dock_station_widgets[]
Nested widget parts of a build dock station window.
Definition: dock_gui.cpp:462
StationSettings station
settings related to station management
Functions, definitions and such used only by the GUI.
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: dock_gui.cpp:535
void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
The user has dragged over the map when the tile highlight mode has been set.
Definition: dock_gui.cpp:229
Slope GetTileSlope(TileIndex tile, int *h)
Return the slope of a given tile inside the map.
Definition: tile_map.cpp:59
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:161
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
DockToolbarWidgets
Widgets of the BuildDocksToolbarWindow class.
Definition: dock_widget.h:21
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:341
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition: tilearea_type.h:96
Invisible widget that takes some space.
Definition: widget_type.h:77
int DrawStationCoverageAreaText(int left, int right, int top, StationCoverageType sct, int rad, bool supplies)
Calculates and draws the accepted or supplied cargo around the selected tile(s)
Definition: station_gui.cpp:54
The y axis.
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
bool IsWidgetLowered(byte widget_index) const
Gets the lowered state of a widget.
Definition: window_gui.h:493
SoundSettings sound
sound effect settings
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
Definition: viewport_type.h:96
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition: window.cpp:573
Structure for buffering the build command when selecting a station to join.
Definition: command_type.h:475
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
Functions related to the gfx engine.
Functions related to slopes.
drag in X or Y direction
Definition: viewport_type.h:97
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:78
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:945
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:150
Definition of base types and functions in a cross-platform compatible way.
#define TILE_ADDXY(tile, x, y)
Adds a given offset to a tile.
Definition: map_func.h:258
Background panel.
Definition: dock_gui.cpp:395
A number of safeguards to prevent using unsafe methods.
List of hotkeys for a window.
Definition: hotkeys.h:40
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: dock_gui.cpp:115
rectangle (stations, depots, ...)
Simple depressed panel.
Definition: widget_type.h:48
static bool IsValidDiagDirection(DiagDirection d)
Checks if an integer value is a valid DiagDirection.
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
void LowerWidget(byte widget_index)
Marks a widget as lowered.
Definition: window_gui.h:474
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Definition: viewport.cpp:3454
GUI stuff related to terraforming.
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: dock_gui.cpp:131
uint16 max_bridge_length
maximum length of bridges
void OnPaint() override
The window must be repainted.
Definition: dock_gui.cpp:414
static WindowDesc _build_docks_scen_toolbar_desc(WDP_AUTO, "toolbar_water_scen", 0, 0, WC_SCEN_BUILD_TOOLBAR, WC_NONE, WDF_CONSTRUCTION, _nested_build_docks_scen_toolbar_widgets, lengthof(_nested_build_docks_scen_toolbar_widgets))
Window definition for the build docks in scenario editor window.
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1112
Baseclass for nested widgets.
Definition: widget_type.h:124
Build station; Window numbers:
Definition: window_type.h:390
Create rivers.
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:532
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
Definition: viewport.cpp:2605
Catchment for all stations with "modified catchment" disabled.
Definition: station_type.h:82
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
Build bridge; Window numbers:
Definition: window_type.h:382
void PlaceProc_DemolishArea(TileIndex tile)
Start a drag for demolishing an area.
Create a canal.
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:40
uint DistanceFromEdgeDir(TileIndex tile, DiagDirection dir)
Gets the distance to the edge of the map in given direction.
Definition: map.cpp:234
Also allow &#39;diagonal rectangles&#39;. Only usable in combination with HT_RECT or HT_POINT.
static DiagDirection GetInclinedSlopeDirection(Slope s)
Returns the direction of an inclined slope.
Definition: slope_func.h:239
Functions related to sound.
Toolbar window for constructing water infrastructure.
Definition: dock_gui.cpp:93
bool GUIPlaceProcDragXY(ViewportDragDropSelectionProcess proc, TileIndex start_tile, TileIndex end_tile)
A central place to handle all X_AND_Y dragged GUI functions.
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1175
bool Failed() const
Did this command fail?
Definition: command_type.h:159
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Definition: viewport.cpp:3078
Types related to the dock widgets.
static const int WIDGET_LIST_END
indicate the end of widgets&#39; list for vararg functions
Definition: widget_type.h:20
bool CanBuildVehicleInfrastructure(VehicleType type, byte subtype)
Check whether we can build infrastructure for the given vehicle type.
Definition: vehicle.cpp:1754
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
Build toolbar; Window numbers:
Definition: window_type.h:66
The X axis.
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
Delete a window by its class and window number (if it is open).
Definition: window.cpp:1162
Northern part of a depot.
Definition: water_map.h:58
Catchment for docks with "modified catchment" enabled.
Definition: station_type.h:80
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: dock_gui.cpp:455
Functions related to companies.
Demolish aka dynamite button.
Definition: dock_widget.h:24
Build aqueduct button.
Definition: dock_widget.h:29
Build lock button.
Definition: dock_widget.h:23
area of land in X and Y directions
GUISettings gui
settings related to the GUI
Align toward the toolbar.
Definition: window_gui.h:156
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition: tile_map.cpp:141
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition: main_gui.cpp:98
bool modified_catchment
different-size catchment areas
Build canal button.
Definition: dock_widget.h:22
static const NWidgetPart _nested_build_docks_toolbar_widgets[]
Nested widget parts of docks toolbar, game version.
Definition: dock_gui.cpp:314
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:997
Used to initialize a variable.
Definition: dock_widget.h:31
Functions related to zooming.
Southern part of a depot.
Definition: water_map.h:59
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
build a canal
Definition: command_type.h:275
bool confirm
Play sound effect on successful constructions or other actions.
Functions related to commands.
Coordinates of a point in 2D.
build a buoy
Definition: command_type.h:210
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:280
special mode used for highlighting while dragging (and for tunnels/docks)
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: dock_gui.cpp:509
build a bridge
Definition: command_type.h:181
ConstructionSettings construction
construction of things in-game
void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
The user is dragging over the map when the tile highlight mode has been set.
Definition: dock_gui.cpp:224
static const NWidgetPart _nested_build_docks_scen_toolbar_widgets[]
Nested widget parts of docks toolbar, scenario editor version.
Definition: dock_gui.cpp:359
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
static TileIndex GetOtherAqueductEnd(TileIndex tile_from, TileIndex *tile_to=nullptr)
Gets the other end of the aqueduct, if possible.
Definition: dock_gui.cpp:61
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
DiagDirection
Enumeration for diagonal directions.
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:368
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:705
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows)...
Definition: viewport.cpp:3353
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:312
Functions related to tile highlights.
Window functions not directly related to making/drawing windows.
build a ship depot
Definition: command_type.h:209
Find a place automatically.
Definition: window_gui.h:154
Functions related to water (management)
(Toggle) Button with image
Definition: widget_type.h:50
#define TILE_ADD(x, y)
Adds to tiles together.
Definition: map_func.h:244
GUI functions that shouldn&#39;t be here.
Window * ShowBuildDocksScenToolbar()
Open the build water toolbar window for the scenario editor.
Definition: dock_gui.cpp:388
void OnPaint() override
The window must be repainted.
Definition: dock_gui.cpp:520
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: dock_gui.cpp:441
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2142
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
Dimensions (a width and height) of a rectangle in 2D.
bool click_beep
Beep on a random selection of buttons.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
This file contains all sprite-related enums and defines.
Axis
Allow incrementing of DiagDirDiff variables.
Horizontal container that doesn&#39;t change the order of the widgets for RTL languages.
Definition: widget_type.h:74
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
Definition: dock_gui.cpp:175
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1074
&#39;Off&#39; button of coverage high light.
Definition: dock_gui.cpp:396
Base class for windows opened from a toolbar.
Definition: window_gui.h:851
build a lock
Definition: command_type.h:299
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
BuildDockStationWidgets
Widget numbers of the build-dock GUI.
Definition: dock_gui.cpp:394
(Toggle) Button with text
Definition: widget_type.h:53
&#39;On&#39; button of coverage high light.
Definition: dock_gui.cpp:397