OpenTTD
airport_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 "window_gui.h"
12 #include "station_gui.h"
13 #include "terraform_gui.h"
14 #include "sound_func.h"
15 #include "window_func.h"
16 #include "strings_func.h"
17 #include "viewport_func.h"
18 #include "company_func.h"
19 #include "tilehighlight_func.h"
20 #include "company_base.h"
21 #include "station_type.h"
22 #include "newgrf_airport.h"
23 #include "newgrf_callbacks.h"
24 #include "widgets/dropdown_type.h"
25 #include "core/geometry_func.hpp"
26 #include "hotkeys.h"
27 #include "vehicle_func.h"
28 #include "gui.h"
29 
30 #include "widgets/airport_widget.h"
31 
32 #include "safeguards.h"
33 
34 
38 
39 static void ShowBuildAirportPicker(Window *parent);
40 
41 SpriteID GetCustomAirportSprite(const AirportSpec *as, byte layout);
42 
43 void CcBuildAirport(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
44 {
45  if (result.Failed()) return;
46 
47  if (_settings_client.sound.confirm) SndPlayTileFx(SND_1F_SPLAT_OTHER, tile);
49 }
50 
55 static void PlaceAirport(TileIndex tile)
56 {
57  if (_selected_airport_index == -1) return;
58  uint32 p2 = _ctrl_pressed;
59  SB(p2, 16, 16, INVALID_STATION); // no station to join
60 
61  uint32 p1 = AirportClass::Get(_selected_airport_class)->GetSpec(_selected_airport_index)->GetIndex();
62  p1 |= _selected_airport_layout << 8;
63  CommandContainer cmdcont = { tile, p1, p2, CMD_BUILD_AIRPORT | CMD_MSG(STR_ERROR_CAN_T_BUILD_AIRPORT_HERE), CcBuildAirport, "" };
64  ShowSelectStationIfNeeded(cmdcont, TileArea(tile, _thd.size.x / TILE_SIZE, _thd.size.y / TILE_SIZE));
65 }
66 
69  int last_user_action; // Last started user action.
70 
72  {
73  this->InitNested(window_number);
75  this->last_user_action = WIDGET_LIST_END;
76  }
77 
79  {
82  }
83 
89  void OnInvalidateData(int data = 0, bool gui_scope = true) override
90  {
91  if (!gui_scope) return;
92 
94  }
95 
96  void OnClick(Point pt, int widget, int click_count) override
97  {
98  switch (widget) {
99  case WID_AT_AIRPORT:
100  if (HandlePlacePushButton(this, WID_AT_AIRPORT, SPR_CURSOR_AIRPORT, HT_RECT)) {
101  ShowBuildAirportPicker(this);
102  this->last_user_action = widget;
103  }
104  break;
105 
106  case WID_AT_DEMOLISH:
108  this->last_user_action = widget;
109  break;
110 
111  default: break;
112  }
113  }
114 
115 
116  void OnPlaceObject(Point pt, TileIndex tile) override
117  {
118  switch (this->last_user_action) {
119  case WID_AT_AIRPORT:
120  PlaceAirport(tile);
121  break;
122 
123  case WID_AT_DEMOLISH:
125  break;
126 
127  default: NOT_REACHED();
128  }
129  }
130 
131  void OnPlaceDrag(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
132  {
133  VpSelectTilesWithMethod(pt.x, pt.y, select_method);
134  }
135 
136  void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
137  {
138  if (pt.x != -1 && select_proc == DDSP_DEMOLISH_AREA) {
139  GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
140  }
141  }
142 
143  void OnPlaceObjectAbort() override
144  {
146 
147  this->RaiseButtons();
148 
151  }
152 
153  static HotkeyList hotkeys;
154 };
155 
162 {
163  if (_game_mode != GM_NORMAL || !CanBuildVehicleInfrastructure(VEH_AIRCRAFT)) return ES_NOT_HANDLED;
165  if (w == nullptr) return ES_NOT_HANDLED;
166  return w->OnHotkey(hotkey);
167 }
168 
169 static Hotkey airtoolbar_hotkeys[] = {
170  Hotkey('1', "airport", WID_AT_AIRPORT),
171  Hotkey('2', "demolish", WID_AT_DEMOLISH),
172  HOTKEY_LIST_END
173 };
174 HotkeyList BuildAirToolbarWindow::hotkeys("airtoolbar", airtoolbar_hotkeys, AirportToolbarGlobalHotkeys);
175 
176 static const NWidgetPart _nested_air_toolbar_widgets[] = {
178  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
179  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_TOOLBAR_AIRCRAFT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
180  NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
181  EndContainer(),
183  NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_AT_AIRPORT), SetFill(0, 1), SetMinimalSize(42, 22), SetDataTip(SPR_IMG_AIRPORT, STR_TOOLBAR_AIRCRAFT_BUILD_AIRPORT_TOOLTIP),
184  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(4, 22), SetFill(1, 1), EndContainer(),
185  NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_AT_DEMOLISH), SetFill(0, 1), SetMinimalSize(22, 22), SetDataTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
186  EndContainer(),
187 };
188 
189 static WindowDesc _air_toolbar_desc(
190  WDP_ALIGN_TOOLBAR, "toolbar_air", 0, 0,
193  _nested_air_toolbar_widgets, lengthof(_nested_air_toolbar_widgets),
194  &BuildAirToolbarWindow::hotkeys
195 );
196 
205 {
206  if (!Company::IsValidID(_local_company)) return nullptr;
207 
209  return AllocateWindowDescFront<BuildAirToolbarWindow>(&_air_toolbar_desc, TRANSPORT_AIR);
210 }
211 
214  int line_height;
215  Scrollbar *vscroll;
216 
219  {
220  DropDownList list;
221 
222  for (uint i = 0; i < AirportClass::GetClassCount(); i++) {
223  list.emplace_back(new DropDownListStringItem(AirportClass::Get((AirportClassID)i)->name, i, false));
224  }
225 
226  return list;
227  }
228 
229 public:
231  {
232  this->CreateNestedTree();
233 
234  this->vscroll = this->GetScrollbar(WID_AP_SCROLLBAR);
235  this->vscroll->SetCapacity(5);
236  this->vscroll->SetPosition(0);
237 
239 
242  this->OnInvalidateData();
243 
244  /* Ensure airport class is valid (changing NewGRFs). */
245  _selected_airport_class = Clamp(_selected_airport_class, APC_BEGIN, (AirportClassID)(AirportClass::GetClassCount() - 1));
247  this->vscroll->SetCount(ac->GetSpecCount());
248 
249  /* Ensure the airport index is valid for this class (changing NewGRFs). */
251 
252  /* Only when no valid airport was selected, we want to select the first airport. */
253  bool selectFirstAirport = true;
254  if (_selected_airport_index != -1) {
255  const AirportSpec *as = ac->GetSpec(_selected_airport_index);
256  if (as->IsAvailable()) {
257  /* Ensure the airport layout is valid. */
259  selectFirstAirport = false;
260  this->UpdateSelectSize();
261  }
262  }
263 
264  if (selectFirstAirport) this->SelectFirstAvailableAirport(true);
265  }
266 
267  virtual ~BuildAirportWindow()
268  {
270  }
271 
272  void SetStringParameters(int widget) const override
273  {
274  switch (widget) {
277  break;
278 
279  case WID_AP_LAYOUT_NUM:
280  SetDParam(0, STR_EMPTY);
281  if (_selected_airport_index != -1) {
284  if (string != STR_UNDEFINED) {
285  SetDParam(0, string);
286  } else if (as->num_table > 1) {
287  SetDParam(0, STR_STATION_BUILD_AIRPORT_LAYOUT_NAME);
289  }
290  }
291  break;
292 
293  default: break;
294  }
295  }
296 
297  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
298  {
299  switch (widget) {
300  case WID_AP_CLASS_DROPDOWN: {
301  Dimension d = {0, 0};
302  for (uint i = 0; i < AirportClass::GetClassCount(); i++) {
304  d = maxdim(d, GetStringBoundingBox(STR_BLACK_STRING));
305  }
306  d.width += padding.width;
307  d.height += padding.height;
308  *size = maxdim(*size, d);
309  break;
310  }
311 
312  case WID_AP_AIRPORT_LIST: {
313  for (int i = 0; i < NUM_AIRPORTS; i++) {
314  const AirportSpec *as = AirportSpec::Get(i);
315  if (!as->enabled) continue;
316 
317  size->width = max(size->width, GetStringBoundingBox(as->name).width);
318  }
319 
320  this->line_height = FONT_HEIGHT_NORMAL + WD_MATRIX_TOP + WD_MATRIX_BOTTOM;
321  size->height = 5 * this->line_height;
322  break;
323  }
324 
326  for (int i = 0; i < NUM_AIRPORTS; i++) {
327  const AirportSpec *as = AirportSpec::Get(i);
328  if (!as->enabled) continue;
329  for (byte layout = 0; layout < as->num_table; layout++) {
330  SpriteID sprite = GetCustomAirportSprite(as, layout);
331  if (sprite != 0) {
332  Dimension d = GetSpriteSize(sprite);
335  *size = maxdim(d, *size);
336  }
337  }
338  }
339  break;
340 
341  case WID_AP_EXTRA_TEXT:
342  for (int i = NEW_AIRPORT_OFFSET; i < NUM_AIRPORTS; i++) {
343  const AirportSpec *as = AirportSpec::Get(i);
344  if (!as->enabled) continue;
345  for (byte layout = 0; layout < as->num_table; layout++) {
347  if (string == STR_UNDEFINED) continue;
348 
349  /* STR_BLACK_STRING is used to start the string with {BLACK} */
350  SetDParam(0, string);
351  Dimension d = GetStringMultiLineBoundingBox(STR_BLACK_STRING, *size);
352  *size = maxdim(d, *size);
353  }
354  }
355  break;
356 
357  default: break;
358  }
359  }
360 
361  void DrawWidget(const Rect &r, int widget) const override
362  {
363  switch (widget) {
364  case WID_AP_AIRPORT_LIST: {
365  int y = r.top;
367  for (uint i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < apclass->GetSpecCount(); i++) {
368  const AirportSpec *as = apclass->GetSpec(i);
369  if (!as->IsAvailable()) {
370  GfxFillRect(r.left + 1, y + 1, r.right - 1, y + this->line_height - 2, PC_BLACK, FILLRECT_CHECKER);
371  }
372  DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y + WD_MATRIX_TOP, as->name, ((int)i == _selected_airport_index) ? TC_WHITE : TC_BLACK);
373  y += this->line_height;
374  }
375  break;
376  }
377 
379  if (this->preview_sprite != 0) {
380  Dimension d = GetSpriteSize(this->preview_sprite);
381  DrawSprite(this->preview_sprite, COMPANY_SPRITE_COLOUR(_local_company), (r.left + r.right - d.width) / 2, (r.top + r.bottom - d.height) / 2);
382  }
383  break;
384 
385  case WID_AP_EXTRA_TEXT:
386  if (_selected_airport_index != -1) {
389  if (string != STR_UNDEFINED) {
390  SetDParam(0, string);
391  DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_BLACK_STRING);
392  }
393  }
394  break;
395  }
396  }
397 
398  void OnPaint() override
399  {
400  this->DrawWidgets();
401 
402  uint16 top = this->GetWidget<NWidgetBase>(WID_AP_BTN_DOHILIGHT)->pos_y + this->GetWidget<NWidgetBase>(WID_AP_BTN_DOHILIGHT)->current_y + WD_PAR_VSEP_NORMAL;
403  NWidgetBase *panel_nwi = this->GetWidget<NWidgetBase>(WID_AP_BOTTOMPANEL);
404 
405  int right = panel_nwi->pos_x + panel_nwi->current_x;
406  int bottom = panel_nwi->pos_y + panel_nwi->current_y;
407 
408  if (_selected_airport_index != -1) {
411 
412  /* only show the station (airport) noise, if the noise option is activated */
414  /* show the noise of the selected airport */
415  SetDParam(0, as->noise_level);
416  DrawString(panel_nwi->pos_x + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, STR_STATION_BUILD_NOISE);
418  }
419 
420  /* strings such as 'Size' and 'Coverage Area' */
421  top = DrawStationCoverageAreaText(panel_nwi->pos_x + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, top, SCT_ALL, rad, false) + WD_PAR_VSEP_NORMAL;
423  }
424 
425  /* Resize background if the window is too small.
426  * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
427  * (This is the case, if making the window bigger moves the mouse into the window.) */
428  if (top > bottom) {
429  ResizeWindow(this, 0, top - bottom, false);
430  }
431  }
432 
433  void SelectOtherAirport(int airport_index)
434  {
435  _selected_airport_index = airport_index;
437 
438  this->UpdateSelectSize();
439  this->SetDirty();
440  }
441 
442  void UpdateSelectSize()
443  {
444  if (_selected_airport_index == -1) {
445  SetTileSelectSize(1, 1);
448  } else {
450  int w = as->size_x;
451  int h = as->size_y;
453  if (rotation == DIR_E || rotation == DIR_W) Swap(w, h);
454  SetTileSelectSize(w, h);
455 
456  this->preview_sprite = GetCustomAirportSprite(as, _selected_airport_layout);
457 
460 
462  if (_settings_client.gui.station_show_coverage) SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
463  }
464  }
465 
466  void OnClick(Point pt, int widget, int click_count) override
467  {
468  switch (widget) {
470  ShowDropDownList(this, BuildAirportClassDropDown(), _selected_airport_class, WID_AP_CLASS_DROPDOWN);
471  break;
472 
473  case WID_AP_AIRPORT_LIST: {
474  int num_clicked = this->vscroll->GetPosition() + (pt.y - this->nested_array[widget]->pos_y) / this->line_height;
475  if (num_clicked >= this->vscroll->GetCount()) break;
476  const AirportSpec *as = AirportClass::Get(_selected_airport_class)->GetSpec(num_clicked);
477  if (as->IsAvailable()) this->SelectOtherAirport(num_clicked);
478  break;
479  }
480 
485  this->SetDirty();
486  if (_settings_client.sound.click_beep) SndPlayFx(SND_15_BEEP);
487  this->UpdateSelectSize();
488  break;
489 
492  this->UpdateSelectSize();
493  this->SetDirty();
494  break;
495 
498  this->UpdateSelectSize();
499  this->SetDirty();
500  break;
501  }
502  }
503 
509  void SelectFirstAvailableAirport(bool change_class)
510  {
511  /* First try to select an airport in the selected class. */
513  for (uint i = 0; i < sel_apclass->GetSpecCount(); i++) {
514  const AirportSpec *as = sel_apclass->GetSpec(i);
515  if (as->IsAvailable()) {
516  this->SelectOtherAirport(i);
517  return;
518  }
519  }
520  if (change_class) {
521  /* If that fails, select the first available airport
522  * from a random class. */
523  for (AirportClassID j = APC_BEGIN; j < APC_MAX; j++) {
524  AirportClass *apclass = AirportClass::Get(j);
525  for (uint i = 0; i < apclass->GetSpecCount(); i++) {
526  const AirportSpec *as = apclass->GetSpec(i);
527  if (as->IsAvailable()) {
529  this->SelectOtherAirport(i);
530  return;
531  }
532  }
533  }
534  }
535  /* If all airports are unavailable, select nothing. */
536  this->SelectOtherAirport(-1);
537  }
538 
539  void OnDropdownSelect(int widget, int index) override
540  {
541  assert(widget == WID_AP_CLASS_DROPDOWN);
543  this->vscroll->SetCount(AirportClass::Get(_selected_airport_class)->GetSpecCount());
544  this->SelectFirstAvailableAirport(false);
545  }
546 
547  void OnRealtimeTick(uint delta_ms) override
548  {
550  }
551 };
552 
553 static const NWidgetPart _nested_build_airport_widgets[] = {
555  NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
556  NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetDataTip(STR_STATION_BUILD_AIRPORT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
557  EndContainer(),
558  NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(1, 0), SetPIP(2, 0, 2),
559  NWidget(WWT_LABEL, COLOUR_DARK_GREEN), SetDataTip(STR_STATION_BUILD_AIRPORT_CLASS_LABEL, STR_NULL), SetFill(1, 0),
560  NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_AP_CLASS_DROPDOWN), SetFill(1, 0), SetDataTip(STR_BLACK_STRING, STR_STATION_BUILD_AIRPORT_TOOLTIP),
561  NWidget(WWT_EMPTY, COLOUR_DARK_GREEN, WID_AP_AIRPORT_SPRITE), SetFill(1, 0),
563  NWidget(WWT_MATRIX, COLOUR_GREY, WID_AP_AIRPORT_LIST), SetFill(1, 0), SetMatrixDataTip(1, 5, STR_STATION_BUILD_AIRPORT_TOOLTIP), SetScrollbar(WID_AP_SCROLLBAR),
565  EndContainer(),
568  NWidget(WWT_LABEL, COLOUR_GREY, WID_AP_LAYOUT_NUM), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_BLACK_STRING, STR_NULL),
570  EndContainer(),
571  NWidget(WWT_EMPTY, COLOUR_DARK_GREEN, WID_AP_EXTRA_TEXT), SetFill(1, 0), SetMinimalSize(150, 0),
572  EndContainer(),
573  /* Bottom panel. */
574  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_AP_BOTTOMPANEL), SetPIP(2, 2, 2),
575  NWidget(WWT_LABEL, COLOUR_DARK_GREEN), SetDataTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE, STR_NULL), SetFill(1, 0),
577  NWidget(NWID_SPACER), SetMinimalSize(14, 0), SetFill(1, 0),
579  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_AP_BTN_DONTHILIGHT), SetMinimalSize(60, 12), SetFill(1, 0),
580  SetDataTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
581  NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_AP_BTN_DOHILIGHT), SetMinimalSize(60, 12), SetFill(1, 0),
582  SetDataTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
583  EndContainer(),
584  NWidget(NWID_SPACER), SetMinimalSize(14, 0), SetFill(1, 0),
585  EndContainer(),
586  NWidget(NWID_SPACER), SetMinimalSize(0, 10), SetResize(0, 1), SetFill(1, 0),
587  EndContainer(),
588 };
589 
590 static WindowDesc _build_airport_desc(
591  WDP_AUTO, "build_station_air", 0, 0,
594  _nested_build_airport_widgets, lengthof(_nested_build_airport_widgets)
595 );
596 
597 static void ShowBuildAirportPicker(Window *parent)
598 {
599  new BuildAirportWindow(&_build_airport_desc, parent);
600 }
601 
602 void InitializeAirportGui()
603 {
606 }
EventState
State of handling an event.
Definition: window_type.h:711
This callback is called from airport list.
Functions related to OTTD&#39;s strings.
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you&#39;ve selected it...
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:275
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.
bool IsAvailable() const
Check whether this airport is available to build.
Select station (when joining stations); Window numbers:
Definition: window_type.h:235
Additional text about the airport.
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
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1867
AirportClassID
List of default airport classes.
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen...
Definition: gfx.cpp:110
void CheckRedrawStationCoverage(const Window *w)
Check whether we need to redraw the station coverage text.
void SetWidgetDisabledState(byte widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition: window_gui.h:392
Offset at right of a matrix cell.
Definition: window_gui.h:77
void SetWidgetLoweredState(byte widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition: window_gui.h:453
byte size_y
size of airport in y direction
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
EconomySettings economy
settings to change the economy
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:602
bool station_show_coverage
whether to highlight coverage area
Hotkey related functions.
uint GetSpecCount() const
Get the number of allocated specs within the class.
Definition: newgrf_class.h:44
Centered label.
Definition: widget_type.h:55
Scrollbar data structure.
Definition: widget_type.h:587
West.
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.
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:62
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
Arrow to the right or in case of RTL to the left.
Definition: widget_type.h:36
Arrow to the left or in case of RTL to the right.
Definition: widget_type.h:35
void OnPaint() override
The window must be repainted.
Point size
Size, in tile "units", of the white/red selection area.
Functions related to vehicles.
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.
void SetPosition(int position)
Sets the position of the first visible element.
Definition: widget_type.h:699
int top
y position of top edge of the window
Definition: window_gui.h:318
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
static AirportClassID _selected_airport_class
the currently visible airport class
Definition: airport_gui.cpp:35
Transport through air.
Close box (at top-left of a window)
Definition: widget_type.h:67
Offset at top of a matrix cell.
Definition: window_gui.h:78
Types related to the airport widgets.
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.
static byte _selected_airport_layout
selected airport layout number.
Definition: airport_gui.cpp:37
Decrease the layout number.
Lowest valid airport class id.
void DisableWidget(byte widget_index)
Sets a widget to disabled.
Definition: window_gui.h:402
bool persistent_buildingtools
keep the building tools active after usage
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Common return value for all commands.
Definition: command_type.h:23
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: airport_gui.cpp:96
Common string list item.
Definition: dropdown_type.h:39
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1828
Callbacks that NewGRFs could implement.
List of airports.
StationSettings station
settings related to station management
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Functions, definitions and such used only by the GUI.
build an airport
Definition: command_type.h:205
NewGRF handling of airports.
void SetCapacity(int capacity)
Set the capacity of visible elements.
Definition: widget_type.h:684
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:668
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:908
Functions related to (drawing on) viewports.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Data structure for an opened window.
Definition: window_gui.h:276
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1844
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1030
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1857
byte catchment
catchment area of this airport
Panel at the bottom.
Maximal number of airports in total.
Definition: airport.h:41
byte noise_level
noise that this airport generates
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:19
Types related to stations.
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition: tilearea_type.h:96
NWidgetBase ** nested_array
Array of pointers into the tree. Do not access directly, use Window::GetWidget() instead.
Definition: window_gui.h:330
Invisible widget that takes some space.
Definition: widget_type.h:77
Offset at bottom of a matrix cell.
Definition: window_gui.h:79
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
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
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
Number of the first newgrf airport.
Definition: airport.h:39
Airport build toolbar window handler.
Definition: airport_gui.cpp:68
Build airport button.
uint current_y
Current vertical size (after resizing).
Definition: widget_type.h:173
East.
const Direction * rotation
the rotation of each tiletable
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
Definition: viewport_type.h:96
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
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:176
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1012
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
maximum number of airport classes
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Current number of the layout.
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
List of hotkeys for a window.
Definition: hotkeys.h:40
Direction
Defines the 8 directions on the map.
Geometry functions.
rectangle (stations, depots, ...)
static DropDownList BuildAirportClassDropDown()
Build a dropdown list of available airport classes.
Simple depressed panel.
Definition: widget_type.h:48
byte num_table
number of elements in the table
Called to determine text to show as airport layout name.
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:309
int pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:175
Offset at left of a matrix cell.
Definition: window_gui.h:76
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Definition: viewport.cpp:3454
GUI stuff related to terraforming.
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
static const AirportSpec * Get(byte type)
Retrieve airport spec for the given airport.
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:63
void SelectFirstAvailableAirport(bool change_class)
Select the first available airport.
Baseclass for nested widgets.
Definition: widget_type.h:124
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:498
Build station; Window numbers:
Definition: window_type.h:390
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
void PlaceProc_DemolishArea(TileIndex tile)
Start a drag for demolishing an area.
Grid of rows and columns.
Definition: widget_type.h:57
Window * ShowBuildAirToolbar()
Open the build airport toolbar window.
static EventState AirportToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildAirToolbarWindow.
Also allow &#39;diagonal rectangles&#39;. Only usable in combination with HT_RECT or HT_POINT.
Functions related to sound.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
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
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:203
Scrollbar of the list.
Dropdown of airport classes.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
Definition: viewport.cpp:3078
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
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:137
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition: window.cpp:984
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:639
Build toolbar; Window numbers:
Definition: window_type.h:66
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:700
uint16 GetCount() const
Gets the number of elements in the list.
Definition: widget_type.h:611
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:587
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:283
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
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Functions related to companies.
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
bool station_noise_level
build new airports when the town noise level is still within accepted limits
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
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
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: airport_gui.cpp:89
StringID name
name of this airport
bool modified_catchment
different-size catchment areas
Show the coverage button.
byte size_x
size of airport in x direction
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
uint current_x
Current horizontal size (after resizing).
Definition: widget_type.h:172
Demolish button.
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
bool confirm
Play sound effect on successful constructions or other actions.
Non-water non-rail construction.
Definition: sound_type.h:68
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:770
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:280
Drop down list.
Definition: widget_type.h:68
Normal push-button (no toggle button) with arrow caption.
Definition: widget_type.h:104
Aircraft vehicle type.
Definition: vehicle_type.h:27
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
bool enabled
Entity still available (by default true). Newgrf can disable it, though.
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:981
#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
Specification of a rectangle with absolute coordinates of all edges.
Vertical scrollbar.
Definition: widget_type.h:82
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.
Defines the data structure for an airport.
Find a place automatically.
Definition: window_gui.h:154
(Toggle) Button with image
Definition: widget_type.h:50
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.
GUI functions that shouldn&#39;t be here.
static void PlaceAirport(TileIndex tile)
Place an airport.
Definition: airport_gui.cpp:55
StringID GetAirportTextCallback(const AirportSpec *as, byte layout, uint16 callback)
Get a custom text for the airport.
void OnDropdownSelect(int widget, int index) override
A dropdown option associated to this window has been selected.
void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
Resize the window.
Definition: window.cpp:2142
A visual display of the airport currently selected.
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1093
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:44
SpriteID preview_sprite
Cached airport preview sprite.
Dimensions (a width and height) of a rectangle in 2D.
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:427
bool click_beep
Beep on a random selection of buttons.
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
Increase the layout number.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:835
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1074
Base class for windows opened from a toolbar.
Definition: window_gui.h:851
int pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:176
static int _selected_airport_index
the index of the selected airport in the current class or -1
Definition: airport_gui.cpp:36
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:621
(Toggle) Button with text
Definition: widget_type.h:53
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:629
Don&#39;t show the coverage button.
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:199