OpenTTD Source 20250528-master-g3aca5d62a8
rail_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 "gui.h"
12#include "station_base.h"
13#include "waypoint_base.h"
14#include "window_gui.h"
15#include "station_gui.h"
16#include "terraform_gui.h"
17#include "viewport_func.h"
18#include "command_func.h"
19#include "waypoint_func.h"
20#include "newgrf_badge.h"
21#include "newgrf_badge_gui.h"
22#include "newgrf_station.h"
23#include "company_base.h"
24#include "strings_func.h"
25#include "window_func.h"
26#include "sound_func.h"
27#include "company_func.h"
28#include "dropdown_type.h"
29#include "dropdown_func.h"
30#include "tunnelbridge.h"
31#include "tilehighlight_func.h"
32#include "spritecache.h"
34#include "hotkeys.h"
35#include "engine_base.h"
36#include "vehicle_func.h"
37#include "zoom_func.h"
38#include "rail_gui.h"
39#include "station_cmd.h"
40#include "tunnelbridge_cmd.h"
41#include "waypoint_cmd.h"
42#include "rail_cmd.h"
43#include "timer/timer.h"
45#include "picker_gui.h"
46
47#include "station_map.h"
48#include "tunnelbridge_map.h"
49
50#include "widgets/rail_widget.h"
51
52#include "table/strings.h"
53
54#include "safeguards.h"
55
56
63
69
76
77
78static void HandleStationPlacement(TileIndex start, TileIndex end);
79static void ShowBuildTrainDepotPicker(Window *parent);
80static void ShowBuildWaypointPicker(Window *parent);
81static Window *ShowStationBuilder(Window *parent);
82static void ShowSignalBuilder(Window *parent);
83
88static bool IsStationAvailable(const StationSpec *statspec)
89{
90 if (statspec == nullptr || !statspec->callback_mask.Test(StationCallbackMask::Avail)) return true;
91
92 uint16_t cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, nullptr, INVALID_TILE);
93 if (cb_res == CALLBACK_FAILED) return true;
94
96}
97
98void CcPlaySound_CONSTRUCTION_RAIL(Commands, const CommandCost &result, TileIndex tile)
99{
100 if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
101}
102
103static void GenericPlaceRail(TileIndex tile, Track track)
104{
106 Command<CMD_REMOVE_SINGLE_RAIL>::Post(STR_ERROR_CAN_T_REMOVE_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
107 tile, track);
108 } else {
109 Command<CMD_BUILD_SINGLE_RAIL>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
111 }
112}
113
129
131static const Track _place_depot_extra_track[12] = {
132 TRACK_LEFT, TRACK_UPPER, TRACK_UPPER, TRACK_RIGHT, // First additional track for directions 0..3
133 TRACK_X, TRACK_Y, TRACK_X, TRACK_Y, // Second additional track
134 TRACK_LOWER, TRACK_LEFT, TRACK_RIGHT, TRACK_LOWER, // Third additional track
135};
136
143
144void CcRailDepot(Commands, const CommandCost &result, TileIndex tile, RailType, DiagDirection dir)
145{
146 if (result.Failed()) return;
147
148 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
150
151 tile += TileOffsByDiagDir(dir);
152
153 if (IsTileType(tile, MP_RAILWAY)) {
155
156 /* Don't place the rail straight out of the depot of there is another depot across from it. */
157 Tile double_depot_tile = tile + TileOffsByDiagDir(dir);
158 bool is_double_depot = IsValidTile(double_depot_tile) && IsRailDepotTile(double_depot_tile);
159 if (!is_double_depot) PlaceExtraDepotRail(tile, _place_depot_extra_dir[dir + 4], _place_depot_extra_track[dir + 4]);
160
162 }
163}
164
170{
173 return;
174 }
175
176 Axis axis = GetAxisForNewRailWaypoint(tile);
177 if (IsValidAxis(axis)) {
178 /* Valid tile for waypoints */
180 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
181 } else {
182 /* Tile where we can't build rail waypoints. This is always going to fail,
183 * but provides the user with a proper error message. */
184 Command<CMD_BUILD_RAIL_WAYPOINT>::Post(STR_ERROR_CAN_T_BUILD_TRAIN_WAYPOINT, tile, AXIS_X, 1, 1, STAT_CLASS_WAYP, 0, StationID::Invalid(), false);
185 }
186}
187
188void CcStation(Commands, const CommandCost &result, TileIndex tile)
189{
190 if (result.Failed()) return;
191
192 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
193 /* Only close the station builder window if the default station and non persistent building is chosen. */
195}
196
202{
205 VpSetPlaceSizingLimit(-1);
208 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
209 } else {
212 if (!_station_gui.axis) std::swap(w, h);
213
216 uint8_t numtracks = _settings_client.gui.station_numtracks;
217 uint8_t platlength = _settings_client.gui.station_platlength;
218 bool adjacent = _ctrl_pressed;
219
220 auto proc = [=](bool test, StationID to_join) -> bool {
221 if (test) {
222 return Command<CMD_BUILD_RAIL_STATION>::Do(CommandFlagsToDCFlags(GetCommandFlags<CMD_BUILD_RAIL_STATION>()), tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, StationID::Invalid(), adjacent).Succeeded();
223 } else {
224 return Command<CMD_BUILD_RAIL_STATION>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_STATION, CcStation, tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, to_join, adjacent);
225 }
226 };
227
228 ShowSelectStationIfNeeded(TileArea(tile, w, h), proc);
229 }
230}
231
238{
240
241 if (trackbits & TRACK_BIT_VERT) { // N-S direction
242 trackbits = (_tile_fract_coords.x <= _tile_fract_coords.y) ? TRACK_BIT_RIGHT : TRACK_BIT_LEFT;
243 }
244
245 if (trackbits & TRACK_BIT_HORZ) { // E-W direction
246 trackbits = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? TRACK_BIT_UPPER : TRACK_BIT_LOWER;
247 }
248
249 Track track = FindFirstTrack(trackbits);
250
252 Command<CMD_REMOVE_SINGLE_SIGNAL>::Post(STR_ERROR_CAN_T_REMOVE_SIGNALS_FROM, CcPlaySound_CONSTRUCTION_RAIL, tile, track);
253 } else {
254 /* Which signals should we cycle through? */
255 bool tile_has_signal = IsPlainRailTile(tile) && IsValidTrack(track) && HasSignalOnTrack(tile, track);
256 SignalType cur_signal_on_tile = tile_has_signal ? GetSignalType(tile, track) : _cur_signal_type;
257 SignalType cycle_start;
258 SignalType cycle_end;
259
260 /* Start with the least restrictive case: the player wants to cycle through all signals they can see. */
263 cycle_end = SIGTYPE_LAST;
264 } else {
265 /* Only cycle through signals of the same group (block or path) as the current signal on the tile. */
266 if (cur_signal_on_tile <= SIGTYPE_LAST_NOPBS) {
267 /* Block signals only. */
268 cycle_start = SIGTYPE_BLOCK;
269 cycle_end = SIGTYPE_LAST_NOPBS;
270 } else {
271 /* Path signals only. */
272 cycle_start = SIGTYPE_PBS;
273 cycle_end = SIGTYPE_LAST;
274 }
275 }
276
277 if (FindWindowById(WC_BUILD_SIGNAL, 0) != nullptr) {
278 /* signal GUI is used */
279 Command<CMD_BUILD_SINGLE_SIGNAL>::Post(_convert_signal_button ? STR_ERROR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
280 tile, track, _cur_signal_type, _cur_signal_variant, _convert_signal_button, false, _ctrl_pressed, cycle_start, cycle_end, 0, 0);
281 } else {
283 Command<CMD_BUILD_SINGLE_SIGNAL>::Post(STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
284 tile, track, _settings_client.gui.default_signal_type, sigvar, false, false, _ctrl_pressed, cycle_start, cycle_end, 0, 0);
285
286 }
287 }
288}
289
295static void PlaceRail_Bridge(TileIndex tile, Window *w)
296{
297 if (IsBridgeTile(tile)) {
298 TileIndex other_tile = GetOtherTunnelBridgeEnd(tile);
299 Point pt = {0, 0};
300 w->OnPlaceMouseUp(VPM_X_OR_Y, DDSP_BUILD_BRIDGE, pt, other_tile, tile);
301 } else {
303 }
304}
305
307void CcBuildRailTunnel(Commands, const CommandCost &result, TileIndex tile)
308{
309 if (result.Succeeded()) {
310 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
312 } else {
314 }
315}
316
329
336{
337 if (w->IsWidgetDisabled(WID_RAT_REMOVE)) return false;
338
339 /* allow ctrl to switch remove mode only for these widgets */
340 for (WidgetID i = WID_RAT_BUILD_NS; i <= WID_RAT_BUILD_STATION; i++) {
341 if ((i <= WID_RAT_AUTORAIL || i >= WID_RAT_BUILD_WAYPOINT) && w->IsWidgetLowered(i)) {
343 return true;
344 }
345 }
346
347 return false;
348}
349
350
357{
358 if (w->IsWidgetDisabled(WID_RAT_REMOVE)) return;
361
362 /* handle station builder */
365 /* starting drag & drop remove */
367 SetTileSelectSize(1, 1);
368 } else {
369 VpSetPlaceSizingLimit(-1);
370 }
371 } else {
372 /* starting station build mode */
376 if (_station_gui.axis == 0) std::swap(x, y);
377 SetTileSelectSize(x, y);
378 } else {
379 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
380 }
381 }
382 }
383}
384
385static void DoRailroadTrack(Track track)
386{
388 Command<CMD_REMOVE_RAILROAD_TRACK>::Post(STR_ERROR_CAN_T_REMOVE_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
389 TileVirtXY(_thd.selend.x, _thd.selend.y), TileVirtXY(_thd.selstart.x, _thd.selstart.y), track);
390 } else {
391 Command<CMD_BUILD_RAILROAD_TRACK>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
393 }
394}
395
396static void HandleAutodirPlacement()
397{
398 Track trackstat = static_cast<Track>( _thd.drawstyle & HT_DIR_MASK); // 0..5
399
400 if (_thd.drawstyle & HT_RAIL) { // one tile case
401 GenericPlaceRail(TileVirtXY(_thd.selend.x, _thd.selend.y), trackstat);
402 return;
403 }
404
405 DoRailroadTrack(trackstat);
406}
407
415{
416 Track track = (Track)GB(_thd.drawstyle, 0, 3); // 0..5
417
418 if ((_thd.drawstyle & HT_DRAG_MASK) == HT_RECT) { // one tile case
420 return;
421 }
422
423 /* _settings_client.gui.drag_signals_density is given as a parameter such that each user
424 * in a network game can specify their own signal density */
426 Command<CMD_REMOVE_SIGNAL_TRACK>::Post(STR_ERROR_CAN_T_REMOVE_SIGNALS_FROM, CcPlaySound_CONSTRUCTION_RAIL,
427 TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y), track, _ctrl_pressed);
428 } else {
429 bool sig_gui = FindWindowById(WC_BUILD_SIGNAL, 0) != nullptr;
432 Command<CMD_BUILD_SIGNAL_TRACK>::Post(STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
434 }
435}
436
437
441 int last_user_action = INVALID_WID_RAT;
442
444 {
445 this->CreateNestedTree();
448 this->OnInvalidateData();
449
451 }
452
453 void Close([[maybe_unused]] int data = 0) override
454 {
459 this->Window::Close();
460 }
461
468
469 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
470 {
471 if (!gui_scope) return;
472
473 if (!ValParamRailType(this->railtype)) {
474 /* Close toolbar if rail type is not available. */
475 this->Close();
476 return;
477 }
478
480 for (const WidgetID widget : can_build_widgets) this->SetWidgetDisabledState(widget, !can_build);
481 if (!can_build) {
487 }
488 }
489
490 bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
491 {
493 if (can_build) return false;
494
495 if (std::ranges::find(can_build_widgets, widget) == std::end(can_build_widgets)) return false;
496
497 GuiShowTooltips(this, GetEncodedString(STR_TOOLBAR_DISABLED_NO_VEHICLE_AVAILABLE), close_cond);
498 return true;
499 }
500
501 void OnInit() override
502 {
503 /* Configure the rail toolbar for the railtype. */
504 const RailTypeInfo *rti = GetRailTypeInfo(this->railtype);
505 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_NS)->SetSprite(rti->gui_sprites.build_ns_rail);
506 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_X)->SetSprite(rti->gui_sprites.build_x_rail);
507 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_EW)->SetSprite(rti->gui_sprites.build_ew_rail);
508 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_Y)->SetSprite(rti->gui_sprites.build_y_rail);
509 this->GetWidget<NWidgetCore>(WID_RAT_AUTORAIL)->SetSprite(rti->gui_sprites.auto_rail);
510 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_DEPOT)->SetSprite(rti->gui_sprites.build_depot);
511 this->GetWidget<NWidgetCore>(WID_RAT_CONVERT_RAIL)->SetSprite(rti->gui_sprites.convert_rail);
512 this->GetWidget<NWidgetCore>(WID_RAT_BUILD_TUNNEL)->SetSprite(rti->gui_sprites.build_tunnel);
513 }
514
520 {
521 this->railtype = railtype;
522 this->ReInit();
523 }
524
525 void UpdateRemoveWidgetStatus(WidgetID clicked_widget)
526 {
527 switch (clicked_widget) {
528 case WID_RAT_REMOVE:
529 /* If it is the removal button that has been clicked, do nothing,
530 * as it is up to the other buttons to drive removal status */
531 return;
532
533 case WID_RAT_BUILD_NS:
534 case WID_RAT_BUILD_X:
535 case WID_RAT_BUILD_EW:
536 case WID_RAT_BUILD_Y:
537 case WID_RAT_AUTORAIL:
541 /* Removal button is enabled only if the rail/signal/waypoint/station
542 * button is still lowered. Once raised, it has to be disabled */
543 this->SetWidgetDisabledState(WID_RAT_REMOVE, !this->IsWidgetLowered(clicked_widget));
544 break;
545
546 default:
547 /* When any other buttons than rail/signal/waypoint/station, raise and
548 * disable the removal button */
551 break;
552 }
553 }
554
555 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
556 {
557 if (widget == WID_RAT_CAPTION) {
558 const RailTypeInfo *rti = GetRailTypeInfo(this->railtype);
559 if (rti->max_speed > 0) {
560 return GetString(STR_TOOLBAR_RAILTYPE_VELOCITY, rti->strings.toolbar_caption, PackVelocity(rti->max_speed, VEH_TRAIN));
561 }
562 return GetString(rti->strings.toolbar_caption);
563 }
564
565 return this->Window::GetWidgetString(widget, stringid);
566 }
567
568 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
569 {
570 if (widget < WID_RAT_BUILD_NS) return;
571
573 switch (widget) {
574 case WID_RAT_BUILD_NS:
576 this->last_user_action = widget;
577 break;
578
579 case WID_RAT_BUILD_X:
581 this->last_user_action = widget;
582 break;
583
584 case WID_RAT_BUILD_EW:
586 this->last_user_action = widget;
587 break;
588
589 case WID_RAT_BUILD_Y:
591 this->last_user_action = widget;
592 break;
593
594 case WID_RAT_AUTORAIL:
596 this->last_user_action = widget;
597 break;
598
599 case WID_RAT_DEMOLISH:
601 this->last_user_action = widget;
602 break;
603
606 ShowBuildTrainDepotPicker(this);
607 this->last_user_action = widget;
608 }
609 break;
610
612 this->last_user_action = widget;
613 if (HandlePlacePushButton(this, WID_RAT_BUILD_WAYPOINT, SPR_CURSOR_WAYPOINT, HT_RECT)) {
614 ShowBuildWaypointPicker(this);
615 }
616 break;
617
619 if (HandlePlacePushButton(this, WID_RAT_BUILD_STATION, SPR_CURSOR_RAIL_STATION, HT_RECT)) {
620 ShowStationBuilder(this);
621 this->last_user_action = widget;
622 }
623 break;
624
626 this->last_user_action = widget;
628 if (started != _ctrl_pressed) {
629 ShowSignalBuilder(this);
630 }
631 break;
632 }
633
635 HandlePlacePushButton(this, WID_RAT_BUILD_BRIDGE, SPR_CURSOR_BRIDGE, HT_RECT);
636 this->last_user_action = widget;
637 break;
638
641 this->last_user_action = widget;
642 break;
643
644 case WID_RAT_REMOVE:
646 break;
647
650 this->last_user_action = widget;
651 break;
652
653 default: NOT_REACHED();
654 }
655 this->UpdateRemoveWidgetStatus(widget);
657 }
658
659 EventState OnHotkey(int hotkey) override
660 {
661 MarkTileDirtyByTile(TileVirtXY(_thd.pos.x, _thd.pos.y)); // redraw tile selection
662 return Window::OnHotkey(hotkey);
663 }
664
665 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
666 {
667 switch (this->last_user_action) {
668 case WID_RAT_BUILD_NS:
670 break;
671
672 case WID_RAT_BUILD_X:
674 break;
675
676 case WID_RAT_BUILD_EW:
678 break;
679
680 case WID_RAT_BUILD_Y:
682 break;
683
684 case WID_RAT_AUTORAIL:
686 break;
687
688 case WID_RAT_DEMOLISH:
690 break;
691
693 Command<CMD_BUILD_TRAIN_DEPOT>::Post(STR_ERROR_CAN_T_BUILD_TRAIN_DEPOT, CcRailDepot, tile, _cur_railtype, _build_depot_direction);
694 break;
695
697 PlaceRail_Waypoint(tile);
698 break;
699
701 PlaceRail_Station(tile);
702 break;
703
706 break;
707
709 PlaceRail_Bridge(tile, this);
710 break;
711
713 Command<CMD_BUILD_TUNNEL>::Post(STR_ERROR_CAN_T_BUILD_TUNNEL_HERE, CcBuildRailTunnel, tile, TRANSPORT_RAIL, _cur_railtype);
714 break;
715
718 break;
719
720 default: NOT_REACHED();
721 }
722 }
723
724 void OnPlaceDrag(ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt) override
725 {
726 /* no dragging if you have pressed the convert button */
728
729 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
730 }
731
732 void OnPlaceMouseUp([[maybe_unused]] ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, TileIndex start_tile, TileIndex end_tile) override
733 {
734 if (pt.x != -1) {
735 switch (select_proc) {
736 default: NOT_REACHED();
739 ShowBuildBridgeWindow(start_tile, end_tile, TRANSPORT_RAIL, _cur_railtype);
740 break;
741
742 case DDSP_PLACE_RAIL:
743 HandleAutodirPlacement();
744 break;
745
748 break;
749
751 GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
752 break;
753
755 Command<CMD_CONVERT_RAIL>::Post(STR_ERROR_CAN_T_CONVERT_RAIL, CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, _cur_railtype, _ctrl_pressed);
756 break;
757
761 /* Station */
763 bool keep_rail = !_ctrl_pressed;
764 Command<CMD_REMOVE_FROM_RAIL_STATION>::Post(STR_ERROR_CAN_T_REMOVE_PART_OF_STATION, CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, keep_rail);
765 } else {
766 HandleStationPlacement(start_tile, end_tile);
767 }
768 } else {
769 /* Waypoint */
771 bool keep_rail = !_ctrl_pressed;
772 Command<CMD_REMOVE_FROM_RAIL_WAYPOINT>::Post(STR_ERROR_CAN_T_REMOVE_TRAIN_WAYPOINT, CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, keep_rail);
773 } else {
774 TileArea ta(start_tile, end_tile);
775 Axis axis = select_method == VPM_X_LIMITED ? AXIS_X : AXIS_Y;
776 bool adjacent = _ctrl_pressed;
777
778 auto proc = [=](bool test, StationID to_join) -> bool {
779 if (test) {
780 return Command<CMD_BUILD_RAIL_WAYPOINT>::Do(CommandFlagsToDCFlags(GetCommandFlags<CMD_BUILD_RAIL_WAYPOINT>()), ta.tile, axis, ta.w, ta.h, _waypoint_gui.sel_class, _waypoint_gui.sel_type, StationID::Invalid(), adjacent).Succeeded();
781 } else {
782 return Command<CMD_BUILD_RAIL_WAYPOINT>::Post(STR_ERROR_CAN_T_BUILD_TRAIN_WAYPOINT, CcPlaySound_CONSTRUCTION_RAIL, ta.tile, axis, ta.w, ta.h, _waypoint_gui.sel_class, _waypoint_gui.sel_type, to_join, adjacent);
783 }
784 };
785
787 }
788 }
789 break;
790 }
791 }
792 }
793
810
816
818 {
819 /* do not toggle Remove button by Ctrl when placing station */
821 return ES_NOT_HANDLED;
822 }
823
824 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
825 {
826 if (this->IsWidgetLowered(WID_RAT_BUILD_WAYPOINT)) CheckRedrawRailWaypointCoverage(this);
827 }
828
835 {
836 if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
837 extern RailType _last_built_railtype;
838 Window *w = ShowBuildRailToolbar(_last_built_railtype);
839 if (w == nullptr) return ES_NOT_HANDLED;
840 return w->OnHotkey(hotkey);
841 }
842
843 static inline HotkeyList hotkeys{"railtoolbar", {
844 Hotkey('1', "build_ns", WID_RAT_BUILD_NS),
845 Hotkey('2', "build_x", WID_RAT_BUILD_X),
846 Hotkey('3', "build_ew", WID_RAT_BUILD_EW),
847 Hotkey('4', "build_y", WID_RAT_BUILD_Y),
848 Hotkey({'5', 'A' | WKC_GLOBAL_HOTKEY}, "autorail", WID_RAT_AUTORAIL),
849 Hotkey('6', "demolish", WID_RAT_DEMOLISH),
850 Hotkey('7', "depot", WID_RAT_BUILD_DEPOT),
851 Hotkey('8', "waypoint", WID_RAT_BUILD_WAYPOINT),
852 Hotkey('9', "station", WID_RAT_BUILD_STATION),
853 Hotkey('S', "signal", WID_RAT_BUILD_SIGNALS),
854 Hotkey('B', "bridge", WID_RAT_BUILD_BRIDGE),
855 Hotkey('T', "tunnel", WID_RAT_BUILD_TUNNEL),
856 Hotkey('R', "remove", WID_RAT_REMOVE),
857 Hotkey('C', "convert", WID_RAT_CONVERT_RAIL),
859};
860
861static constexpr NWidgetPart _nested_build_rail_widgets[] = {
863 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
864 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_RAT_CAPTION), SetTextStyle(TC_WHITE),
865 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
866 EndContainer(),
868 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_NS),
869 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_RAIL_NS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
870 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_X),
871 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_RAIL_NE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
872 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_EW),
873 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_RAIL_EW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
874 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_Y),
875 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_RAIL_NW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
876 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_AUTORAIL),
877 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_AUTORAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_AUTORAIL),
878
879 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(4, 22), EndContainer(),
880
881 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_DEMOLISH),
882 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
883 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_DEPOT),
884 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_DEPOT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_TRAIN_DEPOT_FOR_BUILDING),
885 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_WAYPOINT),
886 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_WAYPOINT, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL_TO_WAYPOINT),
887 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_STATION),
888 SetFill(0, 1), SetMinimalSize(42, 22), SetSpriteTip(SPR_IMG_RAIL_STATION, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_STATION),
889 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_SIGNALS),
890 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_RAIL_SIGNALS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS),
891 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_BRIDGE),
892 SetFill(0, 1), SetMinimalSize(42, 22), SetSpriteTip(SPR_IMG_BRIDGE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_BRIDGE),
893 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_TUNNEL),
894 SetFill(0, 1), SetMinimalSize(20, 22), SetSpriteTip(SPR_IMG_TUNNEL_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TUNNEL),
895 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_REMOVE),
896 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_REMOVE, STR_RAIL_TOOLBAR_TOOLTIP_TOGGLE_BUILD_REMOVE_FOR),
897 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_CONVERT_RAIL),
898 SetFill(0, 1), SetMinimalSize(22, 22), SetSpriteTip(SPR_IMG_CONVERT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL),
899 EndContainer(),
900};
901
902static WindowDesc _build_rail_desc(
903 WDP_ALIGN_TOOLBAR, "toolbar_rail", 0, 0,
906 _nested_build_rail_widgets,
907 &BuildRailToolbarWindow::hotkeys
908);
909
910
920{
921 if (!Company::IsValidID(_local_company)) return nullptr;
922 if (!ValParamRailType(railtype)) return nullptr;
923
925 _cur_railtype = railtype;
927 return new BuildRailToolbarWindow(_build_rail_desc, railtype);
928}
929
930/* TODO: For custom stations, respect their allowed platforms/lengths bitmasks!
931 * --pasky */
932
933static void HandleStationPlacement(TileIndex start, TileIndex end)
934{
935 TileArea ta(start, end);
936 uint numtracks = ta.w;
937 uint platlength = ta.h;
938
939 if (_station_gui.axis == AXIS_X) std::swap(numtracks, platlength);
940
943 bool adjacent = _ctrl_pressed;
944
945 auto proc = [=](bool test, StationID to_join) -> bool {
946 if (test) {
947 return Command<CMD_BUILD_RAIL_STATION>::Do(CommandFlagsToDCFlags(GetCommandFlags<CMD_BUILD_RAIL_STATION>()), ta.tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, StationID::Invalid(), adjacent).Succeeded();
948 } else {
949 return Command<CMD_BUILD_RAIL_STATION>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_STATION, CcStation, ta.tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, to_join, adjacent);
950 }
951 };
952
954}
955
961static bool StationUsesDefaultType(const BaseStation *bst)
962{
963 for (TileIndex t : bst->train_station) {
964 if (bst->TileBelongsToRailStation(t) && HasStationRail(t) && GetCustomStationSpecIndex(t) == 0) return true;
965 }
966 return false;
967}
968
970public:
972
973 GrfSpecFeature GetFeature() const override { return GSF_STATIONS; }
974
975 StringID GetClassTooltip() const override { return STR_PICKER_STATION_CLASS_TOOLTIP; }
976 StringID GetTypeTooltip() const override { return STR_PICKER_STATION_TYPE_TOOLTIP; }
977
978 bool IsActive() const override
979 {
980 for (const auto &cls : StationClass::Classes()) {
981 if (IsWaypointClass(cls)) continue;
982 for (const auto *spec : cls.Specs()) {
983 if (spec != nullptr) return true;
984 }
985 }
986 return false;
987 }
988
989 bool HasClassChoice() const override
990 {
991 return std::ranges::count_if(StationClass::Classes(), std::not_fn(IsWaypointClass)) > 1;
992 }
993
994 int GetSelectedClass() const override { return _station_gui.sel_class; }
995 void SetSelectedClass(int id) const override { _station_gui.sel_class = this->GetClassIndex(id); }
996
997 StringID GetClassName(int id) const override
998 {
999 const auto *sc = GetClass(id);
1000 if (IsWaypointClass(*sc)) return INVALID_STRING_ID;
1001 return sc->name;
1002 }
1003
1004 int GetSelectedType() const override { return _station_gui.sel_type; }
1005 void SetSelectedType(int id) const override { _station_gui.sel_type = id; }
1006
1007 StringID GetTypeName(int cls_id, int id) const override
1008 {
1009 const auto *spec = this->GetSpec(cls_id, id);
1010 return (spec == nullptr) ? STR_STATION_CLASS_DFLT_STATION : spec->name;
1011 }
1012
1013 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1014 {
1015 const auto *spec = this->GetSpec(cls_id, id);
1016 if (spec == nullptr) return {};
1017 return spec->badges;
1018 }
1019
1020 bool IsTypeAvailable(int cls_id, int id) const override
1021 {
1022 return IsStationAvailable(this->GetSpec(cls_id, id));
1023 }
1024
1025 void DrawType(int x, int y, int cls_id, int id) const override
1026 {
1027 if (!DrawStationTile(x, y, _cur_railtype, _station_gui.axis, this->GetClassIndex(cls_id), id)) {
1028 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2 + _station_gui.axis);
1029 }
1030 }
1031
1032 void FillUsedItems(std::set<PickerItem> &items) override
1033 {
1034 bool default_added = false;
1035 for (const Station *st : Station::Iterate()) {
1036 if (st->owner != _local_company) continue;
1037 if (!default_added && StationUsesDefaultType(st)) {
1038 items.insert({0, 0, STAT_CLASS_DFLT, 0});
1039 default_added = true;
1040 }
1041 for (const auto &sm : st->speclist) {
1042 if (sm.spec == nullptr) continue;
1043 items.insert({sm.grfid, sm.localidx, sm.spec->class_index, sm.spec->index});
1044 }
1045 }
1046 }
1047
1048 static StationPickerCallbacks instance;
1049};
1050/* static */ StationPickerCallbacks StationPickerCallbacks::instance;
1051
1053private:
1055
1061 void CheckSelectedSize(const StationSpec *statspec)
1062 {
1063 if (statspec == nullptr || _settings_client.gui.station_dragdrop) return;
1064
1065 /* If current number of tracks is not allowed, make it as big as possible */
1069 if (statspec->disallowed_platforms != UINT8_MAX) {
1072 }
1074 }
1075 }
1076
1080 if (statspec->disallowed_lengths != UINT8_MAX) {
1083 }
1085 }
1086 }
1087 }
1088
1089public:
1091 {
1093 this->ConstructWindow();
1094 }
1095
1110
1111 void Close([[maybe_unused]] int data = 0) override
1112 {
1114 this->PickerWindow::Close();
1115 }
1116
1117 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1118 {
1119 if (gui_scope) {
1121 this->CheckSelectedSize(statspec);
1122 }
1123
1124 this->PickerWindow::OnInvalidateData(data, gui_scope);
1125 }
1126
1127 void OnPaint() override
1128 {
1130
1132 SetTileSelectSize(1, 1);
1133 } else {
1136 if (_station_gui.axis == AXIS_X) std::swap(x, y);
1138 SetTileSelectSize(x, y);
1139 }
1140 }
1141
1143
1144 if (_settings_client.gui.station_show_coverage) SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
1145
1146 for (uint bits = 0; bits < 7; bits++) {
1147 bool disable = bits >= _settings_game.station.station_spread;
1148 if (statspec == nullptr) {
1149 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, disable);
1150 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, disable);
1151 } else {
1152 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, HasBit(statspec->disallowed_platforms, bits) || disable);
1153 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, HasBit(statspec->disallowed_lengths, bits) || disable);
1154 }
1155 }
1156
1157 this->DrawWidgets();
1158
1159 if (this->IsShaded()) return;
1160 /* 'Accepts' and 'Supplies' texts. */
1161 Rect r = this->GetWidget<NWidgetBase>(WID_BRAS_COVERAGE_TEXTS)->GetCurrentRect();
1162 const int bottom = r.bottom;
1163 r.bottom = INT_MAX; // Allow overflow as we want to know the required height.
1164 if (statspec != nullptr) r.top = DrawBadgeNameList(r, statspec->badges, GSF_STATIONS);
1166 r.top = DrawStationCoverageAreaText(r, SCT_ALL, rad, true);
1167 /* Resize background if the window is too small.
1168 * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
1169 * (This is the case, if making the window bigger moves the mouse into the window.) */
1170 if (r.top > bottom) {
1171 this->coverage_height += r.top - bottom;
1172 this->ReInit();
1173 }
1174 }
1175
1176 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1177 {
1178 switch (widget) {
1183 break;
1184
1186 size.height = this->coverage_height;
1187 break;
1188
1189 default:
1190 this->PickerWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
1191 break;
1192 }
1193 }
1194
1195 void DrawWidget(const Rect &r, WidgetID widget) const override
1196 {
1197 DrawPixelInfo tmp_dpi;
1198
1199 switch (widget) {
1201 /* Set up a clipping area for the '/' station preview */
1202 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1203 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1204 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1208 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2);
1209 }
1210 }
1211 break;
1212 }
1213
1215 /* Set up a clipping area for the '\' station preview */
1216 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1217 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1218 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1222 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 3);
1223 }
1224 }
1225 break;
1226 }
1227
1228 default:
1229 this->PickerWindow::DrawWidget(r, widget);
1230 break;
1231 }
1232 }
1233
1234 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1235 {
1236 switch (widget) {
1239 this->RaiseWidget(WID_BRAS_PLATFORM_DIR_X + _station_gui.axis);
1241 this->LowerWidget(WID_BRAS_PLATFORM_DIR_X + _station_gui.axis);
1243 this->SetDirty();
1245 break;
1246
1256
1259
1261 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1262 /* The previously selected number of platforms in invalid */
1263 for (uint i = 0; i < 7; i++) {
1264 if (!HasBit(statspec->disallowed_lengths, i)) {
1267 break;
1268 }
1269 }
1270 }
1271
1272 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1275 this->SetDirty();
1277 break;
1278 }
1279
1289
1292
1294 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1295 /* The previously selected number of tracks in invalid */
1296 for (uint i = 0; i < 7; i++) {
1297 if (!HasBit(statspec->disallowed_platforms, i)) {
1300 break;
1301 }
1302 }
1303 }
1304
1306 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1308 this->SetDirty();
1310 break;
1311 }
1312
1315
1317
1318 /* get the first allowed length/number of platforms */
1320 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1321 for (uint i = 0; i < 7; i++) {
1322 if (!HasBit(statspec->disallowed_lengths, i)) {
1325 break;
1326 }
1327 }
1328 }
1329 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1330 for (uint i = 0; i < 7; i++) {
1331 if (!HasBit(statspec->disallowed_platforms, i)) {
1334 break;
1335 }
1336 }
1337 }
1338
1342 this->SetDirty();
1344 break;
1345 }
1346
1350
1354 this->SetDirty();
1355 SetViewportCatchmentStation(nullptr, true);
1356 break;
1357
1358 default:
1359 this->PickerWindow::OnClick(pt, widget, click_count);
1360 break;
1361 }
1362 }
1363
1364 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
1365 {
1367 }
1368
1375 {
1376 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
1378 if (w == nullptr) return ES_NOT_HANDLED;
1379 return w->OnHotkey(hotkey);
1380 }
1381
1382 static inline HotkeyList hotkeys{"buildrailstation", {
1383 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1385};
1386
1387static constexpr NWidgetPart _nested_station_builder_widgets[] = {
1389 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1390 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_STATION_BUILD_RAIL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1391 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
1392 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
1393 EndContainer(),
1397 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
1399 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_ORIENTATION),
1401 NWidget(WWT_PANEL, COLOUR_GREY, WID_BRAS_PLATFORM_DIR_X), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1402 NWidget(WWT_PANEL, COLOUR_GREY, WID_BRAS_PLATFORM_DIR_Y), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1403 EndContainer(),
1404 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_NUMBER_OF_TRACKS),
1406 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1407 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1408 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1409 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1410 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1411 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1412 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1413 EndContainer(),
1414 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_PLATFORM_LENGTH),
1416 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1417 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1418 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1419 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1420 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1421 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1422 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1423 EndContainer(),
1425 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_DRAG_N_DROP), SetMinimalSize(75, 12), SetStringTip(STR_STATION_BUILD_DRAG_DROP, STR_STATION_BUILD_DRAG_DROP_TOOLTIP),
1426 EndContainer(),
1427 NWidget(WWT_LABEL, INVALID_COLOUR), SetStringTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE), SetFill(1, 0),
1429 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_HIGHLIGHT_OFF), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
1430 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_HIGHLIGHT_ON), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
1431 EndContainer(),
1432 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_BRAS_COVERAGE_TEXTS), SetFill(1, 1), SetResize(1, 0), SetMinimalTextLines(2, 0),
1433 EndContainer(),
1434 EndContainer(),
1435 EndContainer(),
1437 EndContainer(),
1438};
1439
1442 WDP_AUTO, "build_station_rail", 0, 0,
1445 _nested_station_builder_widgets,
1446 &BuildRailStationWindow::hotkeys
1447);
1448
1451{
1453}
1454
1456private:
1459
1464 void DrawSignalSprite(const Rect &r, SpriteID image) const
1465 {
1466 Point offset;
1467 Dimension sprite_size = GetSpriteSize(image, &offset);
1468 Rect ir = r.Shrink(WidgetDimensions::scaled.imgbtn);
1469 int x = CentreBounds(ir.left, ir.right, sprite_size.width - offset.x) - offset.x; // centered
1470 int y = ir.top - sig_sprite_bottom_offset +
1471 (ir.Height() + sig_sprite_size.height) / 2; // aligned to bottom
1472
1473 DrawSprite(image, PAL_NONE, x, y);
1474 }
1475
1478 {
1479 bool show_non_path_signals = (_settings_client.gui.signal_gui_mode == SIGNAL_GUI_ALL);
1480
1481 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1482 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SPACER_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1483 }
1484
1485public:
1487 {
1488 this->CreateNestedTree();
1489 this->SetSignalUIMode();
1491 this->OnInvalidateData();
1492 }
1493
1494 void Close([[maybe_unused]] int data = 0) override
1495 {
1496 _convert_signal_button = false;
1498 }
1499
1500 void OnInit() override
1501 {
1502 /* Calculate maximum signal sprite size. */
1503 this->sig_sprite_size.width = 0;
1504 this->sig_sprite_size.height = 0;
1505 this->sig_sprite_bottom_offset = 0;
1507 for (uint type = SIGTYPE_BLOCK; type < SIGTYPE_END; type++) {
1508 for (uint variant = SIG_ELECTRIC; variant <= SIG_SEMAPHORE; variant++) {
1509 for (uint lowered = 0; lowered < 2; lowered++) {
1510 Point offset;
1511 Dimension sprite_size = GetSpriteSize(rti->gui_sprites.signals[type][variant][lowered], &offset);
1512 this->sig_sprite_bottom_offset = std::max<int>(this->sig_sprite_bottom_offset, sprite_size.height);
1513 this->sig_sprite_size.width = std::max<int>(this->sig_sprite_size.width, sprite_size.width - offset.x);
1514 this->sig_sprite_size.height = std::max<int>(this->sig_sprite_size.height, sprite_size.height - offset.y);
1515 }
1516 }
1517 }
1518 }
1519
1520 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1521 {
1522 if (widget == WID_BS_DRAG_SIGNALS_DENSITY_LABEL) {
1523 /* Two digits for signals density. */
1524 size.width = std::max(size.width, 2 * GetDigitWidth() + padding.width + WidgetDimensions::scaled.framerect.Horizontal());
1526 size.width = std::max(size.width, this->sig_sprite_size.width + padding.width);
1527 size.height = std::max(size.height, this->sig_sprite_size.height + padding.height);
1528 }
1529 }
1530
1531 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1532 {
1533 switch (widget) {
1535 return GetString(STR_JUST_INT, _settings_client.gui.drag_signals_density);
1536
1537 default:
1538 return this->Window::GetWidgetString(widget, stringid);
1539 }
1540 }
1541
1542 void DrawWidget(const Rect &r, WidgetID widget) const override
1543 {
1545 /* Extract signal from widget number. */
1546 int type = (widget - WID_BS_SEMAPHORE_NORM) % SIGTYPE_END;
1547 int var = SIG_SEMAPHORE - (widget - WID_BS_SEMAPHORE_NORM) / SIGTYPE_END; // SignalVariant order is reversed compared to the widgets.
1548 SpriteID sprite = GetRailTypeInfo(_cur_railtype)->gui_sprites.signals[type][var][this->IsWidgetLowered(widget)];
1549
1550 this->DrawSignalSprite(r, sprite);
1551 }
1552 }
1553
1554 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1555 {
1556 switch (widget) {
1570
1571 _cur_signal_type = (SignalType)((uint)((widget - WID_BS_SEMAPHORE_NORM) % (SIGTYPE_LAST + 1)));
1573
1574 /* Update default (last-used) signal type in config file. */
1576
1577 /* If 'remove' button of rail build toolbar is active, disable it. */
1580 if (w != nullptr) ToggleRailButton_Remove(w);
1581 }
1582
1583 break;
1584
1585 case WID_BS_CONVERT:
1587 break;
1588
1593 }
1594 break;
1595
1600 }
1601 break;
1602
1603 case WID_BS_TOGGLE_SIZE:
1605 this->SetSignalUIMode();
1606 this->ReInit();
1607 break;
1608
1609 default: break;
1610 }
1611
1612 this->InvalidateData();
1613 }
1614
1630};
1631
1634 /* Title bar and buttons. */
1636 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1637 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_BS_CAPTION), SetStringTip(STR_BUILD_SIGNAL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1638 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_BS_TOGGLE_SIZE), SetSpriteTip(SPR_LARGE_SMALL_WINDOW, STR_BUILD_SIGNAL_TOGGLE_ADVANCED_SIGNAL_TOOLTIP), SetAspect(WidgetDimensions::ASPECT_TOGGLE_SIZE),
1639 EndContainer(),
1640
1641 /* Container for both signal groups, spacers, and convert/autofill buttons. */
1643 /* Block signals (can be hidden). */
1644 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_BS_BLOCK_SEL),
1646 /* Semaphore block signals. */
1648 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_NORM), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_NORM_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1649 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_ENTRY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_ENTRY_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1650 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_EXIT), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_EXIT_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1651 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_COMBO), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_COMBO_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1652 EndContainer(),
1653 /* Electric block signals. */
1655 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_NORM), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_NORM_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1656 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_ENTRY), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_ENTRY_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1657 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_EXIT), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_EXIT_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1658 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_COMBO), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_COMBO_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1659 EndContainer(),
1660 EndContainer(),
1661 EndContainer(),
1662
1663 /* Divider (only shown if block signals visible). */
1665 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(0, 0), SetMinimalSize(4, 0), EndContainer(),
1666 EndContainer(),
1667
1668 /* Path signals. */
1670 /* Semaphore path signals. */
1672 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_PBS), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_PBS_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1673 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_PBS_OWAY_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1674 EndContainer(),
1675 /* Electric path signals. */
1677 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_PBS), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_PBS_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1678 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_PBS_OWAY_TOOLTIP), SetMinimalSize(22, 22), EndContainer(),
1679 EndContainer(),
1680 EndContainer(),
1681
1682 /* Convert/autofill buttons. */
1684 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_BS_CONVERT), SetSpriteTip(SPR_IMG_SIGNAL_CONVERT, STR_BUILD_SIGNAL_CONVERT_TOOLTIP), SetFill(0, 1),
1685 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetToolTip(STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_TOOLTIP), SetFill(0, 1),
1687 NWidget(WWT_LABEL, INVALID_COLOUR, WID_BS_DRAG_SIGNALS_DENSITY_LABEL), SetToolTip(STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_TOOLTIP), SetTextStyle(TC_ORANGE), SetFill(1, 1),
1689 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_BS_DRAG_SIGNALS_DENSITY_DECREASE), SetMinimalSize(9, 12), SetArrowWidgetTypeTip(AWV_DECREASE, STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_DECREASE_TOOLTIP),
1690 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_BS_DRAG_SIGNALS_DENSITY_INCREASE), SetMinimalSize(9, 12), SetArrowWidgetTypeTip(AWV_INCREASE, STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_INCREASE_TOOLTIP),
1691 EndContainer(),
1692 EndContainer(),
1693 EndContainer(),
1694 EndContainer(),
1695 EndContainer(),
1696};
1697
1700 WDP_AUTO, {}, 0, 0,
1704);
1705
1709static void ShowSignalBuilder(Window *parent)
1710{
1712}
1713
1716 {
1719 }
1720
1721 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1722 {
1723 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1724
1727 }
1728
1729 void DrawWidget(const Rect &r, WidgetID widget) const override
1730 {
1731 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1732
1733 DrawPixelInfo tmp_dpi;
1734 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1735 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1736 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1737 int x = (ir.Width() - ScaleSpriteTrad(64)) / 2 + ScaleSpriteTrad(31);
1738 int y = (ir.Height() + ScaleSpriteTrad(48)) / 2 - ScaleSpriteTrad(31);
1739 DrawTrainDepotSprite(x, y, widget - WID_BRAD_DEPOT_NE + DIAGDIR_NE, _cur_railtype);
1740 }
1741 }
1742
1743 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1744 {
1745 switch (widget) {
1746 case WID_BRAD_DEPOT_NE:
1747 case WID_BRAD_DEPOT_SE:
1748 case WID_BRAD_DEPOT_SW:
1749 case WID_BRAD_DEPOT_NW:
1754 this->SetDirty();
1755 break;
1756 }
1757 }
1758};
1759
1763 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1764 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1765 EndContainer(),
1766 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
1769 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1770 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1771 EndContainer(),
1773 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1774 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1775 EndContainer(),
1776 EndContainer(),
1777 EndContainer(),
1778};
1779
1780static WindowDesc _build_depot_desc(
1781 WDP_AUTO, {}, 0, 0,
1785);
1786
1787static void ShowBuildTrainDepotPicker(Window *parent)
1788{
1789 new BuildRailDepotWindow(_build_depot_desc, parent);
1790}
1791
1793public:
1795
1796 GrfSpecFeature GetFeature() const override { return GSF_STATIONS; }
1797
1798 StringID GetClassTooltip() const override { return STR_PICKER_WAYPOINT_CLASS_TOOLTIP; }
1799 StringID GetTypeTooltip() const override { return STR_PICKER_WAYPOINT_TYPE_TOOLTIP; }
1800
1801 bool IsActive() const override
1802 {
1803 for (const auto &cls : StationClass::Classes()) {
1804 if (!IsWaypointClass(cls)) continue;
1805 for (const auto *spec : cls.Specs()) {
1806 if (spec != nullptr) return true;
1807 }
1808 }
1809 return false;
1810 }
1811
1812 bool HasClassChoice() const override
1813 {
1814 return std::ranges::count_if(StationClass::Classes(), IsWaypointClass) > 1;
1815 }
1816
1817 void Close(int) override { ResetObjectToPlace(); }
1818 int GetSelectedClass() const override { return _waypoint_gui.sel_class; }
1819 void SetSelectedClass(int id) const override { _waypoint_gui.sel_class = this->GetClassIndex(id); }
1820
1821 StringID GetClassName(int id) const override
1822 {
1823 const auto *sc = GetClass(id);
1824 if (!IsWaypointClass(*sc)) return INVALID_STRING_ID;
1825 return sc->name;
1826 }
1827
1828 int GetSelectedType() const override { return _waypoint_gui.sel_type; }
1829 void SetSelectedType(int id) const override { _waypoint_gui.sel_type = id; }
1830
1831 StringID GetTypeName(int cls_id, int id) const override
1832 {
1833 const auto *spec = this->GetSpec(cls_id, id);
1834 return (spec == nullptr) ? STR_STATION_CLASS_WAYP_WAYPOINT : spec->name;
1835 }
1836
1837 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1838 {
1839 const auto *spec = this->GetSpec(cls_id, id);
1840 if (spec == nullptr) return {};
1841 return spec->badges;
1842 }
1843
1844 bool IsTypeAvailable(int cls_id, int id) const override
1845 {
1846 return IsStationAvailable(this->GetSpec(cls_id, id));
1847 }
1848
1849 void DrawType(int x, int y, int cls_id, int id) const override
1850 {
1851 DrawWaypointSprite(x, y, this->GetClassIndex(cls_id), id, _cur_railtype);
1852 }
1853
1854 void FillUsedItems(std::set<PickerItem> &items) override
1855 {
1856 bool default_added = false;
1857 for (const Waypoint *wp : Waypoint::Iterate()) {
1858 if (wp->owner != _local_company || HasBit(wp->waypoint_flags, WPF_ROAD)) continue;
1859 if (!default_added && StationUsesDefaultType(wp)) {
1860 items.insert({0, 0, STAT_CLASS_WAYP, 0});
1861 default_added = true;
1862 }
1863 for (const auto &sm : wp->speclist) {
1864 if (sm.spec == nullptr) continue;
1865 items.insert({sm.grfid, sm.localidx, sm.spec->class_index, sm.spec->index});
1866 }
1867 }
1868 }
1869
1870 static WaypointPickerCallbacks instance;
1871};
1872/* static */ WaypointPickerCallbacks WaypointPickerCallbacks::instance;
1873
1875 BuildRailWaypointWindow(WindowDesc &desc, Window *parent) : PickerWindow(desc, parent, TRANSPORT_RAIL, WaypointPickerCallbacks::instance)
1876 {
1877 this->ConstructWindow();
1878 }
1879
1880 static inline HotkeyList hotkeys{"buildrailwaypoint", {
1881 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1882 }};
1883};
1884
1888 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1889 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_WAYPOINT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1890 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
1891 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
1892 EndContainer(),
1896 EndContainer(),
1897};
1898
1899static WindowDesc _build_waypoint_desc(
1900 WDP_AUTO, "build_waypoint", 0, 0,
1904 &BuildRailWaypointWindow::hotkeys
1905);
1906
1907static void ShowBuildWaypointPicker(Window *parent)
1908{
1909 if (!WaypointPickerCallbacks::instance.IsActive()) return;
1910 new BuildRailWaypointWindow(_build_waypoint_desc, parent);
1911}
1912
1924
1930{
1931 extern RailType _last_built_railtype;
1932 if (disable && _last_built_railtype == RAILTYPE_ELECTRIC) {
1933 _last_built_railtype = _cur_railtype = RAILTYPE_RAIL;
1935 if (w != nullptr) w->ModifyRailType(_cur_railtype);
1936 }
1938}
1939
1942{
1944
1945 extern RailType _last_built_railtype;
1946 RailType rt;
1948 case 2: {
1949 /* Find the most used rail type */
1950 std::array<uint, RAILTYPE_END> count{};
1951 for (const auto t : Map::Iterate()) {
1954 count[GetRailType(t)]++;
1955 }
1956 }
1957
1958 rt = static_cast<RailType>(std::distance(std::begin(count), std::ranges::max_element(count)));
1959 if (count[rt] > 0) break;
1960
1961 /* No rail, just get the first available one */
1962 [[fallthrough]];
1963 }
1964 case 0: {
1965 /* Use first available type */
1966 std::vector<RailType>::const_iterator it = std::find_if(_sorted_railtypes.begin(), _sorted_railtypes.end(),
1967 [](RailType r) { return HasRailTypeAvail(_local_company, r); });
1968 rt = it != _sorted_railtypes.end() ? *it : RAILTYPE_BEGIN;
1969 break;
1970 }
1971 case 1: {
1972 /* Use last available type */
1973 std::vector<RailType>::const_reverse_iterator it = std::find_if(_sorted_railtypes.rbegin(), _sorted_railtypes.rend(),
1974 [](RailType r){ return HasRailTypeAvail(_local_company, r); });
1975 rt = it != _sorted_railtypes.rend() ? *it : RAILTYPE_BEGIN;
1976 break;
1977 }
1978 default:
1979 NOT_REACHED();
1980 }
1981
1982 _last_built_railtype = _cur_railtype = rt;
1984 if (w != nullptr) w->ModifyRailType(_cur_railtype);
1985}
1986
1992{
1994
1995 if (new_variant != _cur_signal_variant) {
1997 if (w != nullptr) {
1998 w->SetDirty();
2000 }
2001 _cur_signal_variant = new_variant;
2002 }
2003}
2004
2005static const IntervalTimer<TimerGameCalendar> _check_reset_signal({TimerGameCalendar::YEAR, TimerGameCalendar::Priority::NONE}, [](auto)
2006{
2008
2010});
2011
2024
2031DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
2032{
2033 RailTypes used_railtypes;
2034 RailTypes avail_railtypes;
2035
2037
2038 /* Find the used railtypes. */
2039 if (for_replacement) {
2040 avail_railtypes = GetCompanyRailTypes(c->index, false);
2041 used_railtypes = GetRailTypes(false);
2042 } else {
2043 avail_railtypes = c->avail_railtypes;
2044 used_railtypes = GetRailTypes(true);
2045 }
2046
2047 DropDownList list;
2048
2049 if (all_option) {
2050 list.push_back(MakeDropDownListStringItem(STR_REPLACE_ALL_RAILTYPE, INVALID_RAILTYPE));
2051 }
2052
2053 Dimension d = { 0, 0 };
2054 /* Get largest icon size, to ensure text is aligned on each menu item. */
2055 if (!for_replacement) {
2056 used_railtypes.Reset(_railtypes_hidden_mask);
2057 for (const auto &rt : _sorted_railtypes) {
2058 if (!used_railtypes.Test(rt)) continue;
2059 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2061 }
2062 }
2063
2064 /* Shared list so that each item can take ownership. */
2065 auto badge_class_list = std::make_shared<GUIBadgeClasses>(GSF_RAILTYPES);
2066
2067 for (const auto &rt : _sorted_railtypes) {
2068 /* If it's not used ever, don't show it to the user. */
2069 if (!used_railtypes.Test(rt)) continue;
2070
2071 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2072
2073 if (for_replacement) {
2074 list.push_back(MakeDropDownListBadgeItem(badge_class_list, rti->badges, GSF_RAILTYPES, rti->introduction_date, GetString(rti->strings.replace_text), rt, !avail_railtypes.Test(rt)));
2075 } else {
2076 std::string str = rti->max_speed > 0
2077 ? GetString(STR_TOOLBAR_RAILTYPE_VELOCITY, rti->strings.menu_text, rti->max_speed)
2078 : GetString(rti->strings.menu_text);
2079 list.push_back(MakeDropDownListBadgeIconItem(badge_class_list, rti->badges, GSF_RAILTYPES, rti->introduction_date, d, rti->gui_sprites.build_x_rail, PAL_NONE, std::move(str), rt, !avail_railtypes.Test(rt)));
2080 }
2081 }
2082
2083 if (list.empty()) {
2084 /* Empty dropdowns are not allowed */
2085 list.push_back(MakeDropDownListStringItem(STR_NONE, INVALID_RAILTYPE, true));
2086 }
2087
2088 return list;
2089}
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
void ShowBuildBridgeWindow(TileIndex start, TileIndex end, TransportType transport_type, uint8_t road_rail_type)
Prepare the data for the build a bridge window.
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition bridge_map.h:35
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
bool Failed() const
Did this command fail?
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
static std::span< NewGRFClass< Tspec, Tindex, Tmax > const > Classes()
Get read-only span of all classes of this type.
static NewGRFClass * Get(Tindex class_index)
Get a particular class.
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
Helper for PickerCallbacks when the class system is based on NewGRFClass.
Definition picker_gui.h:105
Base class for windows opened from a toolbar.
Definition window_gui.h:991
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:3570
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
static const int PREVIEW_LEFT
Offset from left edge to draw preview.
Definition picker_gui.h:174
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
@ PCWHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition picker_gui.h:196
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
static const int PREVIEW_WIDTH
Width of each preview button.
Definition picker_gui.h:172
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
static const int PREVIEW_BOTTOM
Offset from bottom edge to draw preview.
Definition picker_gui.h:175
void OnInit() override
Notification that the nested widget tree gets initialized.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
static const int PREVIEW_HEIGHT
Height of each preview button.
Definition picker_gui.h:173
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:118
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:222
SpriteID build_tunnel
button for building a tunnel
Definition rail.h:150
CursorID rail_swne
Cursor for building rail in X direction.
Definition rail.h:157
SpriteID convert_rail
button for converting rail
Definition rail.h:151
CursorID convert
Cursor for converting track.
Definition rail.h:163
CursorID depot
Cursor for building a depot.
Definition rail.h:161
TimerGameCalendar::Date introduction_date
Introduction date.
Definition rail.h:246
CursorID rail_nwse
Cursor for building rail in Y direction.
Definition rail.h:159
SpriteID build_x_rail
button for building single rail in X direction
Definition rail.h:145
CursorID rail_ew
Cursor for building rail in E-W direction.
Definition rail.h:158
SpriteID auto_rail
button for the autorail construction
Definition rail.h:148
CursorID autorail
Cursor for autorail tool.
Definition rail.h:160
struct RailTypeInfo::@21 gui_sprites
struct containing the sprites for the rail GUI.
StringID menu_text
Name of this rail type in the main toolbar dropdown.
Definition rail.h:169
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
Definition rail.h:168
SpriteID signals[SIGTYPE_END][2][2]
signal GUI sprites (type, variant, state)
Definition rail.h:152
SpriteID build_ew_rail
button for building single rail in E-W direction
Definition rail.h:146
SpriteID build_y_rail
button for building single rail in Y direction
Definition rail.h:147
StringID replace_text
Text used in the autoreplace GUI.
Definition rail.h:171
SpriteID build_depot
button for building depots
Definition rail.h:149
SpriteID build_ns_rail
button for building single rail in N-S direction
Definition rail.h:144
CursorID rail_ns
Cursor for building rail in N-S direction.
Definition rail.h:156
struct RailTypeInfo::@23 strings
Strings associated with the rail type.
SpriteID tunnel
tunnel sprites base
Definition rail.h:136
bool IsActive() const override
Should picker class/type selection be enabled?
Definition rail_gui.cpp:978
bool HasClassChoice() const override
Are there multiple classes to chose from?
Definition rail_gui.cpp:989
std::span< const BadgeID > GetTypeBadges(int cls_id, int id) const override
Get the item of a type.
StringID GetTypeName(int cls_id, int id) const override
Get the item of a type.
StringID GetClassTooltip() const override
Get the tooltip string for the class list.
Definition rail_gui.cpp:975
void SetSelectedType(int id) const override
Set the selected type.
void DrawType(int x, int y, int cls_id, int id) const override
Draw preview image of an item.
StringID GetClassName(int id) const override
Get the name of a class.
Definition rail_gui.cpp:997
StringID GetTypeTooltip() const override
Get the tooltip string for the type grid.
Definition rail_gui.cpp:976
int GetSelectedClass() const override
Get the index of the selected class.
Definition rail_gui.cpp:994
void SetSelectedClass(int id) const override
Set the selected class.
Definition rail_gui.cpp:995
bool IsTypeAvailable(int cls_id, int id) const override
Test if an item is currently buildable.
int GetSelectedType() const override
Get the selected type.
void FillUsedItems(std::set< PickerItem > &items) override
Fill a set with all items that are used by the current player.
Wrapper class to abstract away the way the tiles are stored.
Definition map_func.h:25
static Year year
Current year, starting at 0.
int GetSelectedType() const override
Get the selected type.
void SetSelectedClass(int id) const override
Set the selected class.
StringID GetTypeTooltip() const override
Get the tooltip string for the type grid.
void DrawType(int x, int y, int cls_id, int id) const override
Draw preview image of an item.
bool IsTypeAvailable(int cls_id, int id) const override
Test if an item is currently buildable.
std::span< const BadgeID > GetTypeBadges(int cls_id, int id) const override
Get the item of a type.
int GetSelectedClass() const override
Get the index of the selected class.
StringID GetTypeName(int cls_id, int id) const override
Get the item of a type.
bool IsActive() const override
Should picker class/type selection be enabled?
void SetSelectedType(int id) const override
Set the selected type.
StringID GetClassName(int id) const override
Get the name of a class.
StringID GetClassTooltip() const override
Get the tooltip string for the class list.
void FillUsedItems(std::set< PickerItem > &items) override
Fill a set with all items that are used by the current player.
bool HasClassChoice() const override
Are there multiple classes to chose from?
RectPadding framerect
Standard padding inside many panels.
Definition window_gui.h:40
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
int vsep_normal
Normal vertical spacing.
Definition window_gui.h:58
RectPadding fullbevel
Always-scaled bevel thickness.
Definition window_gui.h:39
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:93
Functions related to commands.
static constexpr DoCommandFlags CommandFlagsToDCFlags(CommandFlags cmd_flags)
Extracts the DC flags needed for DoCommand from the flags returned by GetCommandFlags.
@ Auto
don't allow building on structures
Commands
List of commands.
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
bool IsValidAxis(Axis d)
Checks if an integer value is a valid Axis.
Axis
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X axis.
@ AXIS_Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
@ DIAGDIR_NE
Northeast, upper right on your monitor.
@ DIAGDIR_NW
Northwest.
@ DIAGDIR_SE
Southeast.
@ DIAGDIR_SW
Southwest.
Functions related to the drop down widget.
Types related to the drop down widget.
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
Base class for engines.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:77
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
int CentreBounds(int min, int max, int size)
Determine where to position a centred object.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:958
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:38
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:1024
uint8_t GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition gfx.cpp:1276
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition gfx.cpp:1554
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:251
@ WKC_GLOBAL_HOTKEY
Fake keycode bit to indicate global hotkeys.
Definition gfx_type.h:35
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
constexpr NWidgetPart SetSpriteTip(SpriteID sprite, StringID tip={})
Widget part function for setting the sprite and tooltip.
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
constexpr NWidgetPart SetStringTip(StringID string, StringID tip={})
Widget part function for setting the string and tooltip.
constexpr NWidgetPart SetAspect(float ratio, AspectFlags flags=AspectFlag::ResizeX)
Widget part function for setting the aspect ratio.
constexpr NWidgetPart SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetToolTip(StringID tip)
Widget part function for setting tooltip and clearing the widget data.
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetValues widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
constexpr NWidgetPart SetPIPRatio(uint8_t ratio_pre, uint8_t ratio_inter, uint8_t ratio_post)
Widget part function for setting a pre/inter/post ratio.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
Definition window.cpp:955
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1535
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
GUI functions that shouldn't be here.
Hotkey related functions.
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
bool HandlePlacePushButton(Window *w, WidgetID widget, CursorID cursor, HighLightStyle mode)
This code is shared for the majority of the pushbuttons.
Definition main_gui.cpp:63
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:569
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:403
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
void GuiShowTooltips(Window *parent, EncodedString &&text, TooltipCloseCondition close_tooltip)
Shows a tooltip.
Definition misc_gui.cpp:688
GrfSpecFeature
Definition newgrf.h:69
Functions related to NewGRF badges.
@ Avail
Availability of station in construction window.
@ CBID_STATION_AVAILABILITY
Determine whether a newstation should be made available to build.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16_t cbid, uint16_t cb_res)
Converts a callback result into a boolean.
bool IsWaypointClass(const RoadStopClass &cls)
Test if a RoadStopClass is the waypoint class.
bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
Draw representation of a station tile for GUI purposes.
Header file for NewGRF stations.
StationClassID
@ STAT_CLASS_DFLT
Default station class.
@ STAT_CLASS_WAYP
Waypoint class.
std::unique_ptr< NWidgetBase > MakePickerClassWidgets()
Create nested widgets for the class picker widgets.
std::unique_ptr< NWidgetBase > MakePickerTypeWidgets()
Create nested widgets for the type picker widgets.
Functions/types etc.
RailTypes GetCompanyRailTypes(CompanyID company, bool introduces)
Get the rail types the given company can build.
Definition rail.cpp:253
RailTypes GetRailTypes(bool introduces)
Get list of rail types, regardless of company availability.
Definition rail.cpp:284
bool ValParamRailType(const RailType rail)
Validate functions for rail building.
Definition rail.cpp:208
std::vector< RailType > _sorted_railtypes
Sorted list of rail types.
Definition rail_cmd.cpp:47
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
Command definitions for rail.
Window * ShowBuildRailToolbar(RailType railtype)
Open the build rail toolbar window for a specific rail type.
Definition rail_gui.cpp:919
static constexpr NWidgetPart _nested_signal_builder_widgets[]
Nested widget definition of the build signal window.
static bool RailToolbar_CtrlChanged(Window *w)
Updates the Remove button because of Ctrl state change.
Definition rail_gui.cpp:335
void ResetSignalVariant(int32_t)
Updates the current signal variant used in the signal GUI to the one adequate to current year.
static void PlaceRail_Waypoint(TileIndex tile)
Place a rail waypoint.
Definition rail_gui.cpp:169
static void SetDefaultRailGui()
Set the initial (default) railtype to use.
static RailType _cur_railtype
Rail type of the current build-rail toolbar.
Definition rail_gui.cpp:57
static constexpr NWidgetPart _nested_build_waypoint_widgets[]
Nested widget definition for the build NewGRF rail waypoint window.
static constexpr NWidgetPart _nested_build_depot_widgets[]
Nested widget definition of the build rail depot window.
static void HandleAutoSignalPlacement()
Build new signals or remove signals or (if only one tile marked) edit a signal.
Definition rail_gui.cpp:414
static SignalVariant _cur_signal_variant
set the signal variant (for signal GUI)
Definition rail_gui.cpp:61
static void PlaceExtraDepotRail(TileIndex tile, DiagDirection dir, Track track)
Try to add an additional rail-track at the entrance of a depot.
Definition rail_gui.cpp:121
static void PlaceRail_Bridge(TileIndex tile, Window *w)
Start placing a rail bridge.
Definition rail_gui.cpp:295
static void PlaceRail_Station(TileIndex tile)
Place a rail station.
Definition rail_gui.cpp:201
static StationPickerSelection _station_gui
Settings of the station picker.
Definition rail_gui.cpp:75
static SignalType _cur_signal_type
set the signal type (for signal GUI)
Definition rail_gui.cpp:62
static void ToggleRailButton_Remove(Window *w)
Toggles state of the Remove button of Build rail toolbar.
Definition rail_gui.cpp:321
DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
Create a drop down list for all the rail types of the local company.
static WindowDesc _station_builder_desc(WDP_AUTO, "build_station_rail", 0, 0, WC_BUILD_STATION, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_station_builder_widgets, &BuildRailStationWindow::hotkeys)
High level window description of the station-build window (default & newGRF)
static void BuildRailClick_Remove(Window *w)
The "remove"-button click proc of the build-rail toolbar.
Definition rail_gui.cpp:356
static WindowDesc _signal_builder_desc(WDP_AUTO, {}, 0, 0, WC_BUILD_SIGNAL, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_signal_builder_widgets)
Signal selection window description.
static bool IsStationAvailable(const StationSpec *statspec)
Check whether a station type can be build.
Definition rail_gui.cpp:88
static Window * ShowStationBuilder(Window *parent)
Open station build window.
static bool StationUsesDefaultType(const BaseStation *bst)
Test if a station/waypoint uses the default graphics.
Definition rail_gui.cpp:961
static const Track _place_depot_extra_track[12]
Additional pieces of track to add at the entrance of a depot.
Definition rail_gui.cpp:131
static DiagDirection _build_depot_direction
Currently selected depot direction.
Definition rail_gui.cpp:59
void InitializeRailGui()
Initialize rail building GUI settings.
static void ShowSignalBuilder(Window *parent)
Open the signal selection window.
static bool _remove_button_clicked
Flag whether 'remove' toggle-button is currently enabled.
Definition rail_gui.cpp:58
void ReinitGuiAfterToggleElrail(bool disable)
Re-initialize rail-build toolbar after toggling support for electric trains.
static const DiagDirection _place_depot_extra_dir[12]
Direction to check for existing track pieces.
Definition rail_gui.cpp:138
void InitializeRailGUI()
Resets the rail GUI - sets default railtype to build and resets the signal GUI.
static bool _convert_signal_button
convert signal button in the signal GUI pressed
Definition rail_gui.cpp:60
static void GenericPlaceSignals(TileIndex tile)
Build a new signal or edit/remove a present signal, use CmdBuildSingleSignal() or CmdRemoveSingleSign...
Definition rail_gui.cpp:237
static WaypointPickerSelection _waypoint_gui
Settings of the waypoint picker.
Definition rail_gui.cpp:68
Functions/types etc.
@ SIGNAL_GUI_ALL
Show all signals, including block and presignals.
Definition rail_gui.h:25
@ SIGNAL_GUI_PATH
Show path signals only.
Definition rail_gui.h:24
@ SIGNAL_CYCLE_ALL
Cycle through all signals visible to the player.
Definition rail_gui.h:31
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
static debug_inline RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
@ RAIL_TILE_DEPOT
Depot (one entrance)
Definition rail_map.h:26
@ RAIL_TILE_SIGNALS
Normal rail tile with signals.
Definition rail_map.h:25
static debug_inline bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition rail_map.h:105
bool HasSignalOnTrack(Tile tile, Track track)
Checks for the presence of signals (either way) on the given track on the given rail tile.
Definition rail_map.h:412
static debug_inline bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ RAILTYPE_BEGIN
Used for iterations.
Definition rail_type.h:26
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:32
@ RAILTYPE_ELECTRIC
Electric rails.
Definition rail_type.h:28
@ RAILTYPE_RAIL
Standard non-electric rails.
Definition rail_type.h:27
Types related to the rail widgets.
@ WID_RAT_BUILD_SIGNALS
Build signals.
Definition rail_widget.h:26
@ WID_RAT_BUILD_NS
Build rail along the game view Y axis.
Definition rail_widget.h:17
@ WID_RAT_CONVERT_RAIL
Convert other rail to this type.
Definition rail_widget.h:30
@ WID_RAT_BUILD_Y
Build rail along the game grid Y axis.
Definition rail_widget.h:20
@ WID_RAT_BUILD_EW
Build rail along the game view X axis.
Definition rail_widget.h:19
@ WID_RAT_BUILD_BRIDGE
Build a bridge.
Definition rail_widget.h:27
@ WID_RAT_REMOVE
Bulldozer to remove rail.
Definition rail_widget.h:29
@ WID_RAT_CAPTION
Caption of the window.
Definition rail_widget.h:16
@ WID_RAT_BUILD_WAYPOINT
Build a waypoint.
Definition rail_widget.h:24
@ WID_RAT_BUILD_DEPOT
Build a depot.
Definition rail_widget.h:23
@ WID_RAT_DEMOLISH
Destroy something with dynamite!
Definition rail_widget.h:22
@ WID_RAT_BUILD_STATION
Build a station.
Definition rail_widget.h:25
@ WID_RAT_BUILD_X
Build rail along the game grid X axis.
Definition rail_widget.h:18
@ WID_RAT_BUILD_TUNNEL
Build a tunnel.
Definition rail_widget.h:28
@ WID_RAT_AUTORAIL
Autorail tool.
Definition rail_widget.h:21
@ WID_BRAS_HIGHLIGHT_OFF
Button for turning coverage highlighting off.
Definition rail_widget.h:59
@ WID_BRAS_PLATFORM_NUM_4
Button to select stations with 4 platforms.
Definition rail_widget.h:44
@ WID_BRAS_PLATFORM_NUM_7
Button to select stations with 7 platforms.
Definition rail_widget.h:47
@ WID_BRAS_PLATFORM_DIR_X
Button to select '/' view.
Definition rail_widget.h:38
@ WID_BRAS_PLATFORM_LEN_BEGIN
Helper for determining the chosen platform length.
Definition rail_widget.h:64
@ WID_BRAS_PLATFORM_LEN_3
Button to select 3 tiles length station platforms.
Definition rail_widget.h:51
@ WID_BRAS_PLATFORM_DIR_Y
Button to select '\' view.
Definition rail_widget.h:39
@ WID_BRAS_PLATFORM_LEN_6
Button to select 6 tiles length station platforms.
Definition rail_widget.h:54
@ WID_BRAS_PLATFORM_NUM_1
Button to select stations with a single platform.
Definition rail_widget.h:41
@ WID_BRAS_PLATFORM_NUM_BEGIN
Helper for determining the chosen platform width.
Definition rail_widget.h:63
@ WID_BRAS_PLATFORM_NUM_3
Button to select stations with 3 platforms.
Definition rail_widget.h:43
@ WID_BRAS_PLATFORM_LEN_5
Button to select 5 tiles length station platforms.
Definition rail_widget.h:53
@ WID_BRAS_PLATFORM_NUM_5
Button to select stations with 5 platforms.
Definition rail_widget.h:45
@ WID_BRAS_COVERAGE_TEXTS
Empty space for the coverage texts.
Definition rail_widget.h:61
@ WID_BRAS_PLATFORM_LEN_1
Button to select single tile length station platforms.
Definition rail_widget.h:49
@ WID_BRAS_HIGHLIGHT_ON
Button for turning coverage highlighting on.
Definition rail_widget.h:60
@ WID_BRAS_PLATFORM_DRAG_N_DROP
Button to enable drag and drop type station placement.
Definition rail_widget.h:57
@ WID_BRAS_PLATFORM_LEN_7
Button to select 7 tiles length station platforms.
Definition rail_widget.h:55
@ WID_BRAS_PLATFORM_NUM_6
Button to select stations with 6 platforms.
Definition rail_widget.h:46
@ WID_BRAS_PLATFORM_NUM_2
Button to select stations with 2 platforms.
Definition rail_widget.h:42
@ WID_BRAS_PLATFORM_LEN_4
Button to select 4 tiles length station platforms.
Definition rail_widget.h:52
@ WID_BRAS_PLATFORM_LEN_2
Button to select 2 tiles length station platforms.
Definition rail_widget.h:50
@ WID_BRAD_DEPOT_SE
Build a depot with the entrance in the south east.
Definition rail_widget.h:95
@ WID_BRAD_DEPOT_NE
Build a depot with the entrance in the north east.
Definition rail_widget.h:94
@ WID_BRAD_DEPOT_SW
Build a depot with the entrance in the south west.
Definition rail_widget.h:96
@ WID_BRAD_DEPOT_NW
Build a depot with the entrance in the north west.
Definition rail_widget.h:97
@ WID_BS_DRAG_SIGNALS_DENSITY_DECREASE
Decrease the signal density.
Definition rail_widget.h:85
@ WID_BS_TOGGLE_SIZE
Toggle showing advanced signal types.
Definition rail_widget.h:70
@ WID_BS_ELECTRIC_PBS
Build an electric path signal.
Definition rail_widget.h:81
@ WID_BS_SEMAPHORE_NORM
Build a semaphore normal block signal.
Definition rail_widget.h:71
@ WID_BS_ELECTRIC_NORM
Build an electric normal block signal.
Definition rail_widget.h:77
@ WID_BS_ELECTRIC_EXIT
Build an electric exit block signal.
Definition rail_widget.h:79
@ WID_BS_ELECTRIC_ENTRY
Build an electric entry block signal.
Definition rail_widget.h:78
@ WID_BS_SEMAPHORE_ENTRY
Build a semaphore entry block signal.
Definition rail_widget.h:72
@ WID_BS_BLOCK_SEL
Container for the block signal group, which can be hidden.
Definition rail_widget.h:87
@ WID_BS_CAPTION
Caption for the Signal Selection window.
Definition rail_widget.h:69
@ WID_BS_SEMAPHORE_COMBO
Build a semaphore combo block signal.
Definition rail_widget.h:74
@ WID_BS_BLOCK_SPACER_SEL
Container for the spacer between block and path signal groups, which can be hidden.
Definition rail_widget.h:88
@ WID_BS_SEMAPHORE_PBS
Build a semaphore path signal.
Definition rail_widget.h:75
@ WID_BS_DRAG_SIGNALS_DENSITY_LABEL
The current signal density.
Definition rail_widget.h:84
@ WID_BS_SEMAPHORE_EXIT
Build a semaphore exit block signal.
Definition rail_widget.h:73
@ WID_BS_SEMAPHORE_PBS_OWAY
Build a semaphore one way path signal.
Definition rail_widget.h:76
@ WID_BS_DRAG_SIGNALS_DENSITY_INCREASE
Increase the signal density.
Definition rail_widget.h:86
@ WID_BS_CONVERT
Convert the signal.
Definition rail_widget.h:83
@ WID_BS_ELECTRIC_COMBO
Build an electric combo block signal.
Definition rail_widget.h:80
@ WID_BS_ELECTRIC_PBS_OWAY
Build an electric one way path signal.
Definition rail_widget.h:82
bool IsLevelCrossingTile(Tile t)
Return whether a tile is a level crossing tile.
Definition road_map.h:79
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
SignalType
Type of signal, i.e.
Definition signal_type.h:23
@ SIGTYPE_PBS
normal pbs signal
Definition signal_type.h:28
@ SIGTYPE_BLOCK
block signal
Definition signal_type.h:24
SignalVariant
Variant of the signal, i.e.
Definition signal_type.h:16
@ SIG_SEMAPHORE
Old-fashioned semaphore signal.
Definition signal_type.h:18
@ SIG_ELECTRIC
Light signal.
Definition signal_type.h:17
Functions related to sound.
@ SND_15_BEEP
19 == 0x13 GUI button click
Definition sound_type.h:66
@ SND_20_CONSTRUCTION_RAIL
30 == 0x1E Construction: rail infrastructure
Definition sound_type.h:77
Functions to cache sprites in memory.
static const CursorID ANIMCURSOR_BUILDSIGNALS
1292 - 1293 - build signal
Definition sprites.h:1518
static const CursorID ANIMCURSOR_DEMOLISH
704 - 707 - demolish dynamite
Definition sprites.h:1514
Base classes/functions for stations.
Command definitions related to stations.
void ShowSelectStationIfNeeded(TileArea ta, StationPickerCmdProc proc)
Show the station selection window when needed.
void ShowSelectRailWaypointIfNeeded(TileArea ta, StationPickerCmdProc proc)
Show the rail waypoint selection window when needed.
int DrawStationCoverageAreaText(const Rect &r, StationCoverageType sct, int rad, bool supplies)
Calculates and draws the accepted or supplied cargo around the selected tile(s)
void CheckRedrawStationCoverage(const Window *w)
Check whether we need to redraw the station coverage text.
Contains enums and function declarations connected with stations GUI.
@ SCT_ALL
Draw all cargoes.
Definition station_gui.h:24
Maps accessors for stations.
bool HasStationTileRail(Tile t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint?
uint GetCustomStationSpecIndex(Tile t)
Get the custom station spec for this tile.
bool HasStationRail(Tile t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint?
static constexpr uint CA_TRAIN
Catchment for train stations with "modified catchment" enabled.
static constexpr uint CA_UNMODIFIED
Catchment for all stations with "modified catchment" disabled.
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:91
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:415
Functions related to OTTD's strings.
int64_t PackVelocity(uint speed, VehicleType type)
Pack velocity and vehicle type for use with SCC_VELOCITY string parameter.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
Base class for all station-ish types.
TileArea train_station
Tile area the train 'station' part covers.
virtual bool TileBelongsToRailStation(TileIndex tile) const =0
Check whether a specific tile belongs to this station.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void OnRealtimeTick(uint delta_ms) override
Called periodically.
void OnPaint() override
The window must be repainted.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
static EventState BuildRailStationGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildRailStationWindow.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
uint coverage_height
Height of the coverage texts.
void CheckSelectedSize(const StationSpec *statspec)
Verify whether the currently selected station size is allowed after selecting a new station class/typ...
void OnInit() override
Notification that the nested widget tree gets initialized.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Rail toolbar management class.
Definition rail_gui.cpp:439
void OnPlacePresize(Point pt, TileIndex tile) override
The user moves over the map when a tile highlight mode has been set when the special mouse mode has b...
Definition rail_gui.cpp:811
RailType railtype
Rail type to build.
Definition rail_gui.cpp:440
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition rail_gui.cpp:824
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition rail_gui.cpp:469
void ModifyRailType(RailType railtype)
Switch to another rail type.
Definition rail_gui.cpp:519
int last_user_action
Last started user action.
Definition rail_gui.cpp:441
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition rail_gui.cpp:501
bool OnTooltip(Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
Event to display a custom tooltip.
Definition rail_gui.cpp:490
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition rail_gui.cpp:568
EventState OnCTRLStateChange() override
The state of the control key has changed.
Definition rail_gui.cpp:817
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
Definition rail_gui.cpp:555
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition rail_gui.cpp:794
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 rail_gui.cpp:724
static EventState RailToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildRailToolbarWindow.
Definition rail_gui.cpp:834
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
Definition rail_gui.cpp:665
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 rail_gui.cpp:732
static const std::initializer_list< WidgetID > can_build_widgets
List of widgets to be disabled if infrastructure limit prevents building.
Definition rail_gui.cpp:463
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition rail_gui.cpp:659
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition rail_gui.cpp:453
Dimension sig_sprite_size
Maximum size of signal GUI sprites.
void DrawSignalSprite(const Rect &r, SpriteID image) const
Draw dynamic a signal-sprite in a button in the signal GUI.
void SetSignalUIMode()
Show or hide buttons for non-path signals in the signal GUI.
void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
Update size and resize step of a widget in the window.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
void OnInit() override
Notification that the nested widget tree gets initialized.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
int sig_sprite_bottom_offset
Maximum extent of signal GUI sprite from reference point towards bottom.
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
SoundSettings sound
sound effect settings
GUISettings gui
settings related to the GUI
RailTypes avail_railtypes
Rail types available to this company.
Dimensions (a width and height) of a rectangle in 2D.
Data about how and where to blit pixels.
Definition gfx_type.h:158
const struct GRFFile * grffile
grf file that introduced this entity
bool persistent_buildingtools
keep the building tools active after usage
SignalCycleSettings cycle_signal_types
Which signal types to cycle with the build signal tool.
uint8_t station_platlength
the platform length, in tiles, for rail stations
bool auto_remove_signals
automatically remove signals when in the way during rail construction
bool station_dragdrop
whether drag and drop is enabled for stations
bool station_show_coverage
whether to highlight coverage area
uint8_t default_rail_type
the default rail type for the rail GUI
uint8_t drag_signals_density
many signals density
uint8_t station_numtracks
the number of platforms to default on for rail stations
TimerGameCalendar::Year semaphore_build_before
build semaphore signals automatically before this year
SignalGUISettings signal_gui_mode
select which signal types are shown in the signal GUI
bool drag_signals_fixed_distance
keep fixed distance between signals when dragging
SignalType default_signal_type
The default signal type, which is set automatically by the last signal used. Not available in Setting...
bool link_terraform_toolbar
display terraform toolbar when displaying rail, road, water and airport toolbars
StationSettings station
settings related to station management
List of hotkeys for a window.
Definition hotkeys.h:37
All data for a single hotkey.
Definition hotkeys.h:21
static IterateWrapper Iterate()
Returns an iterable ensemble of all Tiles.
Definition map_func.h:362
Partial widget specification to allow NWidgets to be written nested.
Represents the covered area of e.g.
uint16_t w
The width of the area.
TileIndex tile
The base tile of the area.
uint16_t h
The height of the area.
Coordinates of a point in 2D.
static Titem * Get(auto index)
Returns Titem with given index.
Tindex index
Index of this pool item.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
Specification of a rectangle with absolute coordinates of all edges.
int Width() const
Get width of Rect.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
int Height() const
Get height of Rect.
bool click_beep
Beep on a random selection of buttons.
bool confirm
Play sound effect on successful constructions or other actions.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
StationClassID sel_class
Selected station class.
Definition rail_gui.cpp:71
uint16_t sel_type
Selected station type within the class.
Definition rail_gui.cpp:72
Axis axis
Selected orientation of the station.
Definition rail_gui.cpp:73
uint8_t station_spread
amount a station may spread
bool modified_catchment
different-size catchment areas
Station specification.
uint8_t disallowed_lengths
Bitmask of platform lengths available for the station.
uint8_t disallowed_platforms
Bitmask of number of platforms available for the station.
CargoGRFFileProps grf_prop
Link to NewGRF.
StationCallbackMasks callback_mask
Bitmask of station callbacks that have to be called.
Station data structure.
Point selstart
The location where the dragging started.
HighLightStyle drawstyle
Lower bits 0-3 are reserved for detailed highlight information.
Point pos
Location, in tile "units", of the northern tile of the selected area.
Point selend
The location where the drag currently ends.
StationClassID sel_class
Selected station class.
Definition rail_gui.cpp:65
uint16_t sel_type
Selected station type within the class.
Definition rail_gui.cpp:66
Representation of a waypoint.
High level window description.
Definition window_gui.h:167
Data structure for an opened window.
Definition window_gui.h:273
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:967
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1091
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1778
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:777
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
Definition window.cpp:3205
Window * parent
Parent window.
Definition window_gui.h:328
void RaiseWidget(WidgetID widget_index)
Marks a widget as raised.
Definition window_gui.h:469
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:555
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:503
ResizeInfo resize
Resize information.
Definition window_gui.h:314
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition window_gui.h:391
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1768
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:491
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
Definition window_gui.h:410
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition window.cpp:529
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:441
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:559
virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
The user has dragged over the map when the tile highlight mode has been set.
Definition window_gui.h:842
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:460
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1791
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:569
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:381
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Definition window_gui.h:450
bool GUIPlaceProcDragXY(ViewportDragDropSelectionProcess proc, TileIndex start_tile, TileIndex end_tile)
A central place to handle all X_AND_Y dragged GUI functions.
void PlaceProc_DemolishArea(TileIndex tile)
Start a drag for demolishing an area.
Window * ShowTerraformToolbar(Window *link)
Show the toolbar for terraforming in the game.
GUI stuff related to terraforming.
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
static debug_inline bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition tile_type.h:57
@ MP_RAILWAY
A railway.
Definition tile_type.h:49
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
void VpSetPresizeRange(TileIndex from, TileIndex to)
Highlights all tiles between a set of two tiles.
void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method)
Selects tiles while dragging.
void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, ViewportDragDropSelectionProcess process)
highlighting tiles while only going over them with the mouse
@ HT_LINE
used for autorail highlighting (longer stretches), lower bits: direction
@ HT_DIR_HL
horizontal lower
@ HT_DIR_X
X direction.
@ HT_DIAGONAL
Also allow 'diagonal rectangles'. Only usable in combination with HT_RECT or HT_POINT.
@ HT_RECT
rectangle (stations, depots, ...)
@ HT_DIR_MASK
masks the drag-direction
@ HT_RAIL
autorail (one piece), lower bits: direction
@ HT_DRAG_MASK
Mask for the tile drag-type modes.
@ HT_DIR_VL
vertical left
@ HT_SPECIAL
special mode used for highlighting while dragging (and for tunnels/docks)
@ HT_DIR_Y
Y direction.
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
bool IsValidTrack(Track track)
Checks if a Track is valid.
Definition track_func.h:28
Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or INVALID_TRACK.
Definition track_func.h:177
TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:573
TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition track_func.h:363
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_UPPER
Upper track.
Definition track_type.h:39
@ TRACK_BIT_LEFT
Left track.
Definition track_type.h:41
@ TRACK_BIT_HORZ
Upper and lower track.
Definition track_type.h:44
@ TRACK_BIT_LOWER
Lower track.
Definition track_type.h:40
@ TRACK_BIT_RIGHT
Right track.
Definition track_type.h:42
@ TRACK_BIT_VERT
Left and right track.
Definition track_type.h:45
Track
These are used to specify a single track.
Definition track_type.h:19
@ TRACK_Y
Track along the y-axis (north-west to south-east)
Definition track_type.h:22
@ TRACK_LOWER
Track in the lower corner of the tile (south)
Definition track_type.h:24
@ TRACK_LEFT
Track in the left corner of the tile (west)
Definition track_type.h:25
@ TRACK_RIGHT
Track in the right corner of the tile (east)
Definition track_type.h:26
@ TRACK_X
Track along the x-axis (north-east to south-west)
Definition track_type.h:21
@ TRACK_UPPER
Track in the upper corner of the tile (north)
Definition track_type.h:23
@ TRANSPORT_RAIL
Transport by train.
Header file for things common for tunnels and bridges.
TileIndex _build_tunnel_endtile
The end of a tunnel; as hidden return from the tunnel build command for GUI purposes.
Command definitions related to tunnels and bridges.
Functions that have tunnels and bridges in common.
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
TileIndex GetOtherTunnelBridgeEnd(Tile t)
Determines type of the wormhole and returns its other end.
bool CanBuildVehicleInfrastructure(VehicleType type, uint8_t subtype)
Check whether we can build infrastructure for the given vehicle type.
Definition vehicle.cpp:1892
Functions related to vehicles.
@ VEH_TRAIN
Train vehicle type.
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel)
Select or deselect waypoint for coverage area highlight.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Functions related to (drawing on) viewports.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects)
@ VPM_FIX_Y
drag only in Y axis
@ VPM_Y_LIMITED
Drag only in Y axis with limited size.
@ VPM_X_AND_Y_LIMITED
area of land of limited size
@ VPM_FIX_VERTICAL
drag only in vertical direction
@ VPM_X_LIMITED
Drag only in X axis with limited size.
@ VPM_X_AND_Y
area of land in X and Y directions
@ VPM_FIX_HORIZONTAL
drag only in horizontal direction
@ VPM_FIX_X
drag only in X axis
@ VPM_SIGNALDIRS
similar to VMP_RAILDIRS, but with different cursor
@ VPM_X_OR_Y
drag in X or Y direction
@ VPM_RAILDIRS
all rail directions
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
@ DDSP_CONVERT_RAIL
Rail conversion.
@ DDSP_DEMOLISH_AREA
Clear area.
@ DDSP_BUILD_SIGNALS
Signal placement.
@ DDSP_REMOVE_STATION
Station removal.
@ DDSP_BUILD_STATION
Station placement.
@ DDSP_BUILD_BRIDGE
Bridge placement.
@ DDSP_PLACE_RAIL
Rail placement.
void DrawWaypointSprite(int x, int y, StationClassID station_class, uint16_t station_type, RailType railtype)
Draw a waypoint.
Definition waypoint.cpp:28
Base of waypoints.
@ WPF_ROAD
This is a road waypoint.
Axis GetAxisForNewRailWaypoint(TileIndex tile)
Get the axis for a new rail waypoint.
Command definitions related to waypoints.
Functions related to waypoints.
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h:42
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
@ WWT_LABEL
Centered label.
Definition widget_type.h:49
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:67
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:45
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:40
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition widget_type.h:58
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition widget_type.h:56
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition widget_type.h:53
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:69
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition widget_type.h:61
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:38
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition widget_type.h:57
@ NWID_HORIZONTAL_LTR
Horizontal container that doesn't change the order of the widgets for RTL languages.
Definition widget_type.h:68
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:72
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:21
@ AWV_INCREASE
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:22
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1182
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1194
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1140
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3147
Window functions not directly related to making/drawing windows.
Functions, definitions and such used only by the GUI.
@ Construction
This window is used for construction; close it whenever changing company.
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
@ WDP_ALIGN_TOOLBAR
Align toward the toolbar.
Definition window_gui.h:146
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
Definition window_type.h:29
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_BUILD_STATION
Build station; Window numbers:
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition window_type.h:75
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:47
@ WC_SCEN_LAND_GEN
Landscape generation (in Scenario Editor); Window numbers:
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
@ WC_BUILD_SIGNAL
Build signal toolbar; Window numbers:
@ WC_BUILD_DEPOT
Build depot; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_BUILD_WAYPOINT
Build waypoint; Window numbers:
@ WC_BUILD_BRIDGE
Build bridge; Window numbers:
Functions related to zooming.
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107