OpenTTD Source 20260621-master-g720d10536d
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
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"
33#include "hotkeys.h"
34#include "engine_base.h"
35#include "vehicle_func.h"
36#include "zoom_func.h"
37#include "rail_gui.h"
38#include "toolbar_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
89static bool IsStationAvailable(const StationSpec *statspec)
90{
91 if (statspec == nullptr || !statspec->callback_mask.Test(StationCallbackMask::Avail)) return true;
92
93 uint16_t cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, nullptr, INVALID_TILE);
94 if (cb_res == CALLBACK_FAILED) return true;
95
97}
98
99void CcPlaySound_CONSTRUCTION_RAIL(Commands, const CommandCost &result, TileIndex tile)
100{
101 if (result.Succeeded() && _settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
102}
103
104static void GenericPlaceRail(TileIndex tile, Track track)
105{
107 Command<Commands::RemoveRail>::Post(STR_ERROR_CAN_T_REMOVE_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
108 tile, track);
109 } else {
110 Command<Commands::BuildRail>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
111 tile, _cur_railtype, track, _settings_client.gui.auto_remove_signals);
112 }
113}
114
123{
124 if (GetRailTileType(tile) == RailTileType::Depot) return;
125 if (GetRailTileType(tile) == RailTileType::Signals && !_settings_client.gui.auto_remove_signals) return;
126 if (!GetTrackBits(tile).Any(DiagdirReachesTracks(dir))) return;
127
128 Command<Commands::BuildRail>::Post(tile, _cur_railtype, track, _settings_client.gui.auto_remove_signals);
129}
130
132static constexpr std::array<DiagDirectionIndexArray<Track>, 3> _place_depot_extra_track{{
133 {Track::Left, Track::Upper, Track::Upper, Track::Right}, // First additional track for directions 0..3
134 {Track::X, Track::Y, Track::X, Track::Y}, // Second additional track
135 {Track::Lower, Track::Left, Track::Right, Track::Lower}, // Third additional track
136}};
137
139static constexpr std::array<DiagDirectionIndexArray<DiagDirection>, 3> _place_depot_extra_dir{{
140 {DiagDirection::SE, DiagDirection::SW, DiagDirection::SE, DiagDirection::SW}, // First additional track for directions 0..3
143}};
144
145void CcRailDepot(Commands, const CommandCost &result, TileIndex tile, RailType, DiagDirection dir)
146{
147 if (result.Failed()) return;
148
149 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
150 if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
151
152 tile += TileOffsByDiagDir(dir);
153
154 if (IsTileType(tile, TileType::Railway)) {
156
157 /* Don't place the rail straight out of the depot of there is another depot across from it. */
158 Tile double_depot_tile = tile + TileOffsByDiagDir(dir);
159 bool is_double_depot = IsValidTile(double_depot_tile) && IsRailDepotTile(double_depot_tile);
160 if (!is_double_depot) PlaceExtraDepotRail(tile, _place_depot_extra_dir[1][dir], _place_depot_extra_track[1][dir]);
161
163 }
164}
165
171{
174 return;
175 }
176
177 Axis axis = GetAxisForNewRailWaypoint(tile);
178 if (IsValidAxis(axis)) {
179 /* Valid tile for waypoints */
181 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
182 } else {
183 /* Tile where we can't build rail waypoints. This is always going to fail,
184 * but provides the user with a proper error message. */
185 Command<Commands::BuildRailWaypoint>::Post(STR_ERROR_CAN_T_BUILD_RAIL_WAYPOINT , tile, Axis::X, 1, 1, STAT_CLASS_WAYP, 0, StationID::Invalid(), false);
186 }
187}
188
189void CcStation(Commands, const CommandCost &result, TileIndex tile)
190{
191 if (result.Failed()) return;
192
193 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
194 /* Only close the station builder window if the default station and non persistent building is chosen. */
195 if (_station_gui.sel_class == STAT_CLASS_DFLT && _station_gui.sel_type == 0 && !_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
196}
197
203{
206 VpSetPlaceSizingLimit(-1);
207 } else if (_settings_client.gui.station_dragdrop) {
209 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
210 } else {
211 int w = _settings_client.gui.station_numtracks;
212 int h = _settings_client.gui.station_platlength;
213 if (_station_gui.axis == Axis::X) std::swap(w, h);
214
217 uint8_t numtracks = _settings_client.gui.station_numtracks;
218 uint8_t platlength = _settings_client.gui.station_platlength;
219 bool adjacent = _ctrl_pressed;
220
221 auto proc = [=](bool test, StationID to_join) -> bool {
222 if (test) {
223 return Command<Commands::BuildRailStation>::Do(CommandFlagsToDCFlags(GetCommandFlags<Commands::BuildRailStation>()), tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, StationID::Invalid(), adjacent).Succeeded();
224 } else {
225 return Command<Commands::BuildRailStation>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_STATION, CcStation, tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, to_join, adjacent);
226 }
227 };
228
229 ShowSelectStationIfNeeded(TileArea(tile, w, h), proc);
230 }
231}
232
239{
241
242 if (trackbits.Any(TRACK_BIT_VERT)) { // N-S direction
243 trackbits = (_tile_fract_coords.x <= _tile_fract_coords.y) ? Track::Right : Track::Left;
244 }
245
246 if (trackbits.Any(TRACK_BIT_HORZ)) { // E-W direction
247 trackbits = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? Track::Upper : Track::Lower;
248 }
249
250 Track track = FindFirstTrack(trackbits);
251
253 Command<Commands::RemoveSignal>::Post(STR_ERROR_CAN_T_REMOVE_SIGNALS_FROM, CcPlaySound_CONSTRUCTION_RAIL, tile, track);
254 } else {
255 /* Which signals should we cycle through? */
256 bool tile_has_signal = IsPlainRailTile(tile) && IsValidTrack(track) && HasSignalOnTrack(tile, track);
257 SignalType cur_signal_on_tile = tile_has_signal ? GetSignalType(tile, track) : _cur_signal_type;
258 SignalType cycle_start;
259 SignalType cycle_end;
260
261 /* Start with the least restrictive case: the player wants to cycle through all signals they can see. */
262 if (_settings_client.gui.cycle_signal_types == SIGNAL_CYCLE_ALL) {
263 cycle_start = _settings_client.gui.signal_gui_mode == SIGNAL_GUI_ALL ? SignalType::Block : SignalType::Path;
264 cycle_end = SignalType::PathOneWay;
265 } else {
266 /* Only cycle through signals of the same group (block or path) as the current signal on the tile. */
267 if (cur_signal_on_tile <= SignalType::Combo) {
268 /* Block signals only. */
269 cycle_start = SignalType::Block;
270 cycle_end = SignalType::Combo;
271 } else {
272 /* Path signals only. */
273 cycle_start = SignalType::Path;
274 cycle_end = SignalType::PathOneWay;
275 }
276 }
277
278 if (FindWindowById(WindowClass::BuildSignal, 0) != nullptr) {
279 /* signal GUI is used */
280 Command<Commands::BuildSignal>::Post(_convert_signal_button ? STR_ERROR_SIGNAL_CAN_T_CONVERT_SIGNALS_HERE : STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
281 tile, track, _cur_signal_type, _cur_signal_variant, _convert_signal_button, false, _ctrl_pressed, cycle_start, cycle_end, 0, 0);
282 } else {
284 Command<Commands::BuildSignal>::Post(STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
285 tile, track, _settings_client.gui.default_signal_type, sigvar, false, false, _ctrl_pressed, cycle_start, cycle_end, 0, 0);
286
287 }
288 }
289}
290
296static void PlaceRail_Bridge(TileIndex tile, Window *w)
297{
298 if (IsBridgeTile(tile)) {
299 TileIndex other_tile = GetOtherTunnelBridgeEnd(tile);
300 Point pt = {0, 0};
301 w->OnPlaceMouseUp(VPM_X_OR_Y, DDSP_BUILD_BRIDGE, pt, other_tile, tile);
302 } else {
304 }
305}
306
313{
314 if (result.Succeeded()) {
315 if (_settings_client.sound.confirm) SndPlayTileFx(SND_20_CONSTRUCTION_RAIL, tile);
316 if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
317 } else {
319 }
320}
321
334
341{
342 if (w->IsWidgetDisabled(WID_RAT_REMOVE)) return false;
343
344 /* allow ctrl to switch remove mode only for these widgets */
345 for (WidgetID i = WID_RAT_BUILD_NS; i <= WID_RAT_BUILD_STATION; i++) {
346 if ((i <= WID_RAT_AUTORAIL || i >= WID_RAT_BUILD_WAYPOINT) && w->IsWidgetLowered(i)) {
348 return true;
349 }
350 }
351
352 return false;
353}
354
355
362{
363 if (w->IsWidgetDisabled(WID_RAT_REMOVE)) return;
365 SndClickBeep();
366
367 /* handle station builder */
370 /* starting drag & drop remove */
371 if (!_settings_client.gui.station_dragdrop) {
372 SetTileSelectSize(1, 1);
373 } else {
374 VpSetPlaceSizingLimit(-1);
375 }
376 } else {
377 /* starting station build mode */
378 if (!_settings_client.gui.station_dragdrop) {
379 int x = _settings_client.gui.station_numtracks;
380 int y = _settings_client.gui.station_platlength;
381 if (_station_gui.axis == Axis::X) std::swap(x, y);
382 SetTileSelectSize(x, y);
383 } else {
384 VpSetPlaceSizingLimit(_settings_game.station.station_spread);
385 }
386 }
387 }
388}
389
390static void DoRailroadTrack(Track track)
391{
393 Command<Commands::RemoveRailLong>::Post(STR_ERROR_CAN_T_REMOVE_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
394 TileVirtXY(_thd.selend.x, _thd.selend.y), TileVirtXY(_thd.selstart.x, _thd.selstart.y), track);
395 } else {
396 Command<Commands::BuildRailLong>::Post(STR_ERROR_CAN_T_BUILD_RAILROAD_TRACK, CcPlaySound_CONSTRUCTION_RAIL,
397 TileVirtXY(_thd.selend.x, _thd.selend.y), TileVirtXY(_thd.selstart.x, _thd.selstart.y), _cur_railtype, track, _settings_client.gui.auto_remove_signals, false);
398 }
399}
400
401static void HandleAutodirPlacement()
402{
403 Track trackstat = static_cast<Track>( _thd.drawstyle & HT_DIR_MASK); // 0..5
404
405 if (_thd.drawstyle & HT_RAIL) { // one tile case
406 GenericPlaceRail(TileVirtXY(_thd.selend.x, _thd.selend.y), trackstat);
407 return;
408 }
409
410 DoRailroadTrack(trackstat);
411}
412
420{
421 Track track = static_cast<Track>(_thd.drawstyle & HT_DIR_MASK); // 0..5
422
423 if ((_thd.drawstyle & HT_DRAG_MASK) == HT_RECT) { // one tile case
424 GenericPlaceSignals(TileVirtXY(_thd.selend.x, _thd.selend.y));
425 return;
426 }
427
428 /* _settings_client.gui.drag_signals_density is given as a parameter such that each user
429 * in a network game can specify their own signal density */
431 Command<Commands::RemoveSignalLong>::Post(STR_ERROR_CAN_T_REMOVE_SIGNALS_FROM, CcPlaySound_CONSTRUCTION_RAIL,
432 TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y), track, _ctrl_pressed);
433 } else {
434 bool sig_gui = FindWindowById(WindowClass::BuildSignal, 0) != nullptr;
435 SignalType sigtype = sig_gui ? _cur_signal_type : _settings_client.gui.default_signal_type;
437 Command<Commands::BuildSignalLong>::Post(STR_ERROR_CAN_T_BUILD_SIGNALS_HERE, CcPlaySound_CONSTRUCTION_RAIL,
438 TileVirtXY(_thd.selstart.x, _thd.selstart.y), TileVirtXY(_thd.selend.x, _thd.selend.y), track, sigtype, sigvar, false, _ctrl_pressed, !_settings_client.gui.drag_signals_fixed_distance, _settings_client.gui.drag_signals_density);
439 }
440}
441
442
444struct BuildRailToolbarWindow : Window {
447
448 BuildRailToolbarWindow(WindowDesc &desc, RailType railtype) : Window(desc), railtype(railtype)
449 {
450 this->CreateNestedTree();
453 this->OnInvalidateData();
454
455 if (_settings_client.gui.link_terraform_toolbar) ShowTerraformToolbar(this);
456 }
457
458 void Close([[maybe_unused]] int data = 0) override
459 {
462 if (_settings_client.gui.link_terraform_toolbar) CloseWindowById(WindowClass::ScenarioGenerateLandscape, 0, false);
463 CloseWindowById(WindowClass::JoinStation, 0);
464 this->Window::Close();
465 }
466
473
474 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
475 {
476 if (!gui_scope) return;
477
478 if (!ValParamRailType(this->railtype)) {
479 /* Close toolbar if rail type is not available. */
480 this->Close();
481 return;
482 }
483
485 for (const WidgetID widget : can_build_widgets) this->SetWidgetDisabledState(widget, !can_build);
486 if (!can_build) {
487 CloseWindowById(WindowClass::BuildSignal, TRANSPORT_RAIL);
488 CloseWindowById(WindowClass::BuildStation, TRANSPORT_RAIL);
489 CloseWindowById(WindowClass::BuildDepot, TRANSPORT_RAIL);
490 CloseWindowById(WindowClass::BuildWaypoint, TRANSPORT_RAIL);
491 CloseWindowById(WindowClass::JoinStation, 0);
492 }
493 }
494
495 bool OnTooltip([[maybe_unused]] Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
496 {
498 if (can_build) return false;
499
500 if (std::ranges::find(can_build_widgets, widget) == std::end(can_build_widgets)) return false;
501
502 GuiShowTooltips(this, GetEncodedString(STR_TOOLBAR_DISABLED_NO_VEHICLE_AVAILABLE), close_cond);
503 return true;
504 }
505
506 void OnInit() override
507 {
508 /* Configure the rail toolbar for the railtype. */
509 const RailTypeInfo *rti = GetRailTypeInfo(this->railtype);
518 }
519
525 {
526 this->railtype = railtype;
527 this->ReInit();
528 }
529
530 void UpdateRemoveWidgetStatus(WidgetID clicked_widget)
531 {
532 switch (clicked_widget) {
533 case WID_RAT_REMOVE:
534 /* If it is the removal button that has been clicked, do nothing,
535 * as it is up to the other buttons to drive removal status */
536 return;
537
538 case WID_RAT_BUILD_NS:
539 case WID_RAT_BUILD_X:
540 case WID_RAT_BUILD_EW:
541 case WID_RAT_BUILD_Y:
542 case WID_RAT_AUTORAIL:
546 /* Removal button is enabled only if the rail/signal/waypoint/station
547 * button is still lowered. Once raised, it has to be disabled */
548 this->SetWidgetDisabledState(WID_RAT_REMOVE, !this->IsWidgetLowered(clicked_widget));
549 break;
550
551 default:
552 /* When any other buttons than rail/signal/waypoint/station, raise and
553 * disable the removal button */
556 break;
557 }
558 }
559
560 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
561 {
562 if (widget == WID_RAT_CAPTION) {
563 const RailTypeInfo *rti = GetRailTypeInfo(this->railtype);
564 if (rti->max_speed > 0) {
565 return GetString(STR_TOOLBAR_RAILTYPE_VELOCITY, rti->strings.toolbar_caption, PackVelocity(rti->max_speed, VehicleType::Train));
566 }
567 return GetString(rti->strings.toolbar_caption);
568 }
569
570 return this->Window::GetWidgetString(widget, stringid);
571 }
572
579 {
580 switch (widget) {
588 case WID_RAT_BUILD_WAYPOINT: return SPR_CURSOR_WAYPOINT;
589 case WID_RAT_BUILD_STATION: return SPR_CURSOR_RAIL_STATION;
591 case WID_RAT_BUILD_BRIDGE: return SPR_CURSOR_BRIDGE;
594 default: NOT_REACHED();
595 }
596 }
597
604 {
605 switch (widget) {
606 case WID_RAT_BUILD_NS: return HT_LINE | HT_DIR_VL;
607 case WID_RAT_BUILD_X: return HT_LINE | HT_DIR_X;
608 case WID_RAT_BUILD_EW: return HT_LINE | HT_DIR_HL;
609 case WID_RAT_BUILD_Y: return HT_LINE | HT_DIR_Y;
610 case WID_RAT_AUTORAIL: return HT_RAIL;
611 case WID_RAT_DEMOLISH: return HT_RECT | HT_DIAGONAL;
612 case WID_RAT_BUILD_DEPOT: return HT_RECT;
613 case WID_RAT_BUILD_WAYPOINT: return HT_RECT;
614 case WID_RAT_BUILD_STATION: return HT_RECT;
615 case WID_RAT_BUILD_SIGNALS: return HT_RECT;
616 case WID_RAT_BUILD_BRIDGE: return HT_RECT;
617 case WID_RAT_BUILD_TUNNEL: return HT_SPECIAL;
619 default: NOT_REACHED();
620 }
621 }
622
623
624 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
625 {
626 if (widget < WID_RAT_BUILD_NS) return;
627
629
630 if (widget == WID_RAT_REMOVE) {
633 return;
634 }
635
636 this->last_user_action = widget;
637 bool started = HandlePlacePushButton(this, widget, this->GetCursorForWidget(widget), this->GetHighLightStyleForWidget(widget));
638
639 switch (widget) {
641 if (started) {
642 ShowBuildTrainDepotPicker(this);
643 }
644 break;
645
647 if (started) {
648 ShowBuildWaypointPicker(this);
649 }
650 break;
651
653 if (started) {
654 ShowStationBuilder(this);
655 }
656 break;
657
659 if (started != _ctrl_pressed) {
660 ShowSignalBuilder(this);
661 }
662 break;
663 }
664 }
665
666 this->UpdateRemoveWidgetStatus(widget);
668 }
669
670 EventState OnHotkey(int hotkey) override
671 {
672 if (IsSpecialHotkey(hotkey)) return this->ChangeRailTypeOnHotkey(hotkey);
673 MarkTileDirtyByTile(TileVirtXY(_thd.pos.x, _thd.pos.y)); // redraw tile selection
674 return Window::OnHotkey(hotkey);
675 }
676
677 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
678 {
679 switch (this->last_user_action) {
680 case WID_RAT_BUILD_NS:
682 break;
683
684 case WID_RAT_BUILD_X:
686 break;
687
688 case WID_RAT_BUILD_EW:
690 break;
691
692 case WID_RAT_BUILD_Y:
694 break;
695
696 case WID_RAT_AUTORAIL:
698 break;
699
700 case WID_RAT_DEMOLISH:
702 break;
703
705 Command<Commands::BuildRailDepot>::Post(STR_ERROR_CAN_T_BUILD_TRAIN_DEPOT, CcRailDepot, tile, _cur_railtype, _build_depot_direction);
706 break;
707
709 PlaceRail_Waypoint(tile);
710 break;
711
713 PlaceRail_Station(tile);
714 break;
715
718 break;
719
721 PlaceRail_Bridge(tile, this);
722 break;
723
725 Command<Commands::BuildTunnel>::Post(STR_ERROR_CAN_T_BUILD_TUNNEL_HERE, CcBuildRailTunnel, tile, TRANSPORT_RAIL, _cur_railtype, INVALID_ROADTYPE);
726 break;
727
730 break;
731
732 default: NOT_REACHED();
733 }
734 }
735
736 void OnPlaceDrag(ViewportPlaceMethod select_method, [[maybe_unused]] ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt) override
737 {
738 /* no dragging if you have pressed the convert button */
739 if (FindWindowById(WindowClass::BuildSignal, 0) != nullptr && _convert_signal_button && this->IsWidgetLowered(WID_RAT_BUILD_SIGNALS)) return;
740
741 VpSelectTilesWithMethod(pt.x, pt.y, select_method);
742 }
743
744 Point OnInitialPosition(int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
745 {
746 return AlignInitialConstructionToolbar(sm_width);
747 }
748
749 void OnPlaceMouseUp([[maybe_unused]] ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, [[maybe_unused]] Point pt, TileIndex start_tile, TileIndex end_tile) override
750 {
751 if (pt.x != -1) {
752 switch (select_proc) {
753 default: NOT_REACHED();
755 if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
757 break;
758
759 case DDSP_PLACE_RAIL:
760 HandleAutodirPlacement();
761 break;
762
765 break;
766
768 GUIPlaceProcDragXY(select_proc, start_tile, end_tile);
769 break;
770
772 Command<Commands::ConvertRail>::Post(STR_ERROR_CAN_T_CONVERT_RAIL, CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, _cur_railtype, _ctrl_pressed);
773 break;
774
778 /* Station */
780 bool keep_rail = !_ctrl_pressed;
781 Command<Commands::RemoveFromRailStation>::Post(STR_ERROR_CAN_T_REMOVE_PART_OF_STATION, CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, keep_rail);
782 } else {
783 HandleStationPlacement(start_tile, end_tile);
784 }
785 } else {
786 /* Waypoint */
788 bool keep_rail = !_ctrl_pressed;
789 Command<Commands::RemoveFromRailWaypoint>::Post(STR_ERROR_CAN_T_REMOVE_RAIL_WAYPOINT , CcPlaySound_CONSTRUCTION_RAIL, end_tile, start_tile, keep_rail);
790 } else {
791 TileArea ta(start_tile, end_tile);
792 Axis axis = select_method == VPM_X_LIMITED ? Axis::X : Axis::Y;
793 bool adjacent = _ctrl_pressed;
794
795 auto proc = [=](bool test, StationID to_join) -> bool {
796 if (test) {
797 return Command<Commands::BuildRailWaypoint>::Do(CommandFlagsToDCFlags(GetCommandFlags<Commands::BuildRailWaypoint>()), ta.tile, axis, ta.w, ta.h, _waypoint_gui.sel_class, _waypoint_gui.sel_type, StationID::Invalid(), adjacent).Succeeded();
798 } else {
799 return Command<Commands::BuildRailWaypoint>::Post(STR_ERROR_CAN_T_BUILD_RAIL_WAYPOINT , CcPlaySound_CONSTRUCTION_RAIL, ta.tile, axis, ta.w, ta.h, _waypoint_gui.sel_class, _waypoint_gui.sel_type, to_join, adjacent);
800 }
801 };
802
804 }
805 }
806 break;
807 }
808 }
809 }
810
811 void OnPlaceObjectAbort() override
812 {
815
816 this->RaiseButtons();
819
820 CloseWindowById(WindowClass::BuildSignal, TRANSPORT_RAIL);
821 CloseWindowById(WindowClass::BuildStation, TRANSPORT_RAIL);
822 CloseWindowById(WindowClass::BuildDepot, TRANSPORT_RAIL);
823 CloseWindowById(WindowClass::BuildWaypoint, TRANSPORT_RAIL);
824 CloseWindowById(WindowClass::JoinStation, 0);
825 CloseWindowByClass(WindowClass::BuildBridge);
826 }
827
828 void OnPlacePresize([[maybe_unused]] Point pt, TileIndex tile) override
829 {
830 Command<Commands::BuildTunnel>::Do(DoCommandFlag::Auto, tile, TRANSPORT_RAIL, _cur_railtype, INVALID_ROADTYPE);
832 }
833
835 {
836 /* do not toggle Remove button by Ctrl when placing station */
839 }
840
841 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
842 {
843 if (this->IsWidgetLowered(WID_RAT_BUILD_WAYPOINT)) CheckRedrawRailWaypointCoverage(this);
844 }
845
852 {
853 auto [index, step] = GetListIndexStep(SpecialListHotkeys(hotkey), _sorted_railtypes, this->railtype);
854
856 index = (index + step) % _sorted_railtypes.size();
857 }
858
861
862 /* Update cursor and all sub windows. */
863 if (_thd.GetCallbackWnd() == this) SetCursor(this->GetCursorForWidget(this->last_user_action), PAL_NONE);
864 for (WindowClass cls : {WindowClass::BuildStation, WindowClass::BuildSignal, WindowClass::BuildWaypoint, WindowClass::BuildDepot}) SetWindowDirty(cls, TRANSPORT_RAIL);
865
866 return EventState::Handled;
867 }
868
875 {
876 if (_game_mode != GameMode::Normal) return EventState::NotHandled;
878 if (w == nullptr) return EventState::NotHandled;
879 return w->OnHotkey(hotkey);
880 }
881
882 static inline HotkeyList hotkeys{"railtoolbar", {
883 Hotkey('1', "build_ns", WID_RAT_BUILD_NS),
884 Hotkey('2', "build_x", WID_RAT_BUILD_X),
885 Hotkey('3', "build_ew", WID_RAT_BUILD_EW),
886 Hotkey('4', "build_y", WID_RAT_BUILD_Y),
887 Hotkey({'5', 'A' | WKC_GLOBAL_HOTKEY}, "autorail", WID_RAT_AUTORAIL),
888 Hotkey('6', "demolish", WID_RAT_DEMOLISH),
889 Hotkey('7', "depot", WID_RAT_BUILD_DEPOT),
890 Hotkey('8', "waypoint", WID_RAT_BUILD_WAYPOINT),
891 Hotkey('9', "station", WID_RAT_BUILD_STATION),
892 Hotkey('S', "signal", WID_RAT_BUILD_SIGNALS),
893 Hotkey('B', "bridge", WID_RAT_BUILD_BRIDGE),
894 Hotkey('T', "tunnel", WID_RAT_BUILD_TUNNEL),
895 Hotkey('R', "remove", WID_RAT_REMOVE),
896 Hotkey('C', "convert", WID_RAT_CONVERT_RAIL),
899 Hotkey(WKC_L_BRACKET | WKC_CTRL, "first_railtype", to_underlying(SpecialListHotkeys::FirstItem)),
900 Hotkey(WKC_R_BRACKET | WKC_CTRL, "last_railtype", to_underlying(SpecialListHotkeys::LastItem)),
902};
903
904static constexpr std::initializer_list<NWidgetPart> _nested_build_rail_widgets = {
909 EndContainer(),
912 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
914 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
916 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_EW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
918 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
920 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_AUTORAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_AUTORAIL),
921
923
925 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
927 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_DEPOT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_TRAIN_DEPOT_FOR_BUILDING),
929 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_WAYPOINT, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL_TO_WAYPOINT),
931 SetFill(0, 1), SetToolbarMinimalSize(2), SetSpriteTip(SPR_IMG_RAIL_STATION, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_STATION),
933 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_SIGNALS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS),
935 SetFill(0, 1), SetToolbarMinimalSize(2), SetSpriteTip(SPR_IMG_BRIDGE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_BRIDGE),
937 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_TUNNEL_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TUNNEL),
939 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_REMOVE, STR_RAIL_TOOLBAR_TOOLTIP_TOGGLE_BUILD_REMOVE_FOR),
941 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_CONVERT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL),
942 EndContainer(),
943};
944
947 WindowPosition::Manual, "toolbar_rail", 0, 0,
948 WindowClass::BuildToolbar, WindowClass::None,
950 _nested_build_rail_widgets,
951 &BuildRailToolbarWindow::hotkeys
952);
953
954
964{
965 if (!Company::IsValidID(_local_company)) return nullptr;
966 if (!ValParamRailType(railtype)) return nullptr;
967
968 CloseWindowByClass(WindowClass::BuildToolbar);
969 _cur_railtype = railtype;
971 return new BuildRailToolbarWindow(_build_rail_desc, railtype);
972}
973
974/* TODO: For custom stations, respect their allowed platforms/lengths bitmasks!
975 * --pasky */
976
977static void HandleStationPlacement(TileIndex start, TileIndex end)
978{
979 TileArea ta(start, end);
980 uint numtracks = ta.w;
981 uint platlength = ta.h;
982
983 if (_station_gui.axis == Axis::X) std::swap(numtracks, platlength);
984
987 bool adjacent = _ctrl_pressed;
988
989 auto proc = [=](bool test, StationID to_join) -> bool {
990 if (test) {
991 return Command<Commands::BuildRailStation>::Do(CommandFlagsToDCFlags(GetCommandFlags<Commands::BuildRailStation>()), ta.tile, rt, params.axis, numtracks, platlength, params.sel_class, params.sel_type, StationID::Invalid(), adjacent).Succeeded();
992 } else {
993 return Command<Commands::BuildRailStation>::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);
994 }
995 };
996
998}
999
1006{
1007 for (TileIndex t : bst->train_station) {
1008 if (bst->TileBelongsToRailStation(t) && HasStationRail(t) && GetCustomStationSpecIndex(t) == 0) return true;
1009 }
1010 return false;
1011}
1012
1013class StationPickerCallbacks : public PickerCallbacksNewGRFClass<StationClass> {
1014public:
1015 StationPickerCallbacks() : PickerCallbacksNewGRFClass<StationClass>("fav_stations") {}
1016
1018
1019 StringID GetClassTooltip() const override { return STR_PICKER_STATION_CLASS_TOOLTIP; }
1020 StringID GetTypeTooltip() const override { return STR_PICKER_STATION_TYPE_TOOLTIP; }
1021 StringID GetCollectionTooltip() const override { return STR_PICKER_STATION_COLLECTION_TOOLTIP; }
1022
1023 bool IsActive() const override
1024 {
1025 for (const auto &cls : StationClass::Classes()) {
1026 if (IsWaypointClass(cls)) continue;
1027 for (const auto *spec : cls.Specs()) {
1028 if (spec != nullptr) return true;
1029 }
1030 }
1031 return false;
1032 }
1033
1034 bool HasClassChoice() const override
1035 {
1036 return std::ranges::count_if(StationClass::Classes(), [](const auto &cls) { return !IsWaypointClass(cls); }) > 1;
1037 }
1038
1039 int GetSelectedClass() const override { return _station_gui.sel_class.base(); }
1040 void SetSelectedClass(int id) const override { _station_gui.sel_class = this->GetClassIndex(id); }
1041
1042 StringID GetClassName(int id) const override
1043 {
1044 const auto *sc = GetClass(id);
1045 if (IsWaypointClass(*sc)) return INVALID_STRING_ID;
1046 return sc->name;
1047 }
1048
1049 int GetSelectedType() const override { return _station_gui.sel_type; }
1050 void SetSelectedType(int id) const override { _station_gui.sel_type = id; }
1051
1052 StringID GetTypeName(int cls_id, int id) const override
1053 {
1054 const auto *spec = this->GetSpec(cls_id, id);
1055 return (spec == nullptr) ? STR_STATION_CLASS_DFLT_STATION : spec->name;
1056 }
1057
1058 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1059 {
1060 const auto *spec = this->GetSpec(cls_id, id);
1061 if (spec == nullptr) return {};
1062 return spec->badges;
1063 }
1064
1065 bool IsTypeAvailable(int cls_id, int id) const override
1066 {
1067 return IsStationAvailable(this->GetSpec(cls_id, id));
1068 }
1069
1070 void DrawType(int x, int y, int cls_id, int id) const override
1071 {
1072 if (!DrawStationTile(x, y, _cur_railtype, _station_gui.axis, this->GetClassIndex(cls_id), id)) {
1073 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2 + to_underlying(_station_gui.axis));
1074 }
1075 }
1076
1077 void FillUsedItems(std::set<PickerItem> &items) override
1078 {
1079 bool default_added = false;
1080 for (const Station *st : Station::Iterate()) {
1081 if (st->owner != _local_company) continue;
1082 if (!default_added && StationUsesDefaultType(st)) {
1083 items.insert({0, 0, STAT_CLASS_DFLT.base(), 0});
1084 default_added = true;
1085 }
1086 for (const auto &sm : st->speclist) {
1087 if (sm.spec == nullptr) continue;
1088 items.insert({sm.grfid, sm.localidx, sm.spec->class_index.base(), sm.spec->index});
1089 }
1090 }
1091 }
1092
1093 static StationPickerCallbacks instance;
1094};
1095/* static */ StationPickerCallbacks StationPickerCallbacks::instance;
1096
1097struct BuildRailStationWindow : public PickerWindow {
1098private:
1100
1106 void CheckSelectedSize(const StationSpec *statspec)
1107 {
1108 if (statspec == nullptr || _settings_client.gui.station_dragdrop) return;
1109
1110 /* If current number of tracks is not allowed, make it as big as possible */
1111 if (HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1112 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1113 _settings_client.gui.station_numtracks = 1;
1114 if (statspec->disallowed_platforms != UINT8_MAX) {
1115 while (HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1116 _settings_client.gui.station_numtracks++;
1117 }
1118 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1119 }
1120 }
1121
1122 if (HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1123 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1124 _settings_client.gui.station_platlength = 1;
1125 if (statspec->disallowed_lengths != UINT8_MAX) {
1126 while (HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1127 _settings_client.gui.station_platlength++;
1128 }
1129 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1130 }
1131 }
1132 }
1133
1138 {
1139 if (_settings_client.gui.station_dragdrop) {
1140 SetTileSelectSize(1, 1);
1141 } else {
1142 int x = _settings_client.gui.station_numtracks;
1143 int y = _settings_client.gui.station_platlength;
1144 if (_station_gui.axis == Axis::X) std::swap(x, y);
1146 SetTileSelectSize(x, y);
1147 }
1148 }
1149
1150 int rad = (_settings_game.station.modified_catchment) ? CA_TRAIN : CA_UNMODIFIED;
1151 if (_settings_client.gui.station_show_coverage) SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
1152 }
1153
1154public:
1156 {
1157 this->coverage_height = 2 * GetCharacterHeight(FontSize::Normal) + WidgetDimensions::scaled.vsep_normal;
1158 this->ConstructWindow();
1159 }
1160
1161 void OnInit() override
1162 {
1164 if (_settings_client.gui.station_dragdrop) {
1166 } else {
1167 this->LowerWidget(WID_BRAS_PLATFORM_NUM_BEGIN + _settings_client.gui.station_numtracks);
1168 this->LowerWidget(WID_BRAS_PLATFORM_LEN_BEGIN + _settings_client.gui.station_platlength);
1169 }
1170 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_OFF, !_settings_client.gui.station_show_coverage);
1171 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_ON, _settings_client.gui.station_show_coverage);
1172 this->SetSelectedSize();
1173
1174 this->PickerWindow::OnInit();
1175 }
1176
1177 void Close([[maybe_unused]] int data = 0) override
1178 {
1179 CloseWindowById(WindowClass::JoinStation, 0);
1180 this->PickerWindow::Close();
1181 }
1182
1183 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1184 {
1185 if (gui_scope) {
1186 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1187 this->CheckSelectedSize(statspec);
1188 }
1189
1190 this->PickerWindow::OnInvalidateData(data, gui_scope);
1191 }
1192
1193 void OnPaint() override
1194 {
1195 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1196 int rad = (_settings_game.station.modified_catchment) ? CA_TRAIN : CA_UNMODIFIED;
1197
1198 for (uint bits = 0; bits < 7; bits++) {
1199 bool disable = bits >= _settings_game.station.station_spread;
1200 if (statspec == nullptr) {
1201 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, disable);
1202 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, disable);
1203 } else {
1204 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, HasBit(statspec->disallowed_platforms, bits) || disable);
1205 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, HasBit(statspec->disallowed_lengths, bits) || disable);
1206 }
1207 }
1208
1209 this->DrawWidgets();
1210
1211 if (this->IsShaded()) return;
1212 /* 'Accepts' and 'Supplies' texts. */
1213 Rect r = this->GetWidget<NWidgetBase>(WID_BRAS_COVERAGE_TEXTS)->GetCurrentRect();
1214 const int bottom = r.bottom;
1215 r.bottom = INT_MAX; // Allow overflow as we want to know the required height.
1216 if (statspec != nullptr) r.top = DrawBadgeNameList(r, statspec->badges, GrfSpecFeature::Stations);
1217 r.top = DrawStationCoverageAreaText(r, SCT_ALL, rad, false) + WidgetDimensions::scaled.vsep_normal;
1218 r.top = DrawStationCoverageAreaText(r, SCT_ALL, rad, true);
1219 /* Resize background if the window is too small.
1220 * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
1221 * (This is the case, if making the window bigger moves the mouse into the window.) */
1222 if (r.top > bottom) {
1223 this->coverage_height += r.top - bottom;
1224 this->ReInit();
1225 }
1226 }
1227
1228 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1229 {
1230 switch (widget) {
1233 size.width = ScaleGUITrad(PREVIEW_WIDTH) + WidgetDimensions::scaled.fullbevel.Horizontal();
1234 size.height = ScaleGUITrad(PREVIEW_HEIGHT) + WidgetDimensions::scaled.fullbevel.Vertical();
1235 break;
1236
1238 size.height = this->coverage_height;
1239 break;
1240
1241 default:
1242 this->PickerWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
1243 break;
1244 }
1245 }
1246
1247 void DrawWidget(const Rect &r, WidgetID widget) const override
1248 {
1249 DrawPixelInfo tmp_dpi;
1250
1251 switch (widget) {
1253 /* Set up a clipping area for the '/' station preview */
1254 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1255 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1256 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1259 if (!DrawStationTile(x, y, _cur_railtype, Axis::X, _station_gui.sel_class, _station_gui.sel_type)) {
1260 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2);
1261 }
1262 }
1263 break;
1264 }
1265
1267 /* Set up a clipping area for the '\' station preview */
1268 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1269 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1270 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1273 if (!DrawStationTile(x, y, _cur_railtype, Axis::Y, _station_gui.sel_class, _station_gui.sel_type)) {
1274 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 3);
1275 }
1276 }
1277 break;
1278 }
1279
1280 default:
1281 this->PickerWindow::DrawWidget(r, widget);
1282 break;
1283 }
1284 }
1285
1286 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1287 {
1288 switch (widget) {
1292 _station_gui.axis = static_cast<Axis>(widget - WID_BRAS_PLATFORM_DIR_X);
1294
1295 this->SetSelectedSize();
1296 SndClickBeep();
1297 this->SetDirty();
1298 CloseWindowById(WindowClass::JoinStation, 0);
1299 break;
1300
1308 this->RaiseWidget(WID_BRAS_PLATFORM_NUM_BEGIN + _settings_client.gui.station_numtracks);
1310
1311 _settings_client.gui.station_numtracks = widget - WID_BRAS_PLATFORM_NUM_BEGIN;
1312 _settings_client.gui.station_dragdrop = false;
1313
1314 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1315 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1316 /* The previously selected number of platforms in invalid */
1317 for (uint i = 0; i < 7; i++) {
1318 if (!HasBit(statspec->disallowed_lengths, i)) {
1319 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1320 _settings_client.gui.station_platlength = i + 1;
1321 break;
1322 }
1323 }
1324 }
1325
1326 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1327 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1328 this->SetSelectedSize();
1329 SndClickBeep();
1330 this->SetDirty();
1331 CloseWindowById(WindowClass::JoinStation, 0);
1332 break;
1333 }
1334
1342 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1344
1345 _settings_client.gui.station_platlength = widget - WID_BRAS_PLATFORM_LEN_BEGIN;
1346 _settings_client.gui.station_dragdrop = false;
1347
1348 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1349 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1350 /* The previously selected number of tracks in invalid */
1351 for (uint i = 0; i < 7; i++) {
1352 if (!HasBit(statspec->disallowed_platforms, i)) {
1353 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1354 _settings_client.gui.station_numtracks = i + 1;
1355 break;
1356 }
1357 }
1358 }
1359
1360 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1361 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1362 this->SetSelectedSize();
1363 SndClickBeep();
1364 this->SetDirty();
1365 CloseWindowById(WindowClass::JoinStation, 0);
1366 break;
1367 }
1368
1370 _settings_client.gui.station_dragdrop ^= true;
1371
1373
1374 /* get the first allowed length/number of platforms */
1375 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1376 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1377 for (uint i = 0; i < 7; i++) {
1378 if (!HasBit(statspec->disallowed_lengths, i)) {
1379 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1380 _settings_client.gui.station_platlength = i + 1;
1381 break;
1382 }
1383 }
1384 }
1385 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1386 for (uint i = 0; i < 7; i++) {
1387 if (!HasBit(statspec->disallowed_platforms, i)) {
1388 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1389 _settings_client.gui.station_numtracks = i + 1;
1390 break;
1391 }
1392 }
1393 }
1394
1395 this->SetWidgetLoweredState(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN, !_settings_client.gui.station_dragdrop);
1396 this->SetWidgetLoweredState(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN, !_settings_client.gui.station_dragdrop);
1397 this->SetSelectedSize();
1398 SndClickBeep();
1399 this->SetDirty();
1400 CloseWindowById(WindowClass::JoinStation, 0);
1401 break;
1402 }
1403
1406 _settings_client.gui.station_show_coverage = (widget != WID_BRAS_HIGHLIGHT_OFF);
1407
1408 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_OFF, !_settings_client.gui.station_show_coverage);
1409 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_ON, _settings_client.gui.station_show_coverage);
1410 this->SetSelectedSize();
1411 SndClickBeep();
1412 this->SetDirty();
1413 SetViewportCatchmentStation(nullptr, true);
1414 break;
1415
1416 default:
1417 this->PickerWindow::OnClick(pt, widget, click_count);
1418 break;
1419 }
1420 }
1421
1422 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
1423 {
1425 }
1426
1433 {
1434 if (_game_mode == GameMode::Menu) return EventState::NotHandled;
1435 Window *w = ShowStationBuilder(FindWindowById(WindowClass::BuildToolbar, TRANSPORT_RAIL));
1436 if (w == nullptr) return EventState::NotHandled;
1437 return w->OnHotkey(hotkey);
1438 }
1439
1440 static inline HotkeyList hotkeys{"buildrailstation", {
1441 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1443};
1444
1445static constexpr std::initializer_list<NWidgetPart> _nested_station_builder_widgets = {
1448 NWidget(WWT_CAPTION, Colours::DarkGreen), SetStringTip(STR_STATION_BUILD_RAIL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1451 EndContainer(),
1457 NWidget(WWT_LABEL, Colours::Invalid), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_ORIENTATION),
1459 NWidget(WWT_PANEL, Colours::Grey, WID_BRAS_PLATFORM_DIR_X), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1460 NWidget(WWT_PANEL, Colours::Grey, WID_BRAS_PLATFORM_DIR_Y), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1461 EndContainer(),
1462 NWidget(WWT_LABEL, Colours::Invalid), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_NUMBER_OF_TRACKS),
1464 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1465 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1466 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1467 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1468 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1469 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1470 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_NUM_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1471 EndContainer(),
1472 NWidget(WWT_LABEL, Colours::Invalid), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_PLATFORM_LENGTH),
1474 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1475 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1476 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1477 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1478 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1479 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1480 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_LEN_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1481 EndContainer(),
1483 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_PLATFORM_DRAG_N_DROP), SetMinimalSize(75, 12), SetStringTip(STR_STATION_BUILD_DRAG_DROP, STR_STATION_BUILD_DRAG_DROP_TOOLTIP),
1484 EndContainer(),
1485 NWidget(WWT_LABEL, Colours::Invalid), SetStringTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE), SetFill(1, 0),
1487 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_HIGHLIGHT_OFF), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
1488 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAS_HIGHLIGHT_ON), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
1489 EndContainer(),
1491 EndContainer(),
1492 EndContainer(),
1493 EndContainer(),
1495 EndContainer(),
1496};
1497
1500 WindowPosition::Automatic, "build_station_rail", 0, 0,
1501 WindowClass::BuildStation, WindowClass::BuildToolbar,
1503 _nested_station_builder_widgets,
1504 &BuildRailStationWindow::hotkeys
1505);
1506
1513{
1515}
1516
1517struct BuildSignalWindow : public PickerWindowBase {
1518private:
1521
1527 void DrawSignalSprite(const Rect &r, SpriteID image) const
1528 {
1529 Point offset;
1530 Dimension sprite_size = GetSpriteSize(image, &offset);
1531 Rect ir = r.Shrink(WidgetDimensions::scaled.imgbtn);
1532 int x = CentreBounds(ir.left, ir.right, sprite_size.width - offset.x) - offset.x; // centered
1533 int y = ir.top - sig_sprite_bottom_offset +
1534 (ir.Height() + sig_sprite_size.height) / 2; // aligned to bottom
1535
1536 DrawSprite(image, PAL_NONE, x, y);
1537 }
1538
1541 {
1542 bool show_non_path_signals = (_settings_client.gui.signal_gui_mode == SIGNAL_GUI_ALL);
1543
1544 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1545 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SPACER_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1546 }
1547
1548public:
1550 {
1551 this->CreateNestedTree();
1552 this->SetSignalUIMode();
1554 this->OnInvalidateData();
1555 }
1556
1557 void Close([[maybe_unused]] int data = 0) override
1558 {
1559 _convert_signal_button = false;
1561 }
1562
1563 void OnInit() override
1564 {
1565 /* Calculate maximum signal sprite size. */
1566 this->sig_sprite_size.width = 0;
1567 this->sig_sprite_size.height = 0;
1568 this->sig_sprite_bottom_offset = 0;
1570 for (SignalType type : EnumRange(SignalType::End)) {
1573 Point offset;
1574 Dimension sprite_size = GetSpriteSize(rti->gui_sprites.signals[type][variant][state], &offset);
1575 this->sig_sprite_bottom_offset = std::max<int>(this->sig_sprite_bottom_offset, sprite_size.height);
1576 this->sig_sprite_size.width = std::max<int>(this->sig_sprite_size.width, sprite_size.width - offset.x);
1577 this->sig_sprite_size.height = std::max<int>(this->sig_sprite_size.height, sprite_size.height - offset.y);
1578 }
1579 }
1580 }
1581 }
1582
1583 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1584 {
1585 if (widget == WID_BS_DRAG_SIGNALS_DENSITY_LABEL) {
1586 /* Two digits for signals density. */
1587 size.width = std::max(size.width, 2 * GetDigitWidth() + padding.width + WidgetDimensions::scaled.framerect.Horizontal());
1589 size.width = std::max(size.width, this->sig_sprite_size.width + padding.width);
1590 size.height = std::max(size.height, this->sig_sprite_size.height + padding.height);
1591 }
1592 }
1593
1594 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1595 {
1596 switch (widget) {
1598 return GetString(STR_JUST_INT, _settings_client.gui.drag_signals_density);
1599
1600 default:
1601 return this->Window::GetWidgetString(widget, stringid);
1602 }
1603 }
1604
1605 void DrawWidget(const Rect &r, WidgetID widget) const override
1606 {
1608 /* Extract signal from widget number. */
1609 SignalType type = static_cast<SignalType>((widget - WID_BS_SEMAPHORE_NORM) % to_underlying(SignalType::End));
1610 SignalVariant var = static_cast<SignalVariant>(to_underlying(SignalVariant::Semaphore) - (widget - WID_BS_SEMAPHORE_NORM) / to_underlying(SignalType::End)); // SignalVariant order is reversed compared to the widgets.
1611 SpriteID sprite = GetRailTypeInfo(_cur_railtype)->gui_sprites.signals[type][var][static_cast<SignalState>(this->IsWidgetLowered(widget))];
1612
1613 this->DrawSignalSprite(r, sprite);
1614 }
1615 }
1616
1617 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1618 {
1619 switch (widget) {
1633
1636
1637 /* Update default (last-used) signal type in config file. */
1638 _settings_client.gui.default_signal_type = _cur_signal_type;
1639
1640 /* If 'remove' button of rail build toolbar is active, disable it. */
1642 Window *w = FindWindowById(WindowClass::BuildToolbar, TRANSPORT_RAIL);
1643 if (w != nullptr) ToggleRailButton_Remove(w);
1644 }
1645
1646 SndClickBeep();
1647 break;
1648
1649 case WID_BS_CONVERT:
1651 SndClickBeep();
1652 break;
1653
1655 if (_settings_client.gui.drag_signals_density > 1) {
1656 _settings_client.gui.drag_signals_density--;
1657 }
1658 break;
1659
1661 if (_settings_client.gui.drag_signals_density < 20) {
1662 _settings_client.gui.drag_signals_density++;
1663 }
1664 break;
1665
1666 default: break;
1667 }
1668
1669 this->InvalidateData();
1670 }
1671
1677 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1678 {
1679 if (!gui_scope) return;
1681
1683
1686 }
1687};
1688
1690static constexpr std::initializer_list<NWidgetPart> _nested_signal_builder_widgets = {
1691 /* Title bar and buttons. */
1694 NWidget(WWT_CAPTION, Colours::DarkGreen, WID_BS_CAPTION), SetStringTip(STR_BUILD_SIGNAL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1695 EndContainer(),
1696
1697 /* Container for both signal groups, spacers, and convert/autofill buttons. */
1699 /* Block signals (can be hidden). */
1702 /* Semaphore block signals. */
1705 NWidget(WWT_PANEL, Colours::DarkGreen, WID_BS_SEMAPHORE_ENTRY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_ENTRY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1707 NWidget(WWT_PANEL, Colours::DarkGreen, WID_BS_SEMAPHORE_COMBO), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_COMBO_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1708 EndContainer(),
1709 /* Electric block signals. */
1715 EndContainer(),
1716 EndContainer(),
1717 EndContainer(),
1718
1719 /* Divider (only shown if block signals visible). */
1722 EndContainer(),
1723
1724 /* Path signals. */
1726 /* Semaphore path signals. */
1729 NWidget(WWT_PANEL, Colours::DarkGreen, WID_BS_SEMAPHORE_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_PBS_OWAY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1730 EndContainer(),
1731 /* Electric path signals. */
1734 NWidget(WWT_PANEL, Colours::DarkGreen, WID_BS_ELECTRIC_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_PBS_OWAY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1735 EndContainer(),
1736 EndContainer(),
1737
1738 /* Convert/autofill buttons. */
1740 NWidget(WWT_IMGBTN, Colours::DarkGreen, WID_BS_CONVERT), SetSpriteTip(SPR_IMG_SIGNAL_CONVERT, STR_BUILD_SIGNAL_CONVERT_TOOLTIP), SetFill(0, 1),
1741 NWidget(WWT_PANEL, Colours::DarkGreen), SetToolTip(STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_TOOLTIP), SetFill(0, 1),
1747 EndContainer(),
1748 EndContainer(),
1749 EndContainer(),
1750 EndContainer(),
1751 EndContainer(),
1752};
1753
1756 WindowPosition::Automatic, {}, 0, 0,
1757 WindowClass::BuildSignal, WindowClass::BuildToolbar,
1760);
1761
1766static void ShowSignalBuilder(Window *parent)
1767{
1769}
1770
1771struct BuildRailDepotWindow : public PickerWindowBase {
1772 BuildRailDepotWindow(WindowDesc &desc, Window *parent) : PickerWindowBase(desc, parent)
1773 {
1776 }
1777
1778 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1779 {
1780 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1781
1782 size.width = ScaleGUITrad(64) + WidgetDimensions::scaled.fullbevel.Horizontal();
1783 size.height = ScaleGUITrad(48) + WidgetDimensions::scaled.fullbevel.Vertical();
1784 }
1785
1786 void DrawWidget(const Rect &r, WidgetID widget) const override
1787 {
1788 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1789
1790 DrawPixelInfo tmp_dpi;
1791 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1792 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1793 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1794 int x = (ir.Width() - ScaleSpriteTrad(64)) / 2 + ScaleSpriteTrad(31);
1795 int y = (ir.Height() + ScaleSpriteTrad(48)) / 2 - ScaleSpriteTrad(31);
1797 }
1798 }
1799
1800 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1801 {
1802 switch (widget) {
1803 case WID_BRAD_DEPOT_NE:
1804 case WID_BRAD_DEPOT_SE:
1805 case WID_BRAD_DEPOT_SW:
1806 case WID_BRAD_DEPOT_NW:
1810 SndClickBeep();
1811 this->SetDirty();
1812 break;
1813 }
1814 }
1815};
1816
1818static constexpr std::initializer_list<NWidgetPart> _nested_build_depot_widgets = {
1821 NWidget(WWT_CAPTION, Colours::DarkGreen), SetStringTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1822 EndContainer(),
1826 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAD_DEPOT_NW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1827 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAD_DEPOT_SW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1828 EndContainer(),
1830 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAD_DEPOT_NE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1831 NWidget(WWT_TEXTBTN, Colours::Grey, WID_BRAD_DEPOT_SE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1832 EndContainer(),
1833 EndContainer(),
1834 EndContainer(),
1835};
1836
1839 WindowPosition::Automatic, {}, 0, 0,
1840 WindowClass::BuildDepot, WindowClass::BuildToolbar,
1843);
1844
1845static void ShowBuildTrainDepotPicker(Window *parent)
1846{
1848}
1849
1850class WaypointPickerCallbacks : public PickerCallbacksNewGRFClass<StationClass> {
1851public:
1852 WaypointPickerCallbacks() : PickerCallbacksNewGRFClass<StationClass>("fav_waypoints") {}
1853
1855
1856 StringID GetClassTooltip() const override { return STR_PICKER_WAYPOINT_CLASS_TOOLTIP; }
1857 StringID GetTypeTooltip() const override { return STR_PICKER_WAYPOINT_TYPE_TOOLTIP; }
1858 StringID GetCollectionTooltip() const override { return STR_PICKER_WAYPOINT_COLLECTION_TOOLTIP; }
1859
1860 bool IsActive() const override
1861 {
1862 for (const auto &cls : StationClass::Classes()) {
1863 if (!IsWaypointClass(cls)) continue;
1864 for (const auto *spec : cls.Specs()) {
1865 if (spec != nullptr) return true;
1866 }
1867 }
1868 return false;
1869 }
1870
1871 bool HasClassChoice() const override
1872 {
1873 return std::ranges::count_if(StationClass::Classes(), [](const auto &cls) { return IsWaypointClass(cls); }) > 1;
1874 }
1875
1876 void Close(int) override { ResetObjectToPlace(); }
1877 int GetSelectedClass() const override { return _waypoint_gui.sel_class.base(); }
1878 void SetSelectedClass(int id) const override { _waypoint_gui.sel_class = this->GetClassIndex(id); }
1879
1880 StringID GetClassName(int id) const override
1881 {
1882 const auto *sc = GetClass(id);
1883 if (!IsWaypointClass(*sc)) return INVALID_STRING_ID;
1884 return sc->name;
1885 }
1886
1887 int GetSelectedType() const override { return _waypoint_gui.sel_type; }
1888 void SetSelectedType(int id) const override { _waypoint_gui.sel_type = id; }
1889
1890 StringID GetTypeName(int cls_id, int id) const override
1891 {
1892 const auto *spec = this->GetSpec(cls_id, id);
1893 return (spec == nullptr) ? STR_STATION_CLASS_WAYP_WAYPOINT : spec->name;
1894 }
1895
1896 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1897 {
1898 const auto *spec = this->GetSpec(cls_id, id);
1899 if (spec == nullptr) return {};
1900 return spec->badges;
1901 }
1902
1903 bool IsTypeAvailable(int cls_id, int id) const override
1904 {
1905 return IsStationAvailable(this->GetSpec(cls_id, id));
1906 }
1907
1908 void DrawType(int x, int y, int cls_id, int id) const override
1909 {
1910 DrawWaypointSprite(x, y, this->GetClassIndex(cls_id), id, _cur_railtype);
1911 }
1912
1913 void FillUsedItems(std::set<PickerItem> &items) override
1914 {
1915 bool default_added = false;
1916 for (const Waypoint *wp : Waypoint::Iterate()) {
1917 if (wp->owner != _local_company || HasBit(wp->waypoint_flags, WPF_ROAD)) continue;
1918 if (!default_added && StationUsesDefaultType(wp)) {
1919 items.insert({0, 0, STAT_CLASS_WAYP.base(), 0});
1920 default_added = true;
1921 }
1922 for (const auto &sm : wp->speclist) {
1923 if (sm.spec == nullptr) continue;
1924 items.insert({sm.grfid, sm.localidx, sm.spec->class_index.base(), sm.spec->index});
1925 }
1926 }
1927 }
1928
1929 static WaypointPickerCallbacks instance;
1930};
1931/* static */ WaypointPickerCallbacks WaypointPickerCallbacks::instance;
1932
1933struct BuildRailWaypointWindow : public PickerWindow {
1934 BuildRailWaypointWindow(WindowDesc &desc, Window *parent) : PickerWindow(desc, parent, TRANSPORT_RAIL, WaypointPickerCallbacks::instance)
1935 {
1936 this->ConstructWindow();
1937 }
1938
1939 static inline HotkeyList hotkeys{"buildrailwaypoint", {
1940 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1941 }};
1942};
1943
1957
1960 WindowPosition::Automatic, "build_waypoint", 0, 0,
1961 WindowClass::BuildWaypoint, WindowClass::BuildToolbar,
1964 &BuildRailWaypointWindow::hotkeys
1965);
1966
1967static void ShowBuildWaypointPicker(Window *parent)
1968{
1969 if (!WaypointPickerCallbacks::instance.IsActive()) return;
1971}
1972
1977{
1979 _station_gui.sel_class = STAT_CLASS_DFLT;
1980 _station_gui.sel_type = 0;
1981 _waypoint_gui.sel_class = STAT_CLASS_WAYP;
1982 _waypoint_gui.sel_type = 0;
1983}
1984
1990{
1991 if (disable && _last_built_railtype == RAILTYPE_ELECTRIC) {
1993 BuildRailToolbarWindow *w = dynamic_cast<BuildRailToolbarWindow *>(FindWindowById(WindowClass::BuildToolbar, TRANSPORT_RAIL));
1994 if (w != nullptr) w->ModifyRailType(_cur_railtype);
1995 }
1997}
1998
2001{
2003
2004 RailType rt;
2005 switch (_settings_client.gui.default_rail_road_type) {
2007 /* Find the most used rail type */
2009
2010 rt = static_cast<RailType>(std::distance(std::begin(c->infrastructure.rail), std::ranges::max_element(c->infrastructure.rail)));
2011 if (c->infrastructure.rail[rt] > 0) break;
2012
2013 /* No rail, just get the first available one */
2014 [[fallthrough]];
2015 }
2017 /* Use first available type */
2018 std::vector<RailType>::const_iterator it = std::find_if(_sorted_railtypes.begin(), _sorted_railtypes.end(),
2019 [](RailType r) { return HasRailTypeAvail(_local_company, r); });
2020 rt = it != _sorted_railtypes.end() ? *it : RAILTYPE_BEGIN;
2021 break;
2022 }
2024 /* Use last available type */
2025 std::vector<RailType>::const_reverse_iterator it = std::find_if(_sorted_railtypes.rbegin(), _sorted_railtypes.rend(),
2026 [](RailType r){ return HasRailTypeAvail(_local_company, r); });
2027 rt = it != _sorted_railtypes.rend() ? *it : RAILTYPE_BEGIN;
2028 break;
2029 }
2030 default:
2031 NOT_REACHED();
2032 }
2033
2035}
2036
2042{
2044
2045 if (new_variant != _cur_signal_variant) {
2046 Window *w = FindWindowById(WindowClass::BuildSignal, 0);
2047 if (w != nullptr) {
2048 w->SetDirty();
2050 }
2051 _cur_signal_variant = new_variant;
2052 }
2053}
2054
2056static const IntervalTimer<TimerGameCalendar> _check_reset_signal{{TimerGameCalendar::Trigger::Year, TimerGameCalendar::Priority::None}, [](auto)
2057{
2058 if (TimerGameCalendar::year != _settings_client.gui.semaphore_build_before) return;
2059
2061}};
2062
2067{
2068 _convert_signal_button = false;
2069 _cur_signal_type = _settings_client.gui.default_signal_type;
2071}
2072
2079DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
2080{
2081 RailTypes used_railtypes;
2082 RailTypes avail_railtypes;
2083
2085
2086 /* Find the used railtypes. */
2087 if (for_replacement) {
2088 avail_railtypes = GetCompanyRailTypes(c->index, false);
2089 used_railtypes = GetRailTypes(false);
2090 } else {
2091 avail_railtypes = c->avail_railtypes;
2092 used_railtypes = GetRailTypes(true);
2093 }
2094
2095 DropDownList list;
2096
2097 if (all_option) {
2098 list.push_back(MakeDropDownListStringItem(STR_REPLACE_ALL_RAILTYPE, INVALID_RAILTYPE));
2099 }
2100
2101 Dimension d = { 0, 0 };
2102 /* Get largest icon size, to ensure text is aligned on each menu item. */
2103 if (!for_replacement) {
2104 used_railtypes.Reset(_railtypes_hidden_mask);
2105 for (const auto &rt : _sorted_railtypes) {
2106 if (!used_railtypes.Test(rt)) continue;
2107 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2109 }
2110 }
2111
2112 /* Shared list so that each item can take ownership. */
2113 auto badge_class_list = std::make_shared<GUIBadgeClasses>(GrfSpecFeature::RailTypes);
2114
2115 for (const auto &rt : _sorted_railtypes) {
2116 /* If it's not used ever, don't show it to the user. */
2117 if (!used_railtypes.Test(rt)) continue;
2118
2119 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2120
2121 if (for_replacement) {
2122 list.push_back(MakeDropDownListBadgeItem(badge_class_list, rti->badges, GrfSpecFeature::RailTypes, rti->introduction_date, GetString(rti->strings.replace_text), rt, !avail_railtypes.Test(rt)));
2123 } else {
2124 std::string str = rti->max_speed > 0
2125 ? GetString(STR_TOOLBAR_RAILTYPE_VELOCITY, rti->strings.menu_text, rti->max_speed)
2126 : GetString(rti->strings.menu_text);
2127 list.push_back(MakeDropDownListBadgeIconItem(badge_class_list, rti->badges, GrfSpecFeature::RailTypes, rti->introduction_date, RailBuildCost(rt), d, rti->gui_sprites.build_x_rail, PAL_NONE, std::move(str), rt, !avail_railtypes.Test(rt)));
2128 }
2129 }
2130
2131 if (list.empty()) {
2132 /* Empty dropdowns are not allowed */
2133 list.push_back(MakeDropDownListStringItem(STR_NONE, INVALID_RAILTYPE, true));
2134 }
2135
2136 return list;
2137}
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
void ShowBuildBridgeWindow(TileIndex start, TileIndex end, TransportType transport_type, RailType railtype, RoadType roadtype)
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.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
bool Failed() const
Did this command fail?
Iterate a range of enum values.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
static std::span< NewGRFClass< StationSpec, StationClassID > const > Classes()
static NewGRFClass * Get(StationClassID class_index)
StationClass::index_type GetClassIndex(int cls_id) const
Definition picker_gui.h:242
const StationClass * GetClass(int cls_id) const
Definition picker_gui.h:249
PickerCallbacksNewGRFClass(const std::string &ini_group)
Definition picker_gui.h:235
const StationClass::spec_type * GetSpec(int cls_id, int id) const
Definition picker_gui.h:257
Base class for windows opened from a toolbar.
Definition window_gui.h:998
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:3622
static constexpr int PREVIEW_WIDTH
Width of each preview button.
Definition picker_gui.h:339
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
static constexpr int PREVIEW_HEIGHT
Height of each preview button.
Definition picker_gui.h:340
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
static constexpr int PREVIEW_LEFT
Offset from left edge to draw preview.
Definition picker_gui.h:341
static constexpr int PREVIEW_BOTTOM
Offset from bottom edge to draw preview.
Definition picker_gui.h:342
@ PCWHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition picker_gui.h:373
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
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.
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:117
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
struct RailTypeInfo::@157247141350136173143103254227157213063052244122 strings
Strings associated with the rail type.
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
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
struct RailTypeInfo::@047376261311064105134233254254216006075341230376 gui_sprites
struct containing the sprites for the rail GUI.
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
EnumIndexArray< EnumIndexArray< EnumIndexArray< SpriteID, SignalState, SignalState::End >, SignalVariant, SignalVariant::End >, SignalType, SignalType::End > signals
signal GUI sprites (type, variant, state)
Definition rail.h:152
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
SpriteID tunnel
tunnel sprites base
Definition rail.h:135
struct RailTypeInfo::@057010233226120022371265166156055202241326366156 cursor
Cursors associated with the rail type.
bool IsActive() const override
Should picker class/type selection be enabled?
StringID GetCollectionTooltip() const override
Get the tooltip string for the collection list.
bool HasClassChoice() const override
Are there multiple classes to chose from?
std::span< const BadgeID > GetTypeBadges(int cls_id, int id) const override
Get the item's badges of a type.
StringID GetTypeName(int cls_id, int id) const override
Get the item name of a type.
StringID GetClassTooltip() const override
Get the tooltip string for the class list.
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.
StringID GetTypeTooltip() const override
Get the tooltip string for the type grid.
int GetSelectedClass() const override
Get the index of the selected class.
void SetSelectedClass(int id) const override
Set the selected class.
GrfSpecFeature GetFeature() const override
NewGRF feature this picker is for.
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.
GrfSpecFeature GetFeature() const override
NewGRF feature this picker is for.
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.
StringID GetCollectionTooltip() const override
Get the tooltip string for the collection list.
bool IsTypeAvailable(int cls_id, int id) const override
Test if an item is currently buildable.
void Close(int) override
Hide the window and all its child windows, and mark them for a later deletion.
std::span< const BadgeID > GetTypeBadges(int cls_id, int id) const override
Get the item's badges 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 name 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?
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition window_gui.h:95
CommandFlags GetCommandFlags(Commands cmd)
Get the command flags associated with the given command.
Definition command.cpp:113
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
Enumeration for the two axis X and Y.
@ X
The X axis.
@ Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
@ SW
Southwest.
@ NW
Northwest.
@ NE
Northeast, upper right on your monitor.
@ SE
Southeast.
std::unique_ptr< DropDownListItem > MakeDropDownListStringItem(StringID str, int value, bool masked, bool shaded)
Creates new DropDownListStringItem.
Definition dropdown.cpp:49
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.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition fontcache.cpp:88
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:971
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
void SetCursor(CursorID icon, PaletteID pal)
Assign an animation or a non-animated sprite to the cursor.
Definition gfx.cpp:1737
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:1037
uint8_t GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition gfx.cpp:1290
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:1572
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ Normal
Index of the normal font in the font tables.
Definition gfx_type.h:249
uint32_t CursorID
The number of the cursor (sprite).
Definition gfx_type.h:19
@ Invalid
Invalid marker.
Definition gfx_type.h:303
@ Grey
Grey.
Definition gfx_type.h:300
@ DarkGreen
Dark green.
Definition gfx_type.h:293
@ White
White colour.
Definition gfx_type.h:331
@ Orange
Orange colour.
Definition gfx_type.h:325
@ WKC_R_BRACKET
] Right square bracket
Definition gfx_type.h:102
@ WKC_L_BRACKET
[ Left square bracket
Definition gfx_type.h:100
@ 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 SetToolbarMinimalSize(int width)
Widget part function to setting the minimal size for a toolbar button.
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 SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FontSize::Normal)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetToolbarSpacerMinimalSize()
Widget part function to setting the minimal size for a toolbar spacer.
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
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 SetTextStyle(TextColour colour, FontSize size=FontSize::Normal)
Widget part function for setting the text style.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetArrowWidgetTypeTip(ArrowWidgetType widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
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:972
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1553
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.
std::tuple< size_t, size_t > GetListIndexStep(SpecialListHotkeys hotkey, const ListType &list, const ItemType &current_item)
Gets the first index in the list for given hotkey and the step to look for another if first is invali...
Definition hotkeys.h:110
SpecialListHotkeys
Indexes for special hotkeys to navigate in lists.
Definition hotkeys.h:93
@ NextItem
Hotkey to select next item in the list.
Definition hotkeys.h:95
@ FirstItem
Hotkey to select first item in the list.
Definition hotkeys.h:96
@ LastItem
Hotkey to select last item in the list.
Definition hotkeys.h:97
@ PreviousItem
Hotkey to select previous item in the list.
Definition hotkeys.h:94
bool IsSpecialHotkey(const int &hotkey)
Checks if hotkey index is special or not.
Definition hotkeys.h:84
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, RoadTramType sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
#define Point
Macro that prevents name conflicts between included headers.
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
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:407
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:574
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:690
GrfSpecFeature
Definition newgrf.h:80
@ RailTypes
Rail types feature.
Definition newgrf.h:97
@ Stations
Stations feature.
Definition newgrf.h:85
Functions related to NewGRF badges.
int DrawBadgeNameList(Rect r, std::span< const BadgeID > badges, GrfSpecFeature)
Draw names for a list of badge labels.
GUI 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.
@ Any
Use first found.
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.
static constexpr StationClassID STAT_CLASS_DFLT
Default station class.
PoolID< uint16_t, struct StationClassIDTag, UINT16_MAX, UINT16_MAX > StationClassID
Class IDs for stations.
static constexpr StationClassID STAT_CLASS_WAYP
Waypoint class.
@ Normal
Playing a game.
Definition openttd.h:20
@ Menu
In the main menu.
Definition openttd.h:19
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:137
bool HasRailTypeAvail(const CompanyID company, const RailType railtype)
Finds out if a company has a certain buildable railtype available.
Definition rail.cpp:70
RailTypes GetRailTypes(bool introduces)
Get list of rail types, regardless of company availability.
Definition rail.cpp:168
bool ValParamRailType(const RailType rail)
Validate functions for rail building.
Definition rail.cpp:92
void DrawTrainDepotSprite(int x, int y, DiagDirection dir, RailType railtype)
Draw train depot sprite in the UI.
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition rail.h:431
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:303
Command definitions for rail.
static constexpr std::initializer_list< NWidgetPart > _nested_signal_builder_widgets
Nested widget definition of the build signal window.
Window * ShowBuildRailToolbar(RailType railtype)
Open the build rail toolbar window for a specific rail type.
Definition rail_gui.cpp:963
static constexpr std::array< DiagDirectionIndexArray< DiagDirection >, 3 > _place_depot_extra_dir
Direction to check for existing track pieces.
Definition rail_gui.cpp:139
static bool RailToolbar_CtrlChanged(Window *w)
Updates the Remove button because of Ctrl state change.
Definition rail_gui.cpp:340
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:170
static RailType _cur_railtype
Rail type of the current build-rail toolbar.
Definition rail_gui.cpp:57
static WindowDesc _station_builder_desc(WindowPosition::Automatic, "build_station_rail", 0, 0, WindowClass::BuildStation, WindowClass::BuildToolbar, WindowDefaultFlag::Construction, _nested_station_builder_widgets, &BuildRailStationWindow::hotkeys)
High level window description of the station-build window (default & newGRF).
static WindowDesc _build_rail_desc(WindowPosition::Manual, "toolbar_rail", 0, 0, WindowClass::BuildToolbar, WindowClass::None, WindowDefaultFlag::Construction, _nested_build_rail_widgets, &BuildRailToolbarWindow::hotkeys)
Window definition for the rail toolbar.
static void HandleAutoSignalPlacement()
Build new signals or remove signals or (if only one tile marked) edit a signal.
Definition rail_gui.cpp:419
static SignalVariant _cur_signal_variant
set the signal variant (for signal GUI)
Definition rail_gui.cpp:61
static WindowDesc _build_depot_desc(WindowPosition::Automatic, {}, 0, 0, WindowClass::BuildDepot, WindowClass::BuildToolbar, WindowDefaultFlag::Construction, _nested_build_depot_widgets)
Window definition for the build rail depot window.
void SetDefaultRailGui()
Set the initial (default) railtype to use.
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:122
static void PlaceRail_Bridge(TileIndex tile, Window *w)
Start placing a rail bridge.
Definition rail_gui.cpp:296
static const IntervalTimer< TimerGameCalendar > _check_reset_signal
Yearly time to check whether to set the signal variant to electric signals.
static void PlaceRail_Station(TileIndex tile)
Place a rail station.
Definition rail_gui.cpp:202
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:326
DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
Create a drop down list for all the rail types of the local company.
void CcBuildRailTunnel(Commands, const CommandCost &result, TileIndex tile)
Command callback for building a tunnel.
Definition rail_gui.cpp:312
static void BuildRailClick_Remove(Window *w)
The "remove"-button click proc of the build-rail toolbar.
Definition rail_gui.cpp:361
static constexpr std::array< DiagDirectionIndexArray< Track >, 3 > _place_depot_extra_track
Additional pieces of track to add at the entrance of a depot.
Definition rail_gui.cpp:132
static constexpr std::initializer_list< NWidgetPart > _nested_build_depot_widgets
Nested widget definition of the build rail depot window.
static bool IsStationAvailable(const StationSpec *statspec)
Check whether a station type can be build.
Definition rail_gui.cpp:89
static WindowDesc _signal_builder_desc(WindowPosition::Automatic, {}, 0, 0, WindowClass::BuildSignal, WindowClass::BuildToolbar, WindowDefaultFlag::Construction, _nested_signal_builder_widgets)
Signal selection window description.
static Window * ShowStationBuilder(Window *parent)
Open station build window.
static bool StationUsesDefaultType(const BaseStation *bst)
Test if a station/waypoint uses the default graphics.
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 WindowDesc _build_waypoint_desc(WindowPosition::Automatic, "build_waypoint", 0, 0, WindowClass::BuildWaypoint, WindowClass::BuildToolbar, WindowDefaultFlag::Construction, _nested_build_waypoint_widgets, &BuildRailWaypointWindow::hotkeys)
Window definition for the build rail waypoint window.
static constexpr std::initializer_list< NWidgetPart > _nested_build_waypoint_widgets
Nested widget definition for the build NewGRF rail waypoint 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.
void InitializeSignalGui()
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:238
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:26
@ SIGNAL_CYCLE_ALL
Cycle through all signals visible to the player.
Definition rail_gui.h:32
static 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
static bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
@ Depot
Depot (one entrance).
Definition rail_map.h:26
@ Signals
Normal rail tile with signals.
Definition rail_map.h:25
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:474
SignalType GetSignalType(Tile t, Track track)
Get the signal type for a track on a tile.
Definition rail_map.h:303
static bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition rail_map.h:105
EnumBitSet< RailType, uint64_t > RailTypes
Bitset of RailType elements.
Definition rail_type.h:36
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:57
@ WID_BRAS_PLATFORM_NUM_4
Button to select stations with 4 platforms.
Definition rail_widget.h:42
@ WID_BRAS_PLATFORM_NUM_7
Button to select stations with 7 platforms.
Definition rail_widget.h:45
@ WID_BRAS_PLATFORM_DIR_X
Button to select '/' view.
Definition rail_widget.h:36
@ WID_BRAS_PLATFORM_LEN_BEGIN
Helper for determining the chosen platform length.
Definition rail_widget.h:62
@ WID_BRAS_PLATFORM_LEN_3
Button to select 3 tiles length station platforms.
Definition rail_widget.h:49
@ WID_BRAS_PLATFORM_DIR_Y
Button to select '\' view.
Definition rail_widget.h:37
@ WID_BRAS_PLATFORM_LEN_6
Button to select 6 tiles length station platforms.
Definition rail_widget.h:52
@ WID_BRAS_PLATFORM_NUM_1
Button to select stations with a single platform.
Definition rail_widget.h:39
@ WID_BRAS_PLATFORM_NUM_BEGIN
Helper for determining the chosen platform width.
Definition rail_widget.h:61
@ WID_BRAS_PLATFORM_NUM_3
Button to select stations with 3 platforms.
Definition rail_widget.h:41
@ WID_BRAS_PLATFORM_LEN_5
Button to select 5 tiles length station platforms.
Definition rail_widget.h:51
@ WID_BRAS_PLATFORM_NUM_5
Button to select stations with 5 platforms.
Definition rail_widget.h:43
@ WID_BRAS_COVERAGE_TEXTS
Empty space for the coverage texts.
Definition rail_widget.h:59
@ WID_BRAS_PLATFORM_LEN_1
Button to select single tile length station platforms.
Definition rail_widget.h:47
@ WID_BRAS_HIGHLIGHT_ON
Button for turning coverage highlighting on.
Definition rail_widget.h:58
@ WID_BRAS_PLATFORM_DRAG_N_DROP
Button to enable drag and drop type station placement.
Definition rail_widget.h:55
@ WID_BRAS_PLATFORM_LEN_7
Button to select 7 tiles length station platforms.
Definition rail_widget.h:53
@ WID_BRAS_PLATFORM_NUM_6
Button to select stations with 6 platforms.
Definition rail_widget.h:44
@ WID_BRAS_PLATFORM_NUM_2
Button to select stations with 2 platforms.
Definition rail_widget.h:40
@ WID_BRAS_PLATFORM_LEN_4
Button to select 4 tiles length station platforms.
Definition rail_widget.h:50
@ WID_BRAS_PLATFORM_LEN_2
Button to select 2 tiles length station platforms.
Definition rail_widget.h:48
@ WID_BRAD_DEPOT_SE
Build a depot with the entrance in the south east.
Definition rail_widget.h:92
@ WID_BRAD_DEPOT_NE
Build a depot with the entrance in the north east.
Definition rail_widget.h:91
@ WID_BRAD_DEPOT_SW
Build a depot with the entrance in the south west.
Definition rail_widget.h:93
@ WID_BRAD_DEPOT_NW
Build a depot with the entrance in the north west.
Definition rail_widget.h:94
@ WID_BS_DRAG_SIGNALS_DENSITY_DECREASE
Decrease the signal density.
Definition rail_widget.h:82
@ WID_BS_ELECTRIC_PBS
Build an electric path signal.
Definition rail_widget.h:78
@ WID_BS_SEMAPHORE_NORM
Build a semaphore normal block signal.
Definition rail_widget.h:68
@ WID_BS_ELECTRIC_NORM
Build an electric normal block signal.
Definition rail_widget.h:74
@ WID_BS_ELECTRIC_EXIT
Build an electric exit block signal.
Definition rail_widget.h:76
@ WID_BS_ELECTRIC_ENTRY
Build an electric entry block signal.
Definition rail_widget.h:75
@ WID_BS_SEMAPHORE_ENTRY
Build a semaphore entry block signal.
Definition rail_widget.h:69
@ WID_BS_BLOCK_SEL
Container for the block signal group, which can be hidden.
Definition rail_widget.h:84
@ WID_BS_CAPTION
Caption for the Signal Selection window.
Definition rail_widget.h:67
@ WID_BS_SEMAPHORE_COMBO
Build a semaphore combo block signal.
Definition rail_widget.h:71
@ WID_BS_BLOCK_SPACER_SEL
Container for the spacer between block and path signal groups, which can be hidden.
Definition rail_widget.h:85
@ WID_BS_SEMAPHORE_PBS
Build a semaphore path signal.
Definition rail_widget.h:72
@ WID_BS_DRAG_SIGNALS_DENSITY_LABEL
The current signal density.
Definition rail_widget.h:81
@ WID_BS_SEMAPHORE_EXIT
Build a semaphore exit block signal.
Definition rail_widget.h:70
@ WID_BS_SEMAPHORE_PBS_OWAY
Build a semaphore one way path signal.
Definition rail_widget.h:73
@ WID_BS_DRAG_SIGNALS_DENSITY_INCREASE
Increase the signal density.
Definition rail_widget.h:83
@ WID_BS_CONVERT
Convert the signal.
Definition rail_widget.h:80
@ WID_BS_ELECTRIC_COMBO
Build an electric combo block signal.
Definition rail_widget.h:77
@ WID_BS_ELECTRIC_PBS_OWAY
Build an electric one way path signal.
Definition rail_widget.h:79
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
@ Invalid
Invalid marker.
Definition road_type.h:41
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
@ LastAvailable
Use the latest available to the player.
@ FirstAvailable
Use the first available to the player.
@ MostUsed
Use the most used by the company controlled by the player.
SignalType
Type of signal, i.e.
Definition signal_type.h:24
@ End
End marker.
Definition signal_type.h:31
@ Path
normal path signal.
Definition signal_type.h:29
@ PathOneWay
no-entry path signal.
Definition signal_type.h:30
@ Combo
presignal inter-block.
Definition signal_type.h:28
@ Block
block signal.
Definition signal_type.h:25
SignalState
These are states in which a signal can be.
Definition signal_type.h:40
@ Green
The signal is green.
Definition signal_type.h:42
@ Red
The signal is red.
Definition signal_type.h:41
SignalVariant
Variant of the signal, i.e.
Definition signal_type.h:16
@ Electric
Light signal.
Definition signal_type.h:17
@ Semaphore
Old-fashioned semaphore signal.
Definition signal_type.h:18
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Definition sound.cpp:254
Functions related to sound.
@ SND_20_CONSTRUCTION_RAIL
30 == 0x1E Construction: rail infrastructure
Definition sound_type.h:78
static const CursorID ANIMCURSOR_BUILDSIGNALS
1292 - 1293 - build signal
Definition sprites.h:1526
static const CursorID ANIMCURSOR_DEMOLISH
704 - 707 - demolish dynamite
Definition sprites.h:1522
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.
uint GetCustomStationSpecIndex(Tile t)
Get the custom station spec for this tile.
bool HasStationRail(Tile t)
Has this station tile a rail?
static constexpr uint CA_TRAIN
Catchment for train stations with "modified catchment" enabled.
@ Rail
Railways/train station.
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:90
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
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 SetSelectedSize()
Set the build station tile highlight to current station size.
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:444
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:828
RailType railtype
Rail type to build.
Definition rail_gui.cpp:445
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition rail_gui.cpp:841
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition rail_gui.cpp:474
WidgetID last_user_action
Last started user action.
Definition rail_gui.cpp:446
void ModifyRailType(RailType railtype)
Switch to another rail type.
Definition rail_gui.cpp:524
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition rail_gui.cpp:506
bool OnTooltip(Point pt, WidgetID widget, TooltipCloseCondition close_cond) override
Event to display a custom tooltip.
Definition rail_gui.cpp:495
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:624
EventState OnCTRLStateChange() override
The state of the control key has changed.
Definition rail_gui.cpp:834
CursorID GetCursorForWidget(WidgetID widget)
Returns corresponding cursor for provided button.
Definition rail_gui.cpp:578
EventState ChangeRailTypeOnHotkey(int hotkey)
Selects new RailType based on SpecialHotkeys and order defined in _sorted_railtypes.
Definition rail_gui.cpp:851
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
Definition rail_gui.cpp:560
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
Definition rail_gui.cpp:811
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:736
static EventState RailToolbarGlobalHotkeys(int hotkey)
Handler for global hotkeys of the BuildRailToolbarWindow.
Definition rail_gui.cpp:874
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:677
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:749
static const std::initializer_list< WidgetID > can_build_widgets
List of widgets to be disabled if infrastructure limit prevents building.
Definition rail_gui.cpp:468
Point OnInitialPosition(int16_t sm_width, int16_t sm_height, int window_number) override
Compute the initial position of the window.
Definition rail_gui.cpp:744
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
Definition rail_gui.cpp:670
HighLightStyle GetHighLightStyleForWidget(WidgetID widget)
Returns corresponding high light style for provided button.
Definition rail_gui.cpp:603
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:458
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.
std::array< uint32_t, RAILTYPE_END > rail
Count of company owned track bits for each rail type.
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
RailTypes avail_railtypes
Rail types available to this company.
T y
Y coordinate.
T x
X coordinate.
Dimensions (a width and height) of a rectangle in 2D.
Data about how and where to blit pixels.
Definition gfx_type.h:157
const struct GRFFile * grffile
grf file that introduced this entity
List of hotkeys for a window.
Definition hotkeys.h:46
All data for a single hotkey.
Definition hotkeys.h:22
uint16_t w
The width of the area.
TileIndex tile
The base tile of the area.
uint16_t h
The height of the area.
static Company * Get(auto index)
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.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
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
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.
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:172
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:984
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1109
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1814
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:786
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing).
Definition window.cpp:3255
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:562
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:510
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:1804
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:536
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:562
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:849
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1838
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:989
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:1828
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:576
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
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:302
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.
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
@ Railway
A tile with railway.
Definition tile_type.h:50
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)
Prepare state for highlighting tiles while dragging with the mouse.
HighLightStyle
Highlighting draw styles.
@ 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.
RailType _last_built_railtype
The most recently used type of rail.
Stuff related to the (main) toolbar.
bool IsValidTrack(Track track)
Checks if a Track is valid.
Definition track_func.h:24
Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or Track::Invalid.
Definition track_func.h:150
TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:468
TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition track_func.h:281
static constexpr TrackBits TRACK_BIT_HORZ
Upper and lower track.
Definition track_type.h:46
EnumBitSet< Track, uint8_t > TrackBits
Bitset of Track elements.
Definition track_type.h:43
static constexpr TrackBits TRACK_BIT_VERT
Left and right track.
Definition track_type.h:47
Track
These are used to specify a single track.
Definition track_type.h:19
@ X
Track along the x-axis (north-east to south-west).
Definition track_type.h:21
@ Upper
Track in the upper corner of the tile (north).
Definition track_type.h:23
@ Y
Track along the y-axis (north-west to south-east).
Definition track_type.h:22
@ Right
Track in the right corner of the tile (east).
Definition track_type.h:26
@ Left
Track in the left corner of the tile (west).
Definition track_type.h:25
@ Lower
Track in the lower corner of the tile (south).
Definition track_type.h:24
@ 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.
TileIndex GetOtherTunnelBridgeEnd(Tile t)
Determines type of the wormhole and returns its other end.
bool CanBuildVehicleInfrastructure(VehicleType type, RoadTramType subtype)
Check whether we can build infrastructure for the given vehicle type.
Definition vehicle.cpp:1948
Functions related to vehicles.
@ 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:41
@ WWT_PUSHARROWBTN
Normal push-button (no toggle button) with arrow caption.
@ WWT_LABEL
Centered label.
Definition widget_type.h:48
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ WWT_TEXTBTN
(Toggle) Button with text
Definition widget_type.h:44
@ WWT_PANEL
Simple depressed panel.
Definition widget_type.h:39
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX).
Definition widget_type.h:57
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX).
Definition widget_type.h:55
@ WWT_CAPTION
Window caption (window title between closebox and stickybox).
Definition widget_type.h:52
@ NWID_VERTICAL
Vertical container.
Definition widget_type.h:68
@ WWT_CLOSEBOX
Close box (at top-left of a window).
Definition widget_type.h:60
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition widget_type.h:37
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX).
Definition widget_type.h:56
@ NWID_HORIZONTAL_LTR
Horizontal container that doesn't change the order of the widgets for RTL languages.
Definition widget_type.h:67
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ SZSP_NONE
Display plane with zero size in both directions (none filling and resizing).
@ EqualSize
Containers should keep all their (resizing) children equally large.
@ Decrease
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:20
@ Increase
Arrow to the right or in case of RTL to the left.
Definition widget_type.h:21
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:1201
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1214
Point AlignInitialConstructionToolbar(int window_width)
Compute the position of the construction toolbars.
Definition window.cpp:1707
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1158
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3193
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.
Definition window_gui.h:155
TooltipCloseCondition
Definition window_gui.h:263
@ Automatic
Find a place automatically.
Definition window_gui.h:146
@ Manual
Manually align the window (so no automatic location finding).
Definition window_gui.h:145
int WidgetID
Widget ID.
Definition window_type.h:21
EventState
State of handling an event.
@ Handled
The passed event is handled.
@ NotHandled
The passed event is not handled.
static constexpr WidgetID INVALID_WIDGET
An invalid widget index.
Definition window_type.h:24
Functions related to zooming.
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107