OpenTTD Source 20260311-master-g511d3794ce
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) & DiagdirReachesTracks(dir)) == 0) return;
127
128 Command<Commands::BuildRail>::Post(tile, _cur_railtype, track, _settings_client.gui.auto_remove_signals);
129}
130
132static const Track _place_depot_extra_track[12] = {
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
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[dir + 4], _place_depot_extra_track[dir + 4]);
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) 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 & TRACK_BIT_VERT) { // N-S direction
243 trackbits = (_tile_fract_coords.x <= _tile_fract_coords.y) ? TRACK_BIT_RIGHT : TRACK_BIT_LEFT;
244 }
245
246 if (trackbits & TRACK_BIT_HORZ) { // E-W direction
247 trackbits = (_tile_fract_coords.x + _tile_fract_coords.y <= 15) ? TRACK_BIT_UPPER : TRACK_BIT_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 ? SIGTYPE_BLOCK : SIGTYPE_PBS;
264 cycle_end = SIGTYPE_LAST;
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 <= SIGTYPE_LAST_NOPBS) {
268 /* Block signals only. */
269 cycle_start = SIGTYPE_BLOCK;
270 cycle_end = SIGTYPE_LAST_NOPBS;
271 } else {
272 /* Path signals only. */
273 cycle_start = SIGTYPE_PBS;
274 cycle_end = SIGTYPE_LAST;
275 }
276 }
277
278 if (FindWindowById(WC_BUILD_SIGNAL, 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 {
283 SignalVariant sigvar = TimerGameCalendar::year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC;
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 == 0) 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 = (Track)GB(_thd.drawstyle, 0, 3); // 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(WC_BUILD_SIGNAL, 0) != nullptr;
435 SignalType sigtype = sig_gui ? _cur_signal_type : _settings_client.gui.default_signal_type;
436 SignalVariant sigvar = sig_gui ? _cur_signal_variant : (TimerGameCalendar::year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC);
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(WC_SCEN_LAND_GEN, 0, false);
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) {
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, VEH_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);
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 */
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();
756 ShowBuildBridgeWindow(start_tile, end_tile, TRANSPORT_RAIL, _cur_railtype);
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
827
828 void OnPlacePresize([[maybe_unused]] Point pt, TileIndex tile) override
829 {
830 Command<Commands::BuildTunnel>::Do(DoCommandFlag::Auto, tile, TRANSPORT_RAIL, _cur_railtype);
832 }
833
835 {
836 /* do not toggle Remove button by Ctrl when placing station */
838 return ES_NOT_HANDLED;
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);
865
866 return ES_HANDLED;
867 }
868
875 {
876 if (_game_mode != GM_NORMAL) return ES_NOT_HANDLED;
878 if (w == nullptr) return ES_NOT_HANDLED;
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 = {
906 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
907 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_RAT_CAPTION), SetTextStyle(TC_WHITE),
908 NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
909 EndContainer(),
911 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_NS),
912 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
913 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_X),
914 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
915 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_EW),
916 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_EW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
917 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_Y),
918 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_NW, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TRACK),
919 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_AUTORAIL),
920 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_AUTORAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_AUTORAIL),
921
923
924 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_DEMOLISH),
925 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
926 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_DEPOT),
927 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_DEPOT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_TRAIN_DEPOT_FOR_BUILDING),
928 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_WAYPOINT),
929 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_WAYPOINT, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL_TO_WAYPOINT),
930 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_STATION),
931 SetFill(0, 1), SetToolbarMinimalSize(2), SetSpriteTip(SPR_IMG_RAIL_STATION, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_STATION),
932 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_SIGNALS),
933 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_RAIL_SIGNALS, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_SIGNALS),
934 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_BRIDGE),
935 SetFill(0, 1), SetToolbarMinimalSize(2), SetSpriteTip(SPR_IMG_BRIDGE, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_BRIDGE),
936 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_BUILD_TUNNEL),
937 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_TUNNEL_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_BUILD_RAILROAD_TUNNEL),
938 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_REMOVE),
939 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_REMOVE, STR_RAIL_TOOLBAR_TOOLTIP_TOGGLE_BUILD_REMOVE_FOR),
940 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_RAT_CONVERT_RAIL),
941 SetFill(0, 1), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_CONVERT_RAIL, STR_RAIL_TOOLBAR_TOOLTIP_CONVERT_RAIL),
942 EndContainer(),
943};
944
945static WindowDesc _build_rail_desc(
946 WDP_MANUAL, "toolbar_rail", 0, 0,
949 _nested_build_rail_widgets,
950 &BuildRailToolbarWindow::hotkeys
951);
952
953
963{
964 if (!Company::IsValidID(_local_company)) return nullptr;
965 if (!ValParamRailType(railtype)) return nullptr;
966
968 _cur_railtype = railtype;
970 return new BuildRailToolbarWindow(_build_rail_desc, railtype);
971}
972
973/* TODO: For custom stations, respect their allowed platforms/lengths bitmasks!
974 * --pasky */
975
976static void HandleStationPlacement(TileIndex start, TileIndex end)
977{
978 TileArea ta(start, end);
979 uint numtracks = ta.w;
980 uint platlength = ta.h;
981
982 if (_station_gui.axis == AXIS_X) std::swap(numtracks, platlength);
983
986 bool adjacent = _ctrl_pressed;
987
988 auto proc = [=](bool test, StationID to_join) -> bool {
989 if (test) {
990 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();
991 } else {
992 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);
993 }
994 };
995
997}
998
1005{
1006 for (TileIndex t : bst->train_station) {
1007 if (bst->TileBelongsToRailStation(t) && HasStationRail(t) && GetCustomStationSpecIndex(t) == 0) return true;
1008 }
1009 return false;
1010}
1011
1012class StationPickerCallbacks : public PickerCallbacksNewGRFClass<StationClass> {
1013public:
1014 StationPickerCallbacks() : PickerCallbacksNewGRFClass<StationClass>("fav_stations") {}
1015
1016 GrfSpecFeature GetFeature() const override { return GSF_STATIONS; }
1017
1018 StringID GetClassTooltip() const override { return STR_PICKER_STATION_CLASS_TOOLTIP; }
1019 StringID GetTypeTooltip() const override { return STR_PICKER_STATION_TYPE_TOOLTIP; }
1020 StringID GetCollectionTooltip() const override { return STR_PICKER_STATION_COLLECTION_TOOLTIP; }
1021
1022 bool IsActive() const override
1023 {
1024 for (const auto &cls : StationClass::Classes()) {
1025 if (IsWaypointClass(cls)) continue;
1026 for (const auto *spec : cls.Specs()) {
1027 if (spec != nullptr) return true;
1028 }
1029 }
1030 return false;
1031 }
1032
1033 bool HasClassChoice() const override
1034 {
1035 return std::ranges::count_if(StationClass::Classes(), [](const auto &cls) { return !IsWaypointClass(cls); }) > 1;
1036 }
1037
1038 int GetSelectedClass() const override { return _station_gui.sel_class.base(); }
1039 void SetSelectedClass(int id) const override { _station_gui.sel_class = this->GetClassIndex(id); }
1040
1041 StringID GetClassName(int id) const override
1042 {
1043 const auto *sc = GetClass(id);
1044 if (IsWaypointClass(*sc)) return INVALID_STRING_ID;
1045 return sc->name;
1046 }
1047
1048 int GetSelectedType() const override { return _station_gui.sel_type; }
1049 void SetSelectedType(int id) const override { _station_gui.sel_type = id; }
1050
1051 StringID GetTypeName(int cls_id, int id) const override
1052 {
1053 const auto *spec = this->GetSpec(cls_id, id);
1054 return (spec == nullptr) ? STR_STATION_CLASS_DFLT_STATION : spec->name;
1055 }
1056
1057 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1058 {
1059 const auto *spec = this->GetSpec(cls_id, id);
1060 if (spec == nullptr) return {};
1061 return spec->badges;
1062 }
1063
1064 bool IsTypeAvailable(int cls_id, int id) const override
1065 {
1066 return IsStationAvailable(this->GetSpec(cls_id, id));
1067 }
1068
1069 void DrawType(int x, int y, int cls_id, int id) const override
1070 {
1071 if (!DrawStationTile(x, y, _cur_railtype, _station_gui.axis, this->GetClassIndex(cls_id), id)) {
1072 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2 + _station_gui.axis);
1073 }
1074 }
1075
1076 void FillUsedItems(std::set<PickerItem> &items) override
1077 {
1078 bool default_added = false;
1079 for (const Station *st : Station::Iterate()) {
1080 if (st->owner != _local_company) continue;
1081 if (!default_added && StationUsesDefaultType(st)) {
1082 items.insert({0, 0, STAT_CLASS_DFLT.base(), 0});
1083 default_added = true;
1084 }
1085 for (const auto &sm : st->speclist) {
1086 if (sm.spec == nullptr) continue;
1087 items.insert({sm.grfid, sm.localidx, sm.spec->class_index.base(), sm.spec->index});
1088 }
1089 }
1090 }
1091
1092 static StationPickerCallbacks instance;
1093};
1094/* static */ StationPickerCallbacks StationPickerCallbacks::instance;
1095
1096struct BuildRailStationWindow : public PickerWindow {
1097private:
1099
1105 void CheckSelectedSize(const StationSpec *statspec)
1106 {
1107 if (statspec == nullptr || _settings_client.gui.station_dragdrop) return;
1108
1109 /* If current number of tracks is not allowed, make it as big as possible */
1110 if (HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1111 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1112 _settings_client.gui.station_numtracks = 1;
1113 if (statspec->disallowed_platforms != UINT8_MAX) {
1114 while (HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1115 _settings_client.gui.station_numtracks++;
1116 }
1117 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1118 }
1119 }
1120
1121 if (HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1122 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1123 _settings_client.gui.station_platlength = 1;
1124 if (statspec->disallowed_lengths != UINT8_MAX) {
1125 while (HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1126 _settings_client.gui.station_platlength++;
1127 }
1128 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1129 }
1130 }
1131 }
1132
1133public:
1135 {
1136 this->coverage_height = 2 * GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal;
1137 this->ConstructWindow();
1138 }
1139
1140 void OnInit() override
1141 {
1143 if (_settings_client.gui.station_dragdrop) {
1145 } else {
1146 this->LowerWidget(WID_BRAS_PLATFORM_NUM_BEGIN + _settings_client.gui.station_numtracks);
1147 this->LowerWidget(WID_BRAS_PLATFORM_LEN_BEGIN + _settings_client.gui.station_platlength);
1148 }
1149 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_OFF, !_settings_client.gui.station_show_coverage);
1150 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_ON, _settings_client.gui.station_show_coverage);
1151
1152 this->PickerWindow::OnInit();
1153 }
1154
1155 void Close([[maybe_unused]] int data = 0) override
1156 {
1158 this->PickerWindow::Close();
1159 }
1160
1161 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1162 {
1163 if (gui_scope) {
1164 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1165 this->CheckSelectedSize(statspec);
1166 }
1167
1168 this->PickerWindow::OnInvalidateData(data, gui_scope);
1169 }
1170
1171 void OnPaint() override
1172 {
1173 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1174
1175 if (_settings_client.gui.station_dragdrop) {
1176 SetTileSelectSize(1, 1);
1177 } else {
1178 int x = _settings_client.gui.station_numtracks;
1179 int y = _settings_client.gui.station_platlength;
1180 if (_station_gui.axis == AXIS_X) std::swap(x, y);
1182 SetTileSelectSize(x, y);
1183 }
1184 }
1185
1186 int rad = (_settings_game.station.modified_catchment) ? CA_TRAIN : CA_UNMODIFIED;
1187
1188 if (_settings_client.gui.station_show_coverage) SetTileSelectBigSize(-rad, -rad, 2 * rad, 2 * rad);
1189
1190 for (uint bits = 0; bits < 7; bits++) {
1191 bool disable = bits >= _settings_game.station.station_spread;
1192 if (statspec == nullptr) {
1193 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, disable);
1194 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, disable);
1195 } else {
1196 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_NUM_1, HasBit(statspec->disallowed_platforms, bits) || disable);
1197 this->SetWidgetDisabledState(bits + WID_BRAS_PLATFORM_LEN_1, HasBit(statspec->disallowed_lengths, bits) || disable);
1198 }
1199 }
1200
1201 this->DrawWidgets();
1202
1203 if (this->IsShaded()) return;
1204 /* 'Accepts' and 'Supplies' texts. */
1205 Rect r = this->GetWidget<NWidgetBase>(WID_BRAS_COVERAGE_TEXTS)->GetCurrentRect();
1206 const int bottom = r.bottom;
1207 r.bottom = INT_MAX; // Allow overflow as we want to know the required height.
1208 if (statspec != nullptr) r.top = DrawBadgeNameList(r, statspec->badges, GSF_STATIONS);
1209 r.top = DrawStationCoverageAreaText(r, SCT_ALL, rad, false) + WidgetDimensions::scaled.vsep_normal;
1210 r.top = DrawStationCoverageAreaText(r, SCT_ALL, rad, true);
1211 /* Resize background if the window is too small.
1212 * Never make the window smaller to avoid oscillating if the size change affects the acceptance.
1213 * (This is the case, if making the window bigger moves the mouse into the window.) */
1214 if (r.top > bottom) {
1215 this->coverage_height += r.top - bottom;
1216 this->ReInit();
1217 }
1218 }
1219
1220 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1221 {
1222 switch (widget) {
1225 size.width = ScaleGUITrad(PREVIEW_WIDTH) + WidgetDimensions::scaled.fullbevel.Horizontal();
1226 size.height = ScaleGUITrad(PREVIEW_HEIGHT) + WidgetDimensions::scaled.fullbevel.Vertical();
1227 break;
1228
1230 size.height = this->coverage_height;
1231 break;
1232
1233 default:
1234 this->PickerWindow::UpdateWidgetSize(widget, size, padding, fill, resize);
1235 break;
1236 }
1237 }
1238
1239 void DrawWidget(const Rect &r, WidgetID widget) const override
1240 {
1241 DrawPixelInfo tmp_dpi;
1242
1243 switch (widget) {
1245 /* Set up a clipping area for the '/' station preview */
1246 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1247 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1248 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1251 if (!DrawStationTile(x, y, _cur_railtype, AXIS_X, _station_gui.sel_class, _station_gui.sel_type)) {
1252 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 2);
1253 }
1254 }
1255 break;
1256 }
1257
1259 /* Set up a clipping area for the '\' station preview */
1260 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1261 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1262 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1265 if (!DrawStationTile(x, y, _cur_railtype, AXIS_Y, _station_gui.sel_class, _station_gui.sel_type)) {
1266 StationPickerDrawSprite(x, y, StationType::Rail, _cur_railtype, INVALID_ROADTYPE, 3);
1267 }
1268 }
1269 break;
1270 }
1271
1272 default:
1273 this->PickerWindow::DrawWidget(r, widget);
1274 break;
1275 }
1276 }
1277
1278 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1279 {
1280 switch (widget) {
1284 _station_gui.axis = (Axis)(widget - WID_BRAS_PLATFORM_DIR_X);
1286 SndClickBeep();
1287 this->SetDirty();
1289 break;
1290
1298 this->RaiseWidget(WID_BRAS_PLATFORM_NUM_BEGIN + _settings_client.gui.station_numtracks);
1300
1301 _settings_client.gui.station_numtracks = widget - WID_BRAS_PLATFORM_NUM_BEGIN;
1302 _settings_client.gui.station_dragdrop = false;
1303
1304 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1305 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1306 /* The previously selected number of platforms in invalid */
1307 for (uint i = 0; i < 7; i++) {
1308 if (!HasBit(statspec->disallowed_lengths, i)) {
1309 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1310 _settings_client.gui.station_platlength = i + 1;
1311 break;
1312 }
1313 }
1314 }
1315
1316 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1317 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1318 SndClickBeep();
1319 this->SetDirty();
1321 break;
1322 }
1323
1331 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1333
1334 _settings_client.gui.station_platlength = widget - WID_BRAS_PLATFORM_LEN_BEGIN;
1335 _settings_client.gui.station_dragdrop = false;
1336
1337 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1338 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1339 /* The previously selected number of tracks in invalid */
1340 for (uint i = 0; i < 7; i++) {
1341 if (!HasBit(statspec->disallowed_platforms, i)) {
1342 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1343 _settings_client.gui.station_numtracks = i + 1;
1344 break;
1345 }
1346 }
1347 }
1348
1349 this->LowerWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1350 this->LowerWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1351 SndClickBeep();
1352 this->SetDirty();
1354 break;
1355 }
1356
1358 _settings_client.gui.station_dragdrop ^= true;
1359
1361
1362 /* get the first allowed length/number of platforms */
1363 const StationSpec *statspec = StationClass::Get(_station_gui.sel_class)->GetSpec(_station_gui.sel_type);
1364 if (statspec != nullptr && HasBit(statspec->disallowed_lengths, _settings_client.gui.station_platlength - 1)) {
1365 for (uint i = 0; i < 7; i++) {
1366 if (!HasBit(statspec->disallowed_lengths, i)) {
1367 this->RaiseWidget(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN);
1368 _settings_client.gui.station_platlength = i + 1;
1369 break;
1370 }
1371 }
1372 }
1373 if (statspec != nullptr && HasBit(statspec->disallowed_platforms, _settings_client.gui.station_numtracks - 1)) {
1374 for (uint i = 0; i < 7; i++) {
1375 if (!HasBit(statspec->disallowed_platforms, i)) {
1376 this->RaiseWidget(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN);
1377 _settings_client.gui.station_numtracks = i + 1;
1378 break;
1379 }
1380 }
1381 }
1382
1383 this->SetWidgetLoweredState(_settings_client.gui.station_numtracks + WID_BRAS_PLATFORM_NUM_BEGIN, !_settings_client.gui.station_dragdrop);
1384 this->SetWidgetLoweredState(_settings_client.gui.station_platlength + WID_BRAS_PLATFORM_LEN_BEGIN, !_settings_client.gui.station_dragdrop);
1385 SndClickBeep();
1386 this->SetDirty();
1388 break;
1389 }
1390
1393 _settings_client.gui.station_show_coverage = (widget != WID_BRAS_HIGHLIGHT_OFF);
1394
1395 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_OFF, !_settings_client.gui.station_show_coverage);
1396 this->SetWidgetLoweredState(WID_BRAS_HIGHLIGHT_ON, _settings_client.gui.station_show_coverage);
1397 SndClickBeep();
1398 this->SetDirty();
1399 SetViewportCatchmentStation(nullptr, true);
1400 break;
1401
1402 default:
1403 this->PickerWindow::OnClick(pt, widget, click_count);
1404 break;
1405 }
1406 }
1407
1408 void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
1409 {
1411 }
1412
1419 {
1420 if (_game_mode == GM_MENU) return ES_NOT_HANDLED;
1422 if (w == nullptr) return ES_NOT_HANDLED;
1423 return w->OnHotkey(hotkey);
1424 }
1425
1426 static inline HotkeyList hotkeys{"buildrailstation", {
1427 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1429};
1430
1431static constexpr std::initializer_list<NWidgetPart> _nested_station_builder_widgets = {
1433 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1434 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_STATION_BUILD_RAIL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1435 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
1436 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
1437 EndContainer(),
1441 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
1443 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_ORIENTATION),
1445 NWidget(WWT_PANEL, COLOUR_GREY, WID_BRAS_PLATFORM_DIR_X), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1446 NWidget(WWT_PANEL, COLOUR_GREY, WID_BRAS_PLATFORM_DIR_Y), SetFill(0, 0), SetToolTip(STR_STATION_BUILD_RAILROAD_ORIENTATION_TOOLTIP), EndContainer(),
1447 EndContainer(),
1448 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_NUMBER_OF_TRACKS),
1450 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1451 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1452 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1453 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1454 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1455 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1456 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_NUM_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_NUMBER_OF_TRACKS_TOOLTIP),
1457 EndContainer(),
1458 NWidget(WWT_LABEL, INVALID_COLOUR), SetMinimalSize(144, 11), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_PLATFORM_LENGTH),
1460 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_1), SetAspect(1.25f), SetStringTip(STR_BLACK_1, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1461 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_2), SetAspect(1.25f), SetStringTip(STR_BLACK_2, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1462 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_3), SetAspect(1.25f), SetStringTip(STR_BLACK_3, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1463 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_4), SetAspect(1.25f), SetStringTip(STR_BLACK_4, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1464 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_5), SetAspect(1.25f), SetStringTip(STR_BLACK_5, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1465 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_6), SetAspect(1.25f), SetStringTip(STR_BLACK_6, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1466 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_LEN_7), SetAspect(1.25f), SetStringTip(STR_BLACK_7, STR_STATION_BUILD_PLATFORM_LENGTH_TOOLTIP),
1467 EndContainer(),
1469 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_PLATFORM_DRAG_N_DROP), SetMinimalSize(75, 12), SetStringTip(STR_STATION_BUILD_DRAG_DROP, STR_STATION_BUILD_DRAG_DROP_TOOLTIP),
1470 EndContainer(),
1471 NWidget(WWT_LABEL, INVALID_COLOUR), SetStringTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE), SetFill(1, 0),
1473 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_HIGHLIGHT_OFF), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
1474 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAS_HIGHLIGHT_ON), SetMinimalSize(60, 12), SetStringTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
1475 EndContainer(),
1476 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_BRAS_COVERAGE_TEXTS), SetFill(1, 1), SetResize(1, 0), SetMinimalTextLines(2, 0),
1477 EndContainer(),
1478 EndContainer(),
1479 EndContainer(),
1481 EndContainer(),
1482};
1483
1486 WDP_AUTO, "build_station_rail", 0, 0,
1489 _nested_station_builder_widgets,
1490 &BuildRailStationWindow::hotkeys
1491);
1492
1499{
1501}
1502
1503struct BuildSignalWindow : public PickerWindowBase {
1504private:
1507
1513 void DrawSignalSprite(const Rect &r, SpriteID image) const
1514 {
1515 Point offset;
1516 Dimension sprite_size = GetSpriteSize(image, &offset);
1517 Rect ir = r.Shrink(WidgetDimensions::scaled.imgbtn);
1518 int x = CentreBounds(ir.left, ir.right, sprite_size.width - offset.x) - offset.x; // centered
1519 int y = ir.top - sig_sprite_bottom_offset +
1520 (ir.Height() + sig_sprite_size.height) / 2; // aligned to bottom
1521
1522 DrawSprite(image, PAL_NONE, x, y);
1523 }
1524
1527 {
1528 bool show_non_path_signals = (_settings_client.gui.signal_gui_mode == SIGNAL_GUI_ALL);
1529
1530 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1531 this->GetWidget<NWidgetStacked>(WID_BS_BLOCK_SPACER_SEL)->SetDisplayedPlane(show_non_path_signals ? 0 : SZSP_NONE);
1532 }
1533
1534public:
1536 {
1537 this->CreateNestedTree();
1538 this->SetSignalUIMode();
1540 this->OnInvalidateData();
1541 }
1542
1543 void Close([[maybe_unused]] int data = 0) override
1544 {
1545 _convert_signal_button = false;
1547 }
1548
1549 void OnInit() override
1550 {
1551 /* Calculate maximum signal sprite size. */
1552 this->sig_sprite_size.width = 0;
1553 this->sig_sprite_size.height = 0;
1554 this->sig_sprite_bottom_offset = 0;
1556 for (uint type = SIGTYPE_BLOCK; type < SIGTYPE_END; type++) {
1557 for (uint variant = SIG_ELECTRIC; variant <= SIG_SEMAPHORE; variant++) {
1558 for (uint lowered = 0; lowered < 2; lowered++) {
1559 Point offset;
1560 Dimension sprite_size = GetSpriteSize(rti->gui_sprites.signals[type][variant][lowered], &offset);
1561 this->sig_sprite_bottom_offset = std::max<int>(this->sig_sprite_bottom_offset, sprite_size.height);
1562 this->sig_sprite_size.width = std::max<int>(this->sig_sprite_size.width, sprite_size.width - offset.x);
1563 this->sig_sprite_size.height = std::max<int>(this->sig_sprite_size.height, sprite_size.height - offset.y);
1564 }
1565 }
1566 }
1567 }
1568
1569 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1570 {
1571 if (widget == WID_BS_DRAG_SIGNALS_DENSITY_LABEL) {
1572 /* Two digits for signals density. */
1573 size.width = std::max(size.width, 2 * GetDigitWidth() + padding.width + WidgetDimensions::scaled.framerect.Horizontal());
1575 size.width = std::max(size.width, this->sig_sprite_size.width + padding.width);
1576 size.height = std::max(size.height, this->sig_sprite_size.height + padding.height);
1577 }
1578 }
1579
1580 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1581 {
1582 switch (widget) {
1584 return GetString(STR_JUST_INT, _settings_client.gui.drag_signals_density);
1585
1586 default:
1587 return this->Window::GetWidgetString(widget, stringid);
1588 }
1589 }
1590
1591 void DrawWidget(const Rect &r, WidgetID widget) const override
1592 {
1594 /* Extract signal from widget number. */
1595 int type = (widget - WID_BS_SEMAPHORE_NORM) % SIGTYPE_END;
1596 int var = SIG_SEMAPHORE - (widget - WID_BS_SEMAPHORE_NORM) / SIGTYPE_END; // SignalVariant order is reversed compared to the widgets.
1597 SpriteID sprite = GetRailTypeInfo(_cur_railtype)->gui_sprites.signals[type][var][this->IsWidgetLowered(widget)];
1598
1599 this->DrawSignalSprite(r, sprite);
1600 }
1601 }
1602
1603 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1604 {
1605 switch (widget) {
1619
1620 _cur_signal_type = (SignalType)((uint)((widget - WID_BS_SEMAPHORE_NORM) % (SIGTYPE_LAST + 1)));
1622
1623 /* Update default (last-used) signal type in config file. */
1624 _settings_client.gui.default_signal_type = _cur_signal_type;
1625
1626 /* If 'remove' button of rail build toolbar is active, disable it. */
1629 if (w != nullptr) ToggleRailButton_Remove(w);
1630 }
1631
1632 SndClickBeep();
1633 break;
1634
1635 case WID_BS_CONVERT:
1637 SndClickBeep();
1638 break;
1639
1641 if (_settings_client.gui.drag_signals_density > 1) {
1642 _settings_client.gui.drag_signals_density--;
1644 }
1645 break;
1646
1648 if (_settings_client.gui.drag_signals_density < 20) {
1649 _settings_client.gui.drag_signals_density++;
1651 }
1652 break;
1653
1654 default: break;
1655 }
1656
1657 this->InvalidateData();
1658 }
1659
1665 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
1666 {
1667 if (!gui_scope) return;
1669
1671
1674 }
1675};
1676
1678static constexpr std::initializer_list<NWidgetPart> _nested_signal_builder_widgets = {
1679 /* Title bar and buttons. */
1681 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1682 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_BS_CAPTION), SetStringTip(STR_BUILD_SIGNAL_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1683 EndContainer(),
1684
1685 /* Container for both signal groups, spacers, and convert/autofill buttons. */
1687 /* Block signals (can be hidden). */
1688 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_BS_BLOCK_SEL),
1690 /* Semaphore block signals. */
1692 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_NORM), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_NORM_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1693 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_ENTRY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_ENTRY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1694 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_EXIT), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_EXIT_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1695 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_COMBO), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_COMBO_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1696 EndContainer(),
1697 /* Electric block signals. */
1699 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_NORM), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_NORM_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1700 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_ENTRY), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_ENTRY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1701 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_EXIT), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_EXIT_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1702 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_COMBO), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_COMBO_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1703 EndContainer(),
1704 EndContainer(),
1705 EndContainer(),
1706
1707 /* Divider (only shown if block signals visible). */
1709 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetFill(0, 0), SetToolbarSpacerMinimalSize(), EndContainer(),
1710 EndContainer(),
1711
1712 /* Path signals. */
1714 /* Semaphore path signals. */
1716 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_PBS), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_PBS_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1717 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_SEMAPHORE_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_SEMAPHORE_PBS_OWAY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1718 EndContainer(),
1719 /* Electric path signals. */
1721 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_PBS), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_PBS_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1722 NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BS_ELECTRIC_PBS_OWAY), SetToolTip(STR_BUILD_SIGNAL_ELECTRIC_PBS_OWAY_TOOLTIP), SetToolbarMinimalSize(1), EndContainer(),
1723 EndContainer(),
1724 EndContainer(),
1725
1726 /* Convert/autofill buttons. */
1728 NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_BS_CONVERT), SetSpriteTip(SPR_IMG_SIGNAL_CONVERT, STR_BUILD_SIGNAL_CONVERT_TOOLTIP), SetFill(0, 1),
1729 NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetToolTip(STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_TOOLTIP), SetFill(0, 1),
1731 NWidget(WWT_LABEL, INVALID_COLOUR, WID_BS_DRAG_SIGNALS_DENSITY_LABEL), SetToolTip(STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_TOOLTIP), SetTextStyle(TC_ORANGE), SetFill(1, 1),
1733 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_BS_DRAG_SIGNALS_DENSITY_DECREASE), SetMinimalSize(9, 12), SetArrowWidgetTypeTip(AWV_DECREASE, STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_DECREASE_TOOLTIP),
1734 NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_BS_DRAG_SIGNALS_DENSITY_INCREASE), SetMinimalSize(9, 12), SetArrowWidgetTypeTip(AWV_INCREASE, STR_BUILD_SIGNAL_DRAG_SIGNALS_DENSITY_INCREASE_TOOLTIP),
1735 EndContainer(),
1736 EndContainer(),
1737 EndContainer(),
1738 EndContainer(),
1739 EndContainer(),
1740};
1741
1744 WDP_AUTO, {}, 0, 0,
1748);
1749
1754static void ShowSignalBuilder(Window *parent)
1755{
1757}
1758
1759struct BuildRailDepotWindow : public PickerWindowBase {
1760 BuildRailDepotWindow(WindowDesc &desc, Window *parent) : PickerWindowBase(desc, parent)
1761 {
1764 }
1765
1766 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
1767 {
1768 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1769
1770 size.width = ScaleGUITrad(64) + WidgetDimensions::scaled.fullbevel.Horizontal();
1771 size.height = ScaleGUITrad(48) + WidgetDimensions::scaled.fullbevel.Vertical();
1772 }
1773
1774 void DrawWidget(const Rect &r, WidgetID widget) const override
1775 {
1776 if (!IsInsideMM(widget, WID_BRAD_DEPOT_NE, WID_BRAD_DEPOT_NW + 1)) return;
1777
1778 DrawPixelInfo tmp_dpi;
1779 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
1780 if (FillDrawPixelInfo(&tmp_dpi, ir)) {
1781 AutoRestoreBackup dpi_backup(_cur_dpi, &tmp_dpi);
1782 int x = (ir.Width() - ScaleSpriteTrad(64)) / 2 + ScaleSpriteTrad(31);
1783 int y = (ir.Height() + ScaleSpriteTrad(48)) / 2 - ScaleSpriteTrad(31);
1784 DrawTrainDepotSprite(x, y, widget - WID_BRAD_DEPOT_NE + DIAGDIR_NE, _cur_railtype);
1785 }
1786 }
1787
1788 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1789 {
1790 switch (widget) {
1791 case WID_BRAD_DEPOT_NE:
1792 case WID_BRAD_DEPOT_SE:
1793 case WID_BRAD_DEPOT_SW:
1794 case WID_BRAD_DEPOT_NW:
1798 SndClickBeep();
1799 this->SetDirty();
1800 break;
1801 }
1802 }
1803};
1804
1806static constexpr std::initializer_list<NWidgetPart> _nested_build_depot_widgets = {
1808 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1809 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1810 EndContainer(),
1811 NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
1814 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1815 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SW), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1816 EndContainer(),
1818 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_NE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1819 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BRAD_DEPOT_SE), SetToolTip(STR_BUILD_DEPOT_TRAIN_ORIENTATION_TOOLTIP),
1820 EndContainer(),
1821 EndContainer(),
1822 EndContainer(),
1823};
1824
1825static WindowDesc _build_depot_desc(
1826 WDP_AUTO, {}, 0, 0,
1830);
1831
1832static void ShowBuildTrainDepotPicker(Window *parent)
1833{
1834 new BuildRailDepotWindow(_build_depot_desc, parent);
1835}
1836
1837class WaypointPickerCallbacks : public PickerCallbacksNewGRFClass<StationClass> {
1838public:
1839 WaypointPickerCallbacks() : PickerCallbacksNewGRFClass<StationClass>("fav_waypoints") {}
1840
1841 GrfSpecFeature GetFeature() const override { return GSF_STATIONS; }
1842
1843 StringID GetClassTooltip() const override { return STR_PICKER_WAYPOINT_CLASS_TOOLTIP; }
1844 StringID GetTypeTooltip() const override { return STR_PICKER_WAYPOINT_TYPE_TOOLTIP; }
1845 StringID GetCollectionTooltip() const override { return STR_PICKER_WAYPOINT_COLLECTION_TOOLTIP; }
1846
1847 bool IsActive() const override
1848 {
1849 for (const auto &cls : StationClass::Classes()) {
1850 if (!IsWaypointClass(cls)) continue;
1851 for (const auto *spec : cls.Specs()) {
1852 if (spec != nullptr) return true;
1853 }
1854 }
1855 return false;
1856 }
1857
1858 bool HasClassChoice() const override
1859 {
1860 return std::ranges::count_if(StationClass::Classes(), [](const auto &cls) { return IsWaypointClass(cls); }) > 1;
1861 }
1862
1863 void Close(int) override { ResetObjectToPlace(); }
1864 int GetSelectedClass() const override { return _waypoint_gui.sel_class.base(); }
1865 void SetSelectedClass(int id) const override { _waypoint_gui.sel_class = this->GetClassIndex(id); }
1866
1867 StringID GetClassName(int id) const override
1868 {
1869 const auto *sc = GetClass(id);
1870 if (!IsWaypointClass(*sc)) return INVALID_STRING_ID;
1871 return sc->name;
1872 }
1873
1874 int GetSelectedType() const override { return _waypoint_gui.sel_type; }
1875 void SetSelectedType(int id) const override { _waypoint_gui.sel_type = id; }
1876
1877 StringID GetTypeName(int cls_id, int id) const override
1878 {
1879 const auto *spec = this->GetSpec(cls_id, id);
1880 return (spec == nullptr) ? STR_STATION_CLASS_WAYP_WAYPOINT : spec->name;
1881 }
1882
1883 std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const override
1884 {
1885 const auto *spec = this->GetSpec(cls_id, id);
1886 if (spec == nullptr) return {};
1887 return spec->badges;
1888 }
1889
1890 bool IsTypeAvailable(int cls_id, int id) const override
1891 {
1892 return IsStationAvailable(this->GetSpec(cls_id, id));
1893 }
1894
1895 void DrawType(int x, int y, int cls_id, int id) const override
1896 {
1897 DrawWaypointSprite(x, y, this->GetClassIndex(cls_id), id, _cur_railtype);
1898 }
1899
1900 void FillUsedItems(std::set<PickerItem> &items) override
1901 {
1902 bool default_added = false;
1903 for (const Waypoint *wp : Waypoint::Iterate()) {
1904 if (wp->owner != _local_company || HasBit(wp->waypoint_flags, WPF_ROAD)) continue;
1905 if (!default_added && StationUsesDefaultType(wp)) {
1906 items.insert({0, 0, STAT_CLASS_WAYP.base(), 0});
1907 default_added = true;
1908 }
1909 for (const auto &sm : wp->speclist) {
1910 if (sm.spec == nullptr) continue;
1911 items.insert({sm.grfid, sm.localidx, sm.spec->class_index.base(), sm.spec->index});
1912 }
1913 }
1914 }
1915
1916 static WaypointPickerCallbacks instance;
1917};
1918/* static */ WaypointPickerCallbacks WaypointPickerCallbacks::instance;
1919
1920struct BuildRailWaypointWindow : public PickerWindow {
1921 BuildRailWaypointWindow(WindowDesc &desc, Window *parent) : PickerWindow(desc, parent, TRANSPORT_RAIL, WaypointPickerCallbacks::instance)
1922 {
1923 this->ConstructWindow();
1924 }
1925
1926 static inline HotkeyList hotkeys{"buildrailwaypoint", {
1927 Hotkey('F', "focus_filter_box", PCWHK_FOCUS_FILTER_BOX),
1928 }};
1929};
1930
1932static constexpr std::initializer_list<NWidgetPart> _nested_build_waypoint_widgets = {
1934 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
1935 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_WAYPOINT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1936 NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
1937 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
1938 EndContainer(),
1942 EndContainer(),
1943};
1944
1945static WindowDesc _build_waypoint_desc(
1946 WDP_AUTO, "build_waypoint", 0, 0,
1950 &BuildRailWaypointWindow::hotkeys
1951);
1952
1953static void ShowBuildWaypointPicker(Window *parent)
1954{
1955 if (!WaypointPickerCallbacks::instance.IsActive()) return;
1956 new BuildRailWaypointWindow(_build_waypoint_desc, parent);
1957}
1958
1963{
1965 _station_gui.sel_class = STAT_CLASS_DFLT;
1966 _station_gui.sel_type = 0;
1967 _waypoint_gui.sel_class = STAT_CLASS_WAYP;
1968 _waypoint_gui.sel_type = 0;
1969}
1970
1984
1987{
1989
1990 RailType rt;
1991 switch (_settings_client.gui.default_rail_type) {
1992 case 2: {
1993 /* Find the most used rail type */
1994 std::array<uint, RAILTYPE_END> count{};
1995 for (const auto t : Map::Iterate()) {
1998 count[GetRailType(t)]++;
1999 }
2000 }
2001
2002 rt = static_cast<RailType>(std::distance(std::begin(count), std::ranges::max_element(count)));
2003 if (count[rt] > 0) break;
2004
2005 /* No rail, just get the first available one */
2006 [[fallthrough]];
2007 }
2008 case 0: {
2009 /* Use first available type */
2010 std::vector<RailType>::const_iterator it = std::find_if(_sorted_railtypes.begin(), _sorted_railtypes.end(),
2011 [](RailType r) { return HasRailTypeAvail(_local_company, r); });
2012 rt = it != _sorted_railtypes.end() ? *it : RAILTYPE_BEGIN;
2013 break;
2014 }
2015 case 1: {
2016 /* Use last available type */
2017 std::vector<RailType>::const_reverse_iterator it = std::find_if(_sorted_railtypes.rbegin(), _sorted_railtypes.rend(),
2018 [](RailType r){ return HasRailTypeAvail(_local_company, r); });
2019 rt = it != _sorted_railtypes.rend() ? *it : RAILTYPE_BEGIN;
2020 break;
2021 }
2022 default:
2023 NOT_REACHED();
2024 }
2025
2028 if (w != nullptr) w->ModifyRailType(_cur_railtype);
2029}
2030
2036{
2037 SignalVariant new_variant = (TimerGameCalendar::year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC);
2038
2039 if (new_variant != _cur_signal_variant) {
2041 if (w != nullptr) {
2042 w->SetDirty();
2044 }
2045 _cur_signal_variant = new_variant;
2046 }
2047}
2048
2050static const IntervalTimer<TimerGameCalendar> _check_reset_signal{{TimerGameCalendar::Trigger::Year, TimerGameCalendar::Priority::None}, [](auto)
2051{
2052 if (TimerGameCalendar::year != _settings_client.gui.semaphore_build_before) return;
2053
2055}};
2056
2062{
2064
2065 _convert_signal_button = false;
2066 _cur_signal_type = _settings_client.gui.default_signal_type;
2068}
2069
2076DropDownList GetRailTypeDropDownList(bool for_replacement, bool all_option)
2077{
2078 RailTypes used_railtypes;
2079 RailTypes avail_railtypes;
2080
2082
2083 /* Find the used railtypes. */
2084 if (for_replacement) {
2085 avail_railtypes = GetCompanyRailTypes(c->index, false);
2086 used_railtypes = GetRailTypes(false);
2087 } else {
2088 avail_railtypes = c->avail_railtypes;
2089 used_railtypes = GetRailTypes(true);
2090 }
2091
2092 DropDownList list;
2093
2094 if (all_option) {
2095 list.push_back(MakeDropDownListStringItem(STR_REPLACE_ALL_RAILTYPE, INVALID_RAILTYPE));
2096 }
2097
2098 Dimension d = { 0, 0 };
2099 /* Get largest icon size, to ensure text is aligned on each menu item. */
2100 if (!for_replacement) {
2101 used_railtypes.Reset(_railtypes_hidden_mask);
2102 for (const auto &rt : _sorted_railtypes) {
2103 if (!used_railtypes.Test(rt)) continue;
2104 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2106 }
2107 }
2108
2109 /* Shared list so that each item can take ownership. */
2110 auto badge_class_list = std::make_shared<GUIBadgeClasses>(GSF_RAILTYPES);
2111
2112 for (const auto &rt : _sorted_railtypes) {
2113 /* If it's not used ever, don't show it to the user. */
2114 if (!used_railtypes.Test(rt)) continue;
2115
2116 const RailTypeInfo *rti = GetRailTypeInfo(rt);
2117
2118 if (for_replacement) {
2119 list.push_back(MakeDropDownListBadgeItem(badge_class_list, rti->badges, GSF_RAILTYPES, rti->introduction_date, GetString(rti->strings.replace_text), rt, !avail_railtypes.Test(rt)));
2120 } else {
2121 std::string str = rti->max_speed > 0
2122 ? GetString(STR_TOOLBAR_RAILTYPE_VELOCITY, rti->strings.menu_text, rti->max_speed)
2123 : GetString(rti->strings.menu_text);
2124 list.push_back(MakeDropDownListBadgeIconItem(badge_class_list, rti->badges, GSF_RAILTYPES, rti->introduction_date, RailBuildCost(rt), d, rti->gui_sprites.build_x_rail, PAL_NONE, std::move(str), rt, !avail_railtypes.Test(rt)));
2125 }
2126 }
2127
2128 if (list.empty()) {
2129 /* Empty dropdowns are not allowed */
2130 list.push_back(MakeDropDownListStringItem(STR_NONE, INVALID_RAILTYPE, true));
2131 }
2132
2133 return list;
2134}
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
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, uint8_t road_rail_type)
Prepare the data for the build a bridge window.
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition bridge_map.h:35
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
bool Failed() const
Did this command fail?
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
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)
Base class for windows opened from a toolbar.
Definition window_gui.h:999
void Close(int data=0) override
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:3628
static constexpr int PREVIEW_WIDTH
Width of each preview button.
Definition picker_gui.h:298
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:299
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:300
static constexpr int PREVIEW_BOTTOM
Offset from bottom edge to draw preview.
Definition picker_gui.h:301
@ PCWHK_FOCUS_FILTER_BOX
Focus the edit box for editing the filter string.
Definition picker_gui.h:332
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:115
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:220
SpriteID build_tunnel
button for building a tunnel
Definition rail.h:148
CursorID rail_swne
Cursor for building rail in X direction.
Definition rail.h:155
SpriteID convert_rail
button for converting rail
Definition rail.h:149
struct RailTypeInfo::@157247141350136173143103254227157213063052244122 strings
Strings associated with the rail type.
CursorID convert
Cursor for converting track.
Definition rail.h:161
CursorID depot
Cursor for building a depot.
Definition rail.h:159
TimerGameCalendar::Date introduction_date
Introduction date.
Definition rail.h:244
CursorID rail_nwse
Cursor for building rail in Y direction.
Definition rail.h:157
SpriteID build_x_rail
button for building single rail in X direction
Definition rail.h:143
CursorID rail_ew
Cursor for building rail in E-W direction.
Definition rail.h:156
SpriteID auto_rail
button for the autorail construction
Definition rail.h:146
CursorID autorail
Cursor for autorail tool.
Definition rail.h:158
StringID menu_text
Name of this rail type in the main toolbar dropdown.
Definition rail.h:167
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
Definition rail.h:166
struct RailTypeInfo::@047376261311064105134233254254216006075341230376 gui_sprites
struct containing the sprites for the rail GUI.
SpriteID signals[SIGTYPE_END][2][2]
signal GUI sprites (type, variant, state)
Definition rail.h:150
SpriteID build_ew_rail
button for building single rail in E-W direction
Definition rail.h:144
SpriteID build_y_rail
button for building single rail in Y direction
Definition rail.h:145
StringID replace_text
Text used in the autoreplace GUI.
Definition rail.h:169
SpriteID build_depot
button for building depots
Definition rail.h:147
SpriteID build_ns_rail
button for building single rail in N-S direction
Definition rail.h:142
CursorID rail_ns
Cursor for building rail in N-S direction.
Definition rail.h:154
SpriteID tunnel
tunnel sprites base
Definition rail.h:133
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:93
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
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X axis.
@ AXIS_Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
@ DIAGDIR_NE
Northeast, upper right on your monitor.
@ DIAGDIR_NW
Northwest.
@ DIAGDIR_SE
Southeast.
@ DIAGDIR_SW
Southwest.
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:87
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:972
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:1738
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:1038
uint8_t GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition gfx.cpp:1291
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:1573
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ FS_NORMAL
Index of the normal font in the font tables.
Definition gfx_type.h:249
uint32_t CursorID
The number of the cursor (sprite).
Definition gfx_type.h:19
@ 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 SetTextStyle(TextColour colour, FontSize size=FS_NORMAL)
Widget part function for setting the text style.
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 SetArrowWidgetTypeTip(ArrowWidgetValues widget_type, StringID tip={})
Widget part function for setting the arrow widget type and tooltip.
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetMinimalTextLines(uint8_t lines, uint8_t spacing, FontSize size=FS_NORMAL)
Widget part function for setting the minimal text lines.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
constexpr NWidgetPart SetPIPRatio(uint8_t ratio_pre, uint8_t ratio_inter, uint8_t ratio_post)
Widget part function for setting a pre/inter/post ratio.
void SetDirty() const
Mark entire window as dirty (in need of re-paint).
Definition window.cpp:980
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1554
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, uint 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:695
GrfSpecFeature
Definition newgrf.h:71
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.
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.
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
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition rail.h:429
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:301
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:962
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 void SetDefaultRailGui()
Set the initial (default) railtype to use.
static RailType _cur_railtype
Rail type of the current build-rail toolbar.
Definition rail_gui.cpp:57
static 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 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 WindowDesc _station_builder_desc(WDP_AUTO, "build_station_rail", 0, 0, WC_BUILD_STATION, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_station_builder_widgets, &BuildRailStationWindow::hotkeys)
High level window description of the station-build window (default & newGRF).
static void BuildRailClick_Remove(Window *w)
The "remove"-button click proc of the build-rail toolbar.
Definition rail_gui.cpp:361
static WindowDesc _signal_builder_desc(WDP_AUTO, {}, 0, 0, WC_BUILD_SIGNAL, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_signal_builder_widgets)
Signal selection window description.
static 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 Window * ShowStationBuilder(Window *parent)
Open station build window.
static bool StationUsesDefaultType(const BaseStation *bst)
Test if a station/waypoint uses the default graphics.
static const Track _place_depot_extra_track[12]
Additional pieces of track to add at the entrance of a depot.
Definition rail_gui.cpp:132
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 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.
static const DiagDirection _place_depot_extra_dir[12]
Direction to check for existing track pieces.
Definition rail_gui.cpp:139
void InitializeRailGUI()
Resets the rail GUI - sets default railtype to build and resets the signal GUI.
static bool _convert_signal_button
convert signal button in the signal GUI pressed
Definition rail_gui.cpp:60
static void GenericPlaceSignals(TileIndex tile)
Build a new signal or edit/remove a present signal, use CmdBuildSingleSignal() or CmdRemoveSingleSign...
Definition rail_gui.cpp: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:25
@ SIGNAL_CYCLE_ALL
Cycle through all signals visible to the player.
Definition rail_gui.h:31
static RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
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:475
SignalType GetSignalType(Tile t, Track track)
Get the signal type for a track on a tile.
Definition rail_map.h:304
static bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition rail_map.h:105
EnumBitSet< RailType, uint64_t > RailTypes
Allow incrementing of Track variables.
Definition rail_type.h:38
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
bool IsLevelCrossingTile(Tile t)
Return whether a tile is a level crossing tile.
Definition road_map.h:79
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
SignalType
Type of signal, i.e.
Definition signal_type.h:23
@ SIGTYPE_PBS
normal pbs signal
Definition signal_type.h:28
@ SIGTYPE_BLOCK
block signal
Definition signal_type.h:24
SignalVariant
Variant of the signal, i.e.
Definition signal_type.h:16
@ SIG_SEMAPHORE
Old-fashioned semaphore signal.
Definition signal_type.h:18
@ SIG_ELECTRIC
Light signal.
Definition signal_type.h:17
void SndClickBeep()
Play a beep sound for a click event if enabled in settings.
Definition sound.cpp:253
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.
bool HasStationTileRail(Tile t)
Has this station tile a rail?
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 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.
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
static IterateWrapper Iterate()
Returns an iterable ensemble of all Tiles.
Definition map_func.h:366
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:168
Data structure for an opened window.
Definition window_gui.h:274
void ReInit(int rx=0, int ry=0, bool reposition=false)
Re-initialize a window, and optionally change its size.
Definition window.cpp:992
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
Definition window.cpp:1117
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1822
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:768
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing).
Definition window.cpp:3261
Window * parent
Parent window.
Definition window_gui.h:329
void RaiseWidget(WidgetID widget_index)
Marks a widget as raised.
Definition window_gui.h:470
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:570
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:518
ResizeInfo resize
Resize information.
Definition window_gui.h:315
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
Definition window_gui.h:392
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
Definition window.cpp:1812
bool IsWidgetLowered(WidgetID widget_index) const
Gets the lowered state of a widget.
Definition window_gui.h:492
bool IsWidgetDisabled(WidgetID widget_index) const
Gets the enabled/disabled status of a widget.
Definition window_gui.h:411
void RaiseButtons(bool autoraise=false)
Raise the buttons of the window.
Definition window.cpp:544
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
bool IsShaded() const
Is window shaded currently?
Definition window_gui.h:563
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:850
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1845
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:990
void LowerWidget(WidgetID widget_index)
Marks a widget as lowered.
Definition window_gui.h:461
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition window.cpp:1835
virtual EventState OnHotkey(int hotkey)
A hotkey has been pressed.
Definition window.cpp:584
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:382
void ToggleWidgetLoweredState(WidgetID widget_index)
Invert the lowered/raised status of a widget.
Definition window_gui.h:451
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
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
@ TunnelBridge
Tunnel entry/exit and bridge heads.
Definition tile_type.h:58
@ 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)
highlighting tiles while only going over them 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:28
Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or INVALID_TRACK.
Definition track_func.h:177
TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:578
TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition track_func.h:365
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_UPPER
Upper track.
Definition track_type.h:39
@ TRACK_BIT_LEFT
Left track.
Definition track_type.h:41
@ TRACK_BIT_HORZ
Upper and lower track.
Definition track_type.h:44
@ TRACK_BIT_LOWER
Lower track.
Definition track_type.h:40
@ TRACK_BIT_RIGHT
Right track.
Definition track_type.h:42
@ TRACK_BIT_VERT
Left and right track.
Definition track_type.h:45
Track
These are used to specify a single track.
Definition track_type.h:19
@ TRACK_Y
Track along the y-axis (north-west to south-east).
Definition track_type.h:22
@ TRACK_LOWER
Track in the lower corner of the tile (south).
Definition track_type.h:24
@ TRACK_LEFT
Track in the left corner of the tile (west).
Definition track_type.h:25
@ TRACK_RIGHT
Track in the right corner of the tile (east).
Definition track_type.h:26
@ TRACK_X
Track along the x-axis (north-east to south-west).
Definition track_type.h:21
@ TRACK_UPPER
Track in the upper corner of the tile (north).
Definition track_type.h:23
@ TRANSPORT_RAIL
Transport by train.
Header file for things common for tunnels and bridges.
TileIndex _build_tunnel_endtile
The end of a tunnel; as hidden return from the tunnel build command for GUI purposes.
Command definitions related to tunnels and bridges.
Functions that have tunnels and bridges in common.
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
TileIndex GetOtherTunnelBridgeEnd(Tile t)
Determines type of the wormhole and returns its other end.
bool CanBuildVehicleInfrastructure(VehicleType type, uint8_t subtype)
Check whether we can build infrastructure for the given vehicle type.
Definition vehicle.cpp:1944
Functions related to vehicles.
@ VEH_TRAIN
Train vehicle type.
void SetTileSelectSize(int w, int h)
Highlight w by h tiles at the cursor.
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel)
Select or deselect waypoint for coverage area highlight.
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
void SetViewportCatchmentStation(const Station *st, bool sel)
Select or deselect station for coverage area highlight.
Functions related to (drawing on) viewports.
ViewportPlaceMethod
Viewport place method (type of highlighted area and placed objects).
@ VPM_FIX_Y
drag only in Y axis
@ VPM_Y_LIMITED
Drag only in Y axis with limited size.
@ VPM_X_AND_Y_LIMITED
area of land of limited size
@ VPM_FIX_VERTICAL
drag only in vertical direction
@ VPM_X_LIMITED
Drag only in X axis with limited size.
@ VPM_X_AND_Y
area of land in X and Y directions
@ VPM_FIX_HORIZONTAL
drag only in horizontal direction
@ VPM_FIX_X
drag only in X axis
@ VPM_SIGNALDIRS
similar to VMP_RAILDIRS, but with different cursor
@ VPM_X_OR_Y
drag in X or Y direction
@ VPM_RAILDIRS
all rail directions
ViewportDragDropSelectionProcess
Drag and drop selection process, or, what to do with an area of land when you've selected it.
@ DDSP_CONVERT_RAIL
Rail conversion.
@ DDSP_DEMOLISH_AREA
Clear area.
@ DDSP_BUILD_SIGNALS
Signal placement.
@ DDSP_REMOVE_STATION
Station removal.
@ DDSP_BUILD_STATION
Station placement.
@ DDSP_BUILD_BRIDGE
Bridge placement.
@ DDSP_PLACE_RAIL
Rail placement.
void DrawWaypointSprite(int x, int y, StationClassID station_class, uint16_t station_type, RailType railtype)
Draw a waypoint.
Definition waypoint.cpp:28
Base of waypoints.
@ WPF_ROAD
This is a road waypoint.
Axis GetAxisForNewRailWaypoint(TileIndex tile)
Get the axis for a new rail waypoint.
Command definitions related to waypoints.
Functions related to waypoints.
static RectPadding ScaleGUITrad(const RectPadding &r)
Scale a RectPadding to GUI zoom level.
Definition widget.cpp:49
@ WWT_IMGBTN
(Toggle) Button with image
Definition widget_type.h: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.
@ AWV_DECREASE
Arrow to the left or in case of RTL to the right.
Definition widget_type.h:20
@ AWV_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:1209
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1222
Point AlignInitialConstructionToolbar(int window_width)
Compute the position of the construction toolbars.
Definition window.cpp:1715
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1166
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3199
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:153
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
@ WDP_MANUAL
Manually align the window (so no automatic location finding).
Definition window_gui.h:143
int WidgetID
Widget ID.
Definition window_type.h:20
@ WN_GAME_OPTIONS_GAME_SETTINGS
Game settings.
Definition window_type.h:32
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
static constexpr WidgetID INVALID_WIDGET
An invalid widget index.
Definition window_type.h:23
@ WC_BUILD_STATION
Build station; Window numbers:
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition window_type.h:78
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition window_type.h:50
@ WC_SCEN_LAND_GEN
Landscape generation (in Scenario Editor); Window numbers:
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
@ WC_BUILD_SIGNAL
Build signal toolbar; Window numbers:
@ WC_BUILD_DEPOT
Build depot; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_BUILD_WAYPOINT
Build waypoint; Window numbers:
@ WC_BUILD_BRIDGE
Build bridge; Window numbers:
Functions related to zooming.
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107