OpenTTD Source 20260219-master-g698dc9cb08
order_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 "command_func.h"
12#include "viewport_func.h"
13#include "depot_map.h"
14#include "roadveh.h"
15#include "timetable.h"
16#include "strings_func.h"
17#include "company_func.h"
18#include "dropdown_type.h"
19#include "dropdown_func.h"
20#include "textbuf_gui.h"
21#include "string_func.h"
22#include "tilehighlight_func.h"
23#include "network/network.h"
24#include "station_base.h"
25#include "industry.h"
26#include "waypoint_base.h"
28#include "hotkeys.h"
29#include "aircraft.h"
30#include "engine_func.h"
31#include "vehicle_func.h"
32#include "vehiclelist.h"
33#include "vehicle_func.h"
34#include "error.h"
35#include "order_cmd.h"
36#include "company_cmd.h"
38
40
41#include "table/strings.h"
42
43#include "safeguards.h"
44
45
47static const StringID _station_load_types[][5][5] = {
48 {
49 /* No refitting. */
50 {
53 STR_ORDER_FULL_LOAD,
54 STR_ORDER_FULL_LOAD_ANY,
55 STR_ORDER_NO_LOAD,
56 }, {
57 STR_ORDER_UNLOAD,
59 STR_ORDER_UNLOAD_FULL_LOAD,
60 STR_ORDER_UNLOAD_FULL_LOAD_ANY,
61 STR_ORDER_UNLOAD_NO_LOAD,
62 }, {
63 STR_ORDER_TRANSFER,
65 STR_ORDER_TRANSFER_FULL_LOAD,
66 STR_ORDER_TRANSFER_FULL_LOAD_ANY,
67 STR_ORDER_TRANSFER_NO_LOAD,
68 }, {
69 /* Unload and transfer do not work together. */
75 }, {
76 STR_ORDER_NO_UNLOAD,
78 STR_ORDER_NO_UNLOAD_FULL_LOAD,
79 STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,
80 STR_ORDER_NO_UNLOAD_NO_LOAD,
81 }
82 }, {
83 /* With auto-refitting. No loading and auto-refitting do not work together. */
84 {
85 STR_ORDER_AUTO_REFIT,
87 STR_ORDER_FULL_LOAD_REFIT,
88 STR_ORDER_FULL_LOAD_ANY_REFIT,
90 }, {
91 STR_ORDER_UNLOAD_REFIT,
93 STR_ORDER_UNLOAD_FULL_LOAD_REFIT,
94 STR_ORDER_UNLOAD_FULL_LOAD_ANY_REFIT,
96 }, {
97 STR_ORDER_TRANSFER_REFIT,
99 STR_ORDER_TRANSFER_FULL_LOAD_REFIT,
100 STR_ORDER_TRANSFER_FULL_LOAD_ANY_REFIT,
102 }, {
103 /* Unload and transfer do not work together. */
109 }, {
110 STR_ORDER_NO_UNLOAD_REFIT,
112 STR_ORDER_NO_UNLOAD_FULL_LOAD_REFIT,
113 STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY_REFIT,
115 }
116 }
117};
118
119static const StringID _order_non_stop_dropdown[] = {
120 STR_ORDER_GO_TO,
121 STR_ORDER_GO_NON_STOP_TO,
122 STR_ORDER_GO_VIA,
123 STR_ORDER_GO_NON_STOP_VIA,
124};
125
126static const StringID _order_full_load_dropdown[] = {
127 STR_ORDER_DROP_LOAD_IF_POSSIBLE,
128 STR_EMPTY,
129 STR_ORDER_DROP_FULL_LOAD_ALL,
130 STR_ORDER_DROP_FULL_LOAD_ANY,
131 STR_ORDER_DROP_NO_LOADING,
132};
133
134static const StringID _order_unload_dropdown[] = {
135 STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,
136 STR_ORDER_DROP_UNLOAD,
137 STR_ORDER_DROP_TRANSFER,
138 STR_EMPTY,
139 STR_ORDER_DROP_NO_UNLOADING,
140};
141
142static const StringID _order_goto_dropdown[] = {
143 STR_ORDER_GO_TO,
144 STR_ORDER_GO_TO_NEAREST_DEPOT,
145 STR_ORDER_CONDITIONAL,
146 STR_ORDER_SHARE,
147};
148
149static const StringID _order_goto_dropdown_aircraft[] = {
150 STR_ORDER_GO_TO,
151 STR_ORDER_GO_TO_NEAREST_HANGAR,
152 STR_ORDER_CONDITIONAL,
153 STR_ORDER_SHARE,
154};
155
167
168static const StringID _order_conditional_condition[] = {
169 STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,
170 STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,
171 STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,
172 STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,
173 STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,
174 STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,
175 STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,
176 STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,
177};
178
179extern uint ConvertSpeedToDisplaySpeed(uint speed, VehicleType type);
180extern uint ConvertDisplaySpeedToSpeed(uint speed, VehicleType type);
181
182static const StringID _order_depot_action_dropdown[] = {
183 STR_ORDER_DROP_GO_ALWAYS_DEPOT,
184 STR_ORDER_DROP_SERVICE_DEPOT,
185 STR_ORDER_DROP_HALT_DEPOT,
186 STR_ORDER_DROP_UNBUNCH,
187};
188
189static OrderDepotAction DepotActionStringIndex(const Order *order)
190{
195}
196
197static const StringID _order_refit_action_dropdown[] = {
198 STR_ORDER_DROP_REFIT_AUTO,
199 STR_ORDER_DROP_REFIT_AUTO_ANY,
200};
201
202static StringID GetOrderGoToString(const Order &order)
203{
205 return order.GetNonStopType().Test(OrderNonStopFlag::NoIntermediate) ? STR_ORDER_SERVICE_NON_STOP_AT : STR_ORDER_SERVICE_AT;
206 } else {
207 return order.GetNonStopType().Test(OrderNonStopFlag::NoIntermediate) ? STR_ORDER_GO_NON_STOP_TO : STR_ORDER_GO_TO;
208 }
209}
210
223void DrawOrderString(const Vehicle *v, const Order *order, VehicleOrderID order_index, int y, bool selected, bool timetable, int left, int middle, int right)
224{
225 bool rtl = _current_text_dir == TD_RTL;
226
227 SpriteID sprite = rtl ? SPR_ARROW_LEFT : SPR_ARROW_RIGHT;
228 Dimension sprite_size = GetSpriteSize(sprite);
229 if (v->cur_real_order_index == order_index) {
230 /* Draw two arrows before the next real order. */
231 DrawSprite(sprite, PAL_NONE, rtl ? right - sprite_size.width : left, y + ((int)GetCharacterHeight(FS_NORMAL) - (int)sprite_size.height) / 2);
232 DrawSprite(sprite, PAL_NONE, rtl ? right - 2 * sprite_size.width : left + sprite_size.width, y + ((int)GetCharacterHeight(FS_NORMAL) - (int)sprite_size.height) / 2);
233 } else if (v->cur_implicit_order_index == order_index) {
234 /* Draw one arrow before the next implicit order; the next real order will still get two arrows. */
235 DrawSprite(sprite, PAL_NONE, rtl ? right - sprite_size.width : left, y + ((int)GetCharacterHeight(FS_NORMAL) - (int)sprite_size.height) / 2);
236 }
237
238 TextColour colour = TC_BLACK;
239 if (order->IsType(OT_IMPLICIT)) {
240 colour = (selected ? TC_SILVER : TC_GREY) | TC_NO_SHADE;
241 } else if (selected) {
242 colour = TC_WHITE;
243 }
244
245 DrawString(left, rtl ? right - 2 * sprite_size.width - 3 : middle, y, GetString(STR_ORDER_INDEX, order_index + 1), colour, SA_RIGHT | SA_FORCE);
246
247 std::string line;
248
249 switch (order->GetType()) {
250 case OT_DUMMY:
251 line = GetString(STR_INVALID_ORDER);
252 break;
253
254 case OT_IMPLICIT:
255 line = GetString(STR_ORDER_GO_TO_STATION, STR_ORDER_GO_TO, order->GetDestination());
256 if (!timetable) line += GetString(STR_ORDER_IMPLICIT);
257 break;
258
259 case OT_GOTO_STATION: {
260 OrderLoadType load = order->GetLoadType();
261 OrderUnloadType unload = order->GetUnloadType();
262 bool valid_station = CanVehicleUseStation(v, Station::Get(order->GetDestination().ToStationID()));
263
264 line = GetString(valid_station ? STR_ORDER_GO_TO_STATION : STR_ORDER_GO_TO_STATION_CAN_T_USE_STATION, STR_ORDER_GO_TO + (v->IsGroundVehicle() ? order->GetNonStopType() : OrderNonStopFlags{}).base(), order->GetDestination());
265 if (timetable) {
266 /* Show only wait time in the timetable window. */
267 if (order->GetWaitTime() > 0) {
268 auto [str, value] = GetTimetableParameters(order->GetWaitTime());
269 line += GetString(order->IsWaitTimetabled() ? STR_TIMETABLE_STAY_FOR : STR_TIMETABLE_STAY_FOR_ESTIMATED, str, value);
270 }
271 } else {
272 /* Show non-stop, refit and stop location only in the order window. */
274 StringID str = _station_load_types[order->IsRefit()][to_underlying(unload)][to_underlying(load)];
275 if (str != INVALID_STRING_ID) {
276 if (order->IsRefit()) {
277 line += GetString(str, order->IsAutoRefit() ? STR_ORDER_AUTO_REFIT_ANY : CargoSpec::Get(order->GetRefitCargo())->name);
278 } else {
279 line += GetString(str);
280 }
281 }
282 }
283
285 /* Only show the stopping location if other than the default chosen by the player. */
286 if (order->GetStopLocation() != _settings_client.gui.stop_location) {
287 line += GetString(STR_ORDER_STOP_LOCATION_NEAR_END + to_underlying(order->GetStopLocation()));
288 }
289 }
290 }
291 break;
292 }
293
294 case OT_GOTO_DEPOT:
296 /* Going to a specific depot. */
297 line = GetString(STR_ORDER_GO_TO_DEPOT_FORMAT, GetOrderGoToString(*order), v->type, order->GetDestination());
298 } else if (v->type == VEH_AIRCRAFT) {
299 /* Going to the nearest hangar. */
300 line = GetString(STR_ORDER_GO_TO_NEAREST_HANGAR_FORMAT, GetOrderGoToString(*order));
301 } else {
302 /* Going to the nearest depot. */
303 line = GetString(STR_ORDER_GO_TO_NEAREST_DEPOT_FORMAT, GetOrderGoToString(*order), STR_ORDER_TRAIN_DEPOT + v->type);
304 }
305
306 /* Do not show stopping in the depot in the timetable window. */
307 if (!timetable && order->GetDepotActionType().Test(OrderDepotActionFlag::Halt)) {
308 line += GetString(STR_ORDER_STOP_ORDER);
309 }
310
311 /* Do not show refitting in the depot in the timetable window. */
312 if (!timetable && order->IsRefit()) {
313 line += GetString(order->GetDepotActionType().Test(OrderDepotActionFlag::Halt) ? STR_ORDER_REFIT_STOP_ORDER : STR_ORDER_REFIT_ORDER, CargoSpec::Get(order->GetRefitCargo())->name);
314 }
315
316 /* Show unbunching depot in both order and timetable windows. */
318 line += GetString(STR_ORDER_WAIT_TO_UNBUNCH);
319 }
320 break;
321
322 case OT_GOTO_WAYPOINT:
323 line = GetString(order->GetNonStopType().Test(OrderNonStopFlag::NoIntermediate) ? STR_ORDER_GO_NON_STOP_TO_WAYPOINT : STR_ORDER_GO_TO_WAYPOINT, order->GetDestination());
324 break;
325
326 case OT_CONDITIONAL:
328 line = GetString(STR_ORDER_CONDITIONAL_UNCONDITIONAL, order->GetConditionSkipToOrder() + 1);
329 } else {
331
332 uint value = order->GetConditionValue();
334
335 line = GetString((occ == OrderConditionComparator::IsTrue || occ == OrderConditionComparator::IsFalse) ? STR_ORDER_CONDITIONAL_TRUE_FALSE : STR_ORDER_CONDITIONAL_NUM,
336 order->GetConditionSkipToOrder() + 1,
337 STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + to_underlying(order->GetConditionVariable()),
338 STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + to_underlying(occ),
339 value);
340 }
341
342 if (timetable && order->GetWaitTime() > 0) {
343 auto [str, value] = GetTimetableParameters(order->GetWaitTime());
344 line += GetString(order->IsWaitTimetabled() ? STR_TIMETABLE_AND_TRAVEL_FOR : STR_TIMETABLE_AND_TRAVEL_FOR_ESTIMATED, str, value);
345 }
346 break;
347
348 default: NOT_REACHED();
349 }
350
351 /* Check range for aircraft. */
352 if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->GetRange() > 0 && order->IsGotoOrder()) {
353 if (GetOrderDistance(order_index, v->orders->GetNext(order_index), v) > Aircraft::From(v)->acache.cached_max_range_sqr) {
354 line += GetString(STR_ORDER_OUT_OF_RANGE);
355 }
356 }
357
358 DrawString(rtl ? left : middle, rtl ? middle : right, y, line, colour);
359}
360
368{
369 Order order{};
370
371 /* check depot first */
372 if (IsDepotTypeTile(tile, (TransportType)(uint)v->type) && IsTileOwner(tile, _local_company)) {
375 (_settings_client.gui.new_nonstop && v->IsGroundVehicle()) ? OrderNonStopFlag::NoIntermediate : OrderNonStopFlags{});
376
377 if (_ctrl_pressed) {
378 /* Now we are allowed to set the action type. */
380 }
381
382 return order;
383 }
384
385 /* check rail waypoint */
386 if (IsRailWaypointTile(tile) &&
387 v->type == VEH_TRAIN &&
391 return order;
392 }
393
394 /* check road waypoint */
395 if (IsRoadWaypointTile(tile) &&
396 v->type == VEH_ROAD &&
400 return order;
401 }
402
403 /* check buoy (no ownership) */
404 if (IsBuoyTile(tile) && v->type == VEH_SHIP) {
406 return order;
407 }
408
409 /* check for station or industry with neutral station */
411 const Station *st = nullptr;
412
413 if (IsTileType(tile, TileType::Station)) {
414 st = Station::GetByTile(tile);
415 } else {
416 const Industry *in = Industry::GetByTile(tile);
417 st = in->neutral_station;
418 }
419 if (st != nullptr && (st->owner == _local_company || st->owner == OWNER_NONE)) {
420 StationFacilities facil;
421 switch (v->type) {
422 case VEH_SHIP: facil = StationFacility::Dock; break;
423 case VEH_TRAIN: facil = StationFacility::Train; break;
424 case VEH_AIRCRAFT: facil = StationFacility::Airport; break;
426 default: NOT_REACHED();
427 }
428 if (st->facilities.Any(facil)) {
429 order.MakeGoToStation(st->index);
433 return order;
434 }
435 }
436 }
437
438 /* not found */
439 order.Free();
440 return order;
441}
442
444enum OrderHotKeys : int32_t {
445 OHK_SKIP,
446 OHK_DELETE,
447 OHK_GOTO,
448 OHK_NONSTOP,
449 OHK_FULLLOAD,
450 OHK_UNLOAD,
451 OHK_NEAREST_DEPOT,
452 OHK_ALWAYS_SERVICE,
453 OHK_TRANSFER,
454 OHK_NO_UNLOAD,
455 OHK_NO_LOAD,
456};
457
498struct OrdersWindow : public Window {
499private:
501 enum OrderPlaceObjectState : uint8_t {
502 OPOS_NONE,
503 OPOS_GOTO,
504 OPOS_CONDITIONAL,
505 OPOS_SHARE,
506 OPOS_END,
507 };
508
510 enum DisplayPane : uint8_t {
511 /* WID_O_SEL_TOP_ROW_GROUNDVEHICLE */
514
515 /* WID_O_SEL_TOP_LEFT */
518
519 /* WID_O_SEL_TOP_MIDDLE */
522
523 /* WID_O_SEL_TOP_RIGHT */
526
527 /* WID_O_SEL_TOP_ROW */
531
532 /* WID_O_SEL_BOTTOM_MIDDLE */
535 };
536
537 int selected_order = -1;
539 OrderPlaceObjectState goto_type = OPOS_NONE;
540 const Vehicle *vehicle = nullptr;
541 Scrollbar *vscroll = nullptr;
542 bool can_do_refit = false;
543 bool can_do_autorefit = false;
544
551 {
552 int num = this->selected_order;
553 return (num >= 0 && num < vehicle->GetNumOrders()) ? num : vehicle->GetNumOrders();
554 }
555
565 {
566 int32_t sel = this->vscroll->GetScrolledRowFromWidget(y, this, WID_O_ORDER_LIST, WidgetDimensions::scaled.framerect.top);
567 if (sel == INT32_MAX) return INVALID_VEH_ORDER_ID;
568 /* One past the orders is the 'End of Orders' line. */
569 assert(IsInsideBS(sel, 0, vehicle->GetNumOrders() + 1));
570 return sel;
571 }
572
578 {
579 assert(type > OPOS_NONE && type < OPOS_END);
580
581 static const HighLightStyle goto_place_style[OPOS_END - 1] = {
582 HT_RECT | HT_VEHICLE, // OPOS_GOTO
583 HT_NONE, // OPOS_CONDITIONAL
584 HT_VEHICLE, // OPOS_SHARE
585 };
586 SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, goto_place_style[type - 1], this);
587 this->goto_type = type;
589 }
590
596 void OrderClick_FullLoad(OrderLoadType load_type, bool toggle = false)
597 {
598 VehicleOrderID sel_ord = this->OrderGetSel();
599 const Order *order = this->vehicle->GetOrder(sel_ord);
600
601 if (order == nullptr) return;
602
603 if (toggle && order->GetLoadType() == load_type) {
604 load_type = OrderLoadType::LoadIfPossible; // reset to 'default'
605 }
606 if (order->GetLoadType() == load_type) return; // If we still match, do nothing
607
608 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_LOAD, to_underlying(load_type));
609 }
610
615 void OrderClick_Service(std::optional<OrderDepotAction> i)
616 {
617 VehicleOrderID sel_ord = this->OrderGetSel();
618
619 if (!i.has_value()) {
620 const Order *order = this->vehicle->GetOrder(sel_ord);
621 if (order == nullptr) return;
623 }
624 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_DEPOT_ACTION, to_underlying(i.value()));
625 }
626
631 {
632 Order order{};
633 order.MakeGoToDepot(DepotID::Invalid(), OrderDepotTypeFlag::PartOfOrders,
634 _settings_client.gui.new_nonstop && this->vehicle->IsGroundVehicle() ? OrderNonStopFlag::NoIntermediate : OrderNonStopFlags{});
636
637 Command<Commands::InsertOrder>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), order);
638 }
639
645 void OrderClick_Unload(OrderUnloadType unload_type, bool toggle = false)
646 {
647 VehicleOrderID sel_ord = this->OrderGetSel();
648 const Order *order = this->vehicle->GetOrder(sel_ord);
649
650 if (order == nullptr) return;
651
652 if (toggle && order->GetUnloadType() == unload_type) {
654 }
655 if (order->GetUnloadType() == unload_type) return; // If we still match, do nothing
656
657 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_UNLOAD, to_underlying(unload_type));
658
659 /* Transfer and unload orders with leave empty as default */
660 if (unload_type == OrderUnloadType::Transfer || unload_type == OrderUnloadType::Unload) {
661 Command<Commands::ModifyOrder>::Post(this->vehicle->tile, this->vehicle->index, sel_ord, MOF_LOAD, to_underlying(OrderLoadType::NoLoad));
663 }
664 }
665
670 void OrderClick_Nonstop(std::optional<OrderNonStopFlags> non_stop)
671 {
672 if (!this->vehicle->IsGroundVehicle()) return;
673
674 VehicleOrderID sel_ord = this->OrderGetSel();
675 const Order *order = this->vehicle->GetOrder(sel_ord);
676
677 if (order == nullptr || order->GetNonStopType() == non_stop) return;
678
679 /* Keypress if no value, so 'toggle' to the next */
680 if (!non_stop.has_value()) {
682 }
683
685 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_NON_STOP, non_stop.value().base());
686 }
687
693 {
694 /* Don't skip when there's nothing to skip */
695 if (_ctrl_pressed && this->vehicle->cur_implicit_order_index == this->OrderGetSel()) return;
696 if (this->vehicle->GetNumOrders() <= 1) return;
697
698 Command<Commands::SkipToOrder>::Post(_ctrl_pressed ? STR_ERROR_CAN_T_SKIP_TO_ORDER : STR_ERROR_CAN_T_SKIP_ORDER,
699 this->vehicle->tile, this->vehicle->index, _ctrl_pressed ? this->OrderGetSel() : ((this->vehicle->cur_implicit_order_index + 1) % this->vehicle->GetNumOrders()));
700 }
701
706 {
707 /* When networking, move one order lower */
708 int selected = this->selected_order + (int)_networking;
709
710 if (Command<Commands::DeleteOrder>::Post(STR_ERROR_CAN_T_DELETE_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel())) {
711 this->selected_order = selected >= this->vehicle->GetNumOrders() ? -1 : selected;
712 this->UpdateButtonState();
713 }
714 }
715
723 {
724 /* Don't try to stop sharing orders if 'End of Shared Orders' isn't selected. */
725 if (!this->vehicle->IsOrderListShared() || this->selected_order != this->vehicle->GetNumOrders()) return;
726 /* If Ctrl is pressed, delete the order list as if we clicked the 'Delete' button. */
727 if (_ctrl_pressed) {
728 this->OrderClick_Delete();
729 return;
730 }
731
732 /* Get another vehicle that share orders with this vehicle. */
733 Vehicle *other_shared = (this->vehicle->FirstShared() == this->vehicle) ? this->vehicle->NextShared() : this->vehicle->PreviousShared();
734 /* Copy the order list of the other vehicle. */
735 if (Command<Commands::CloneOrder>::Post(STR_ERROR_CAN_T_STOP_SHARING_ORDER_LIST, this->vehicle->tile, CO_COPY, this->vehicle->index, other_shared->index)) {
736 this->UpdateButtonState();
737 }
738 }
739
746 void OrderClick_Refit(int i, bool auto_refit)
747 {
748 if (_ctrl_pressed) {
749 /* Cancel refitting */
750 Command<Commands::OrderRefit>::Post(this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), CARGO_NO_REFIT);
751 } else {
752 if (i == 1) { // Auto-refit to available cargo type.
753 Command<Commands::OrderRefit>::Post(this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), CARGO_AUTO_REFIT);
754 } else {
755 ShowVehicleRefitWindow(this->vehicle, this->OrderGetSel(), this, auto_refit);
756 }
757 }
758 }
759
762 {
763 this->can_do_refit = false;
764 this->can_do_autorefit = false;
765 for (const Vehicle *w = this->vehicle; w != nullptr; w = w->IsGroundVehicle() ? w->Next() : nullptr) {
766 if (IsEngineRefittable(w->engine_type)) this->can_do_refit = true;
767 if (Engine::Get(w->engine_type)->info.misc_flags.Test(EngineMiscFlag::AutoRefit)) this->can_do_autorefit = true;
768 }
769 }
770
771public:
772 OrdersWindow(WindowDesc &desc, const Vehicle *v) : Window(desc)
773 {
774 this->vehicle = v;
775
776 this->CreateNestedTree();
777 this->vscroll = this->GetScrollbar(WID_O_SCROLLBAR);
778 if (NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_O_DEPOT_ACTION); nwid != nullptr) {
779 nwid->SetToolTip(STR_ORDER_TRAIN_DEPOT_ACTION_TOOLTIP + v->type);
780 }
781 this->FinishInitNested(v->index);
782
783 this->owner = v->owner;
784
785 this->UpdateAutoRefitState();
786
788 /* If there are less than 2 station, make Go To active. */
789 int station_orders = std::ranges::count_if(v->Orders(), [](const Order &order) { return order.IsType(OT_GOTO_STATION); });
790
791 if (station_orders < 2) this->OrderClick_Goto(OPOS_GOTO);
792 }
794 }
795
796 void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
797 {
798 switch (widget) {
799 case WID_O_ORDER_LIST:
800 fill.height = resize.height = GetCharacterHeight(FS_NORMAL);
801 size.height = 6 * resize.height + padding.height;
802 break;
803
804 case WID_O_COND_VARIABLE: {
805 Dimension d = {0, 0};
806 for (const auto &ocv : _order_conditional_variable) {
807 d = maxdim(d, GetStringBoundingBox(STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + to_underlying(ocv)));
808 }
809 d.width += padding.width;
810 d.height += padding.height;
811 size = maxdim(size, d);
812 break;
813 }
814
816 Dimension d = GetStringListBoundingBox(_order_conditional_condition);
817 d.width += padding.width;
818 d.height += padding.height;
819 size = maxdim(size, d);
820 break;
821 }
822 }
823 }
824
830 void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
831 {
834
835 switch (data) {
836 case VIWD_AUTOREPLACE:
837 /* Autoreplace replaced the vehicle */
838 this->vehicle = Vehicle::Get(this->window_number);
839 [[fallthrough]];
840
842 /* Vehicle composition was changed. */
843 this->UpdateAutoRefitState();
844 break;
845
847 /* Removed / replaced all orders (after deleting / sharing) */
848 if (this->selected_order == -1) break;
849
850 this->CloseChildWindows();
851 this->selected_order = -1;
852 break;
853
855 /* Some other order changes */
856 break;
857
858 default:
859 if (data < 0) break;
860
861 if (gui_scope) break; // only do this once; from command scope
862 from = GB(data, 0, 8);
863 to = GB(data, 8, 8);
864 /* Moving an order. If one of these is INVALID_VEH_ORDER_ID, then
865 * the order is being created / removed */
866 if (this->selected_order == -1) break;
867
868 if (from == to) break; // no need to change anything
869
870 if (from != this->selected_order) {
871 /* Moving from preceding order? */
872 this->selected_order -= (int)(from <= this->selected_order);
873 /* Moving to preceding order? */
874 this->selected_order += (int)(to <= this->selected_order);
875 break;
876 }
877
878 /* Now we are modifying the selected order */
879 if (to == INVALID_VEH_ORDER_ID) {
880 /* Deleting selected order */
881 this->CloseChildWindows();
882 this->selected_order = -1;
883 break;
884 }
885
886 /* Moving selected order */
887 this->selected_order = to;
888 break;
889 }
890
891 this->vscroll->SetCount(this->vehicle->GetNumOrders() + 1);
892 if (gui_scope) this->UpdateButtonState();
893
894 /* Scroll to the new order. */
895 if (from == INVALID_VEH_ORDER_ID && to != INVALID_VEH_ORDER_ID && !this->vscroll->IsVisible(to)) {
896 this->vscroll->ScrollTowards(to);
897 }
898 }
899
900 void UpdateButtonState()
901 {
902 if (this->vehicle->owner != _local_company) return; // No buttons are displayed with competitor order windows.
903
904 bool shared_orders = this->vehicle->IsOrderListShared();
905 VehicleOrderID sel = this->OrderGetSel();
906 const Order *order = this->vehicle->GetOrder(sel);
907
908 /* Second row. */
909 /* skip */
910 this->SetWidgetDisabledState(WID_O_SKIP, this->vehicle->GetNumOrders() <= 1);
911
912 /* delete / stop sharing */
914 if (shared_orders && this->selected_order == this->vehicle->GetNumOrders()) {
915 /* The 'End of Shared Orders' order is selected, show the 'stop sharing' button. */
917 } else {
918 /* The 'End of Shared Orders' order isn't selected, show the 'delete' button. */
921 (uint)this->vehicle->GetNumOrders() + ((shared_orders || this->vehicle->GetNumOrders() != 0) ? 1 : 0) <= (uint)this->selected_order);
922
923 /* Set the tooltip of the 'delete' button depending on whether the
924 * 'End of Orders' order or a regular order is selected. */
925 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_O_DELETE);
926 if (this->selected_order == this->vehicle->GetNumOrders()) {
927 nwi->SetStringTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_ALL_TOOLTIP);
928 } else {
929 nwi->SetStringTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP);
930 }
931 }
932
933 /* First row. */
936
937 /* Selection widgets. */
938 /* Train or road vehicle. */
939 NWidgetStacked *train_row_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_ROW_GROUNDVEHICLE);
940 NWidgetStacked *left_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_LEFT);
941 NWidgetStacked *middle_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_MIDDLE);
942 NWidgetStacked *right_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_RIGHT);
943 /* Ship or airplane. */
944 NWidgetStacked *row_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_ROW);
945 assert(row_sel != nullptr || (train_row_sel != nullptr && left_sel != nullptr && middle_sel != nullptr && right_sel != nullptr));
946
947
948 if (order == nullptr) {
949 if (row_sel != nullptr) {
951 } else {
958 }
962 } else {
965
966 switch (order->GetType()) {
967 case OT_GOTO_STATION:
968 if (row_sel != nullptr) {
970 } else {
977 }
980
981 /* Can only do refitting when stopping at the destination and loading cargo.
982 * Also enable the button if a refit is already set to allow clearing it. */
985 ((!this->can_do_refit || !this->can_do_autorefit) && !order->IsRefit()));
986
987 break;
988
989 case OT_GOTO_WAYPOINT:
990 if (row_sel != nullptr) {
992 } else {
999 }
1003 break;
1004
1005 case OT_GOTO_DEPOT:
1006 if (row_sel != nullptr) {
1008 } else {
1015 }
1016 /* Disable refit button if the order is no 'always go' order.
1017 * However, keep the service button enabled for refit-orders to allow clearing refits (without knowing about ctrl). */
1020 (!this->can_do_refit && !order->IsRefit()));
1021 break;
1022
1023 case OT_CONDITIONAL: {
1024 if (row_sel != nullptr) {
1026 } else {
1028 }
1030 /* Set the strings for the dropdown boxes. */
1031 this->GetWidget<NWidgetCore>(WID_O_COND_VARIABLE)->SetString(STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + to_underlying(ocv));
1032 this->GetWidget<NWidgetCore>(WID_O_COND_COMPARATOR)->SetString(_order_conditional_condition[to_underlying(order->GetConditionComparator())]);
1035 break;
1036 }
1037
1038 default: // every other order
1039 if (row_sel != nullptr) {
1041 } else {
1047 }
1051 break;
1052 }
1053 }
1054
1055 /* Disable list of vehicles with the same shared orders if there is no list */
1056 this->SetWidgetDisabledState(WID_O_SHARED_ORDER_LIST, !shared_orders);
1057
1058 this->SetDirty();
1059 }
1060
1061 void OnPaint() override
1062 {
1063 if (this->vehicle->owner != _local_company) {
1064 this->selected_order = -1; // Disable selection any selected row at a competitor order window.
1065 } else {
1066 this->SetWidgetLoweredState(WID_O_GOTO, this->goto_type != OPOS_NONE);
1067 }
1068 this->DrawWidgets();
1069 }
1070
1071 void DrawWidget(const Rect &r, WidgetID widget) const override
1072 {
1073 if (widget != WID_O_ORDER_LIST) return;
1074
1075 Rect ir = r.Shrink(WidgetDimensions::scaled.frametext, WidgetDimensions::scaled.framerect);
1076 bool rtl = _current_text_dir == TD_RTL;
1077 uint64_t max_value = GetParamMaxValue(this->vehicle->GetNumOrders(), 2);
1078 int index_column_width = GetStringBoundingBox(GetString(STR_ORDER_INDEX, max_value)).width + 2 * GetSpriteSize(rtl ? SPR_ARROW_RIGHT : SPR_ARROW_LEFT).width + WidgetDimensions::scaled.hsep_normal;
1079 int middle = rtl ? ir.right - index_column_width : ir.left + index_column_width;
1080
1081 int y = ir.top;
1082 int line_height = this->GetWidget<NWidgetBase>(WID_O_ORDER_LIST)->resize_y;
1083
1084 VehicleOrderID i = this->vscroll->GetPosition();
1085 VehicleOrderID num_orders = this->vehicle->GetNumOrders();
1086
1087 /* First draw the highlighting underground if it exists. */
1088 if (this->order_over != INVALID_VEH_ORDER_ID) {
1089 while (i < num_orders) {
1090 /* Don't draw anything if it extends past the end of the window. */
1091 if (!this->vscroll->IsVisible(i)) break;
1092
1093 if (i != this->selected_order && i == this->order_over) {
1094 /* Highlight dragged order destination. */
1095 int top = (this->order_over < this->selected_order ? y : y + line_height) - WidgetDimensions::scaled.framerect.top;
1096 int bottom = std::min(top + 2, ir.bottom);
1097 top = std::max(top - 3, ir.top);
1098 GfxFillRect(ir.left, top, ir.right, bottom, GetColourGradient(COLOUR_GREY, SHADE_LIGHTEST));
1099 break;
1100 }
1101 y += line_height;
1102
1103 i++;
1104 }
1105
1106 /* Reset counters for drawing the orders. */
1107 y = ir.top;
1108 i = this->vscroll->GetPosition();
1109 }
1110
1111 /* Draw the orders. */
1112 while (i < num_orders) {
1113 /* Don't draw anything if it extends past the end of the window. */
1114 if (!this->vscroll->IsVisible(i)) break;
1115
1116 DrawOrderString(this->vehicle, this->vehicle->GetOrder(i), i, y, i == this->selected_order, false, ir.left, middle, ir.right);
1117 y += line_height;
1118
1119 i++;
1120 }
1121
1122 if (this->vscroll->IsVisible(i)) {
1123 StringID str = this->vehicle->IsOrderListShared() ? STR_ORDERS_END_OF_SHARED_ORDERS : STR_ORDERS_END_OF_ORDERS;
1124 DrawString(rtl ? ir.left : middle, rtl ? middle : ir.right, y, str, (i == this->selected_order) ? TC_WHITE : TC_BLACK);
1125 }
1126 }
1127
1128 std::string GetWidgetString(WidgetID widget, StringID stringid) const override
1129 {
1130 switch (widget) {
1131 case WID_O_COND_VALUE: {
1132 VehicleOrderID sel = this->OrderGetSel();
1133 const Order *order = this->vehicle->GetOrder(sel);
1134
1135 if (order != nullptr && order->IsType(OT_CONDITIONAL)) {
1136 uint value = order->GetConditionValue();
1137 if (order->GetConditionVariable() == OrderConditionVariable::MaxSpeed) value = ConvertSpeedToDisplaySpeed(value, this->vehicle->type);
1138 return GetString(STR_JUST_COMMA, value);
1139 }
1140 return {};
1141 }
1142
1143 case WID_O_CAPTION:
1144 return GetString(STR_ORDERS_CAPTION, this->vehicle->index);
1145
1146 case WID_O_DEPOT_ACTION: {
1147 VehicleOrderID sel = this->OrderGetSel();
1148 const Order *order = this->vehicle->GetOrder(sel);
1149 if (order == nullptr || !order->IsType(OT_GOTO_DEPOT)) return {};
1150
1151 /* Select the current action selected in the dropdown. The flags don't match the dropdown so we can't just use an index. */
1152 if (order->GetDepotOrderType().Test(OrderDepotTypeFlag::Service)) return GetString(STR_ORDER_DROP_SERVICE_DEPOT);
1153 if (order->GetDepotActionType().Test(OrderDepotActionFlag::Halt)) return GetString(STR_ORDER_DROP_HALT_DEPOT);
1154 if (order->GetDepotActionType().Test(OrderDepotActionFlag::Unbunch)) return GetString(STR_ORDER_DROP_UNBUNCH);
1155
1156 return GetString(STR_ORDER_DROP_GO_ALWAYS_DEPOT);
1157 }
1158
1159 default:
1160 return this->Window::GetWidgetString(widget, stringid);
1161 }
1162 }
1163
1164 void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
1165 {
1166 switch (widget) {
1167 case WID_O_ORDER_LIST: {
1168 if (this->goto_type == OPOS_CONDITIONAL) {
1169 VehicleOrderID order_id = this->GetOrderFromPt(_cursor.pos.y - this->top);
1170 if (order_id != INVALID_VEH_ORDER_ID) {
1171 Order order{};
1172 order.MakeConditional(order_id);
1173
1174 Command<Commands::InsertOrder>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), order);
1175 }
1177 break;
1178 }
1179
1180 VehicleOrderID sel = this->GetOrderFromPt(pt.y);
1181
1182 if (_ctrl_pressed && sel < this->vehicle->GetNumOrders()) {
1183 TileIndex xy = this->vehicle->GetOrder(sel)->GetLocation(this->vehicle);
1184 if (xy != INVALID_TILE) ScrollMainWindowToTile(xy);
1185 return;
1186 }
1187
1188 /* This order won't be selected any more, close all child windows and dropdowns */
1189 this->CloseChildWindows();
1190
1191 if (sel == INVALID_VEH_ORDER_ID || this->vehicle->owner != _local_company) {
1192 /* Deselect clicked order */
1193 this->selected_order = -1;
1194 } else if (sel == this->selected_order && click_count > 1) {
1195 if (this->vehicle->type == VEH_TRAIN && sel < this->vehicle->GetNumOrders()) {
1196 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER,
1197 this->vehicle->tile, this->vehicle->index, sel,
1199 }
1200 } else {
1201 /* Select clicked order */
1202 this->selected_order = sel;
1203
1204 if (this->vehicle->owner == _local_company) {
1205 /* Activate drag and drop */
1207 }
1208 }
1209
1210 this->UpdateButtonState();
1211 break;
1212 }
1213
1214 case WID_O_SKIP:
1215 this->OrderClick_Skip();
1216 break;
1217
1218 case WID_O_DELETE:
1219 this->OrderClick_Delete();
1220 break;
1221
1222 case WID_O_STOP_SHARING:
1223 this->OrderClick_StopSharing();
1224 break;
1225
1226 case WID_O_NON_STOP:
1227 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1228 this->OrderClick_Nonstop(std::nullopt);
1229 } else {
1230 const Order *o = this->vehicle->GetOrder(this->OrderGetSel());
1231 assert(o != nullptr);
1232 ShowDropDownMenu(this, _order_non_stop_dropdown, o->GetNonStopType().base(), WID_O_NON_STOP, 0,
1233 o->IsType(OT_GOTO_STATION) ? 0 : (o->IsType(OT_GOTO_WAYPOINT) ? 3 : 12));
1234 }
1235 break;
1236
1237 case WID_O_GOTO:
1238 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1239 if (this->goto_type != OPOS_NONE) {
1241 } else {
1242 this->OrderClick_Goto(OPOS_GOTO);
1243 }
1244 } else {
1245 int sel;
1246 switch (this->goto_type) {
1247 case OPOS_NONE: sel = -1; break;
1248 case OPOS_GOTO: sel = 0; break;
1249 case OPOS_CONDITIONAL: sel = 2; break;
1250 case OPOS_SHARE: sel = 3; break;
1251 default: NOT_REACHED();
1252 }
1253 ShowDropDownMenu(this, this->vehicle->type == VEH_AIRCRAFT ? _order_goto_dropdown_aircraft : _order_goto_dropdown, sel, WID_O_GOTO, 0, 0);
1254 }
1255 break;
1256
1257 case WID_O_FULL_LOAD:
1258 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1260 } else {
1261 ShowDropDownMenu(this, _order_full_load_dropdown, to_underlying(this->vehicle->GetOrder(this->OrderGetSel())->GetLoadType()), WID_O_FULL_LOAD, 0, 2);
1262 }
1263 break;
1264
1265 case WID_O_UNLOAD:
1266 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1268 } else {
1269 ShowDropDownMenu(this, _order_unload_dropdown, to_underlying(this->vehicle->GetOrder(this->OrderGetSel())->GetUnloadType()), WID_O_UNLOAD, 0, 8);
1270 }
1271 break;
1272
1273 case WID_O_REFIT:
1274 this->OrderClick_Refit(0, false);
1275 break;
1276
1277 case WID_O_DEPOT_ACTION:
1278 ShowDropDownMenu(this, _order_depot_action_dropdown, to_underlying(DepotActionStringIndex(this->vehicle->GetOrder(this->OrderGetSel()))), WID_O_DEPOT_ACTION, 0, 0);
1279 break;
1280
1282 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1283 this->OrderClick_Refit(0, true);
1284 } else {
1285 ShowDropDownMenu(this, _order_refit_action_dropdown, 0, WID_O_REFIT_DROPDOWN, 0, 0);
1286 }
1287 break;
1288
1290 ShowTimetableWindow(this->vehicle);
1291 break;
1292
1293 case WID_O_COND_VARIABLE: {
1294 DropDownList list;
1295 for (const auto &ocv : _order_conditional_variable) {
1296 list.push_back(MakeDropDownListStringItem(STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + to_underlying(ocv), to_underlying(ocv)));
1297 }
1298 ShowDropDownList(this, std::move(list), to_underlying(this->vehicle->GetOrder(this->OrderGetSel())->GetConditionVariable()), WID_O_COND_VARIABLE);
1299 break;
1300 }
1301
1302 case WID_O_COND_COMPARATOR: {
1303 const Order *o = this->vehicle->GetOrder(this->OrderGetSel());
1304 assert(o != nullptr);
1306 break;
1307 }
1308
1309 case WID_O_COND_VALUE: {
1310 const Order *order = this->vehicle->GetOrder(this->OrderGetSel());
1311 assert(order != nullptr);
1312 uint value = order->GetConditionValue();
1313 if (order->GetConditionVariable() == OrderConditionVariable::MaxSpeed) value = ConvertSpeedToDisplaySpeed(value, this->vehicle->type);
1314 ShowQueryString(GetString(STR_JUST_INT, value), STR_ORDER_CONDITIONAL_VALUE_CAPT, 5, this, CS_NUMERAL, {});
1315 break;
1316 }
1317
1319 ShowVehicleListWindow(this->vehicle);
1320 break;
1321 }
1322 }
1323
1324 void OnQueryTextFinished(std::optional<std::string> str) override
1325 {
1326 if (!str.has_value() || str->empty()) return;
1327
1328 VehicleOrderID sel = this->OrderGetSel();
1329 auto value = ParseInteger(*str, 10, true);
1330 if (!value.has_value()) return;
1331
1332 switch (this->vehicle->GetOrder(sel)->GetConditionVariable()) {
1334 value = ConvertDisplaySpeedToSpeed(*value, this->vehicle->type);
1335 break;
1336
1339 value = Clamp(*value, 0, 100);
1340 break;
1341
1342 default:
1343 break;
1344 }
1345 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel, MOF_COND_VALUE, Clamp(*value, 0, 2047));
1346 }
1347
1348 void OnDropdownSelect(WidgetID widget, int index, int) override
1349 {
1350 switch (widget) {
1351 case WID_O_NON_STOP:
1352 this->OrderClick_Nonstop(static_cast<OrderNonStopFlags>(index));
1353 break;
1354
1355 case WID_O_FULL_LOAD:
1356 this->OrderClick_FullLoad(static_cast<OrderLoadType>(index));
1357 break;
1358
1359 case WID_O_UNLOAD:
1360 this->OrderClick_Unload(static_cast<OrderUnloadType>(index));
1361 break;
1362
1363 case WID_O_GOTO:
1364 switch (index) {
1365 case 0: this->OrderClick_Goto(OPOS_GOTO); break;
1366 case 1: this->OrderClick_NearestDepot(); break;
1367 case 2: this->OrderClick_Goto(OPOS_CONDITIONAL); break;
1368 case 3: this->OrderClick_Goto(OPOS_SHARE); break;
1369 default: NOT_REACHED();
1370 }
1371 break;
1372
1373 case WID_O_DEPOT_ACTION:
1374 this->OrderClick_Service(static_cast<OrderDepotAction>(index));
1375 break;
1376
1378 this->OrderClick_Refit(index, true);
1379 break;
1380
1382 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), MOF_COND_VARIABLE, index);
1383 break;
1384
1386 Command<Commands::ModifyOrder>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), MOF_COND_COMPARATOR, index);
1387 break;
1388 }
1389 }
1390
1391 void OnDragDrop(Point pt, WidgetID widget) override
1392 {
1393 switch (widget) {
1394 case WID_O_ORDER_LIST: {
1395 VehicleOrderID from_order = this->OrderGetSel();
1396 VehicleOrderID to_order = this->GetOrderFromPt(pt.y);
1397
1398 if (!(from_order == to_order || from_order == INVALID_VEH_ORDER_ID || from_order > this->vehicle->GetNumOrders() || to_order == INVALID_VEH_ORDER_ID || to_order > this->vehicle->GetNumOrders()) &&
1399 Command<Commands::MoveOrder>::Post(STR_ERROR_CAN_T_MOVE_THIS_ORDER, this->vehicle->tile, this->vehicle->index, from_order, to_order)) {
1400 this->selected_order = -1;
1401 this->UpdateButtonState();
1402 }
1403 break;
1404 }
1405
1406 case WID_O_DELETE:
1407 this->OrderClick_Delete();
1408 break;
1409
1410 case WID_O_STOP_SHARING:
1411 this->OrderClick_StopSharing();
1412 break;
1413 }
1414
1416
1417 if (this->order_over != INVALID_VEH_ORDER_ID) {
1418 /* End of drag-and-drop, hide dragged order destination highlight. */
1419 this->order_over = INVALID_VEH_ORDER_ID;
1421 }
1422 }
1423
1424 EventState OnHotkey(int hotkey) override
1425 {
1426 if (this->vehicle->owner != _local_company) return ES_NOT_HANDLED;
1427
1428 switch (hotkey) {
1429 case OHK_SKIP: this->OrderClick_Skip(); break;
1430 case OHK_DELETE: this->OrderClick_Delete(); break;
1431 case OHK_GOTO: this->OrderClick_Goto(OPOS_GOTO); break;
1432 case OHK_NONSTOP: this->OrderClick_Nonstop(std::nullopt); break;
1433 case OHK_FULLLOAD: this->OrderClick_FullLoad(OrderLoadType::FullLoadAny, true); break;
1434 case OHK_UNLOAD: this->OrderClick_Unload(OrderUnloadType::Unload, true); break;
1435 case OHK_NEAREST_DEPOT: this->OrderClick_NearestDepot(); break;
1436 case OHK_ALWAYS_SERVICE: this->OrderClick_Service(std::nullopt); break;
1437 case OHK_TRANSFER: this->OrderClick_Unload(OrderUnloadType::Transfer, true); break;
1438 case OHK_NO_UNLOAD: this->OrderClick_Unload(OrderUnloadType::NoUnload, true); break;
1439 case OHK_NO_LOAD: this->OrderClick_FullLoad(OrderLoadType::NoLoad, true); break;
1440 default: return ES_NOT_HANDLED;
1441 }
1442 return ES_HANDLED;
1443 }
1444
1445 void OnPlaceObject([[maybe_unused]] Point pt, TileIndex tile) override
1446 {
1447 if (this->goto_type == OPOS_GOTO) {
1448 const Order cmd = GetOrderCmdFromTile(this->vehicle, tile);
1449 if (cmd.IsType(OT_NOTHING)) return;
1450
1451 if (Command<Commands::InsertOrder>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), cmd)) {
1452 /* With quick goto the Go To button stays active */
1453 if (!_settings_client.gui.quick_goto) ResetObjectToPlace();
1454 }
1455 }
1456 }
1457
1458 bool OnVehicleSelect(const Vehicle *v) override
1459 {
1460 /* v is vehicle getting orders. Only copy/clone orders if vehicle doesn't have any orders yet.
1461 * We disallow copying orders of other vehicles if we already have at least one order entry
1462 * ourself as it easily copies orders of vehicles within a station when we mean the station.
1463 * Obviously if you press CTRL on a non-empty orders vehicle you know what you are doing
1464 * TODO: give a warning message */
1465 bool share_order = _ctrl_pressed || this->goto_type == OPOS_SHARE;
1466 if (this->vehicle->GetNumOrders() != 0 && !share_order) return false;
1467
1468 if (Command<Commands::CloneOrder>::Post(share_order ? STR_ERROR_CAN_T_SHARE_ORDER_LIST : STR_ERROR_CAN_T_COPY_ORDER_LIST,
1469 this->vehicle->tile, share_order ? CO_SHARE : CO_COPY, this->vehicle->index, v->index)) {
1470 this->selected_order = -1;
1472 }
1473 return true;
1474 }
1475
1484 bool OnVehicleSelect(VehicleList::const_iterator begin, VehicleList::const_iterator end) override
1485 {
1486 bool share_order = _ctrl_pressed || this->goto_type == OPOS_SHARE;
1487 if (this->vehicle->GetNumOrders() != 0 && !share_order) return false;
1488
1489 if (!share_order) {
1490 /* If CTRL is not pressed: If all the vehicles in this list have the same orders, then copy orders */
1491 if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
1492 return VehiclesHaveSameOrderList(v1, v2);
1493 })) {
1494 OnVehicleSelect(*begin);
1495 } else {
1496 ShowErrorMessage(GetEncodedString(STR_ERROR_CAN_T_COPY_ORDER_LIST), GetEncodedString(STR_ERROR_CAN_T_COPY_ORDER_VEHICLE_LIST), WL_INFO);
1497 }
1498 } else {
1499 /* If CTRL is pressed: If all the vehicles in this list share orders, then copy orders */
1500 if (AllEqual(begin, end, [](const Vehicle *v1, const Vehicle *v2) {
1501 return v1->FirstShared() == v2->FirstShared();
1502 })) {
1503 OnVehicleSelect(*begin);
1504 } else {
1505 ShowErrorMessage(GetEncodedString(STR_ERROR_CAN_T_SHARE_ORDER_LIST), GetEncodedString(STR_ERROR_CAN_T_SHARE_ORDER_VEHICLE_LIST), WL_INFO);
1506 }
1507 }
1508
1509 return true;
1510 }
1511
1512 void OnPlaceObjectAbort() override
1513 {
1514 this->goto_type = OPOS_NONE;
1516
1517 /* Remove drag highlighting if it exists. */
1518 if (this->order_over != INVALID_VEH_ORDER_ID) {
1519 this->order_over = INVALID_VEH_ORDER_ID;
1521 }
1522 }
1523
1524 void OnMouseDrag(Point pt, WidgetID widget) override
1525 {
1526 if (this->selected_order != -1 && widget == WID_O_ORDER_LIST) {
1527 /* An order is dragged.. */
1528 VehicleOrderID from_order = this->OrderGetSel();
1529 VehicleOrderID to_order = this->GetOrderFromPt(pt.y);
1530 uint num_orders = this->vehicle->GetNumOrders();
1531
1532 if (from_order != INVALID_VEH_ORDER_ID && from_order <= num_orders) {
1533 if (to_order != INVALID_VEH_ORDER_ID && to_order <= num_orders) { // ..over an existing order.
1534 this->order_over = to_order;
1535 this->SetWidgetDirty(widget);
1536 } else if (from_order != to_order && this->order_over != INVALID_VEH_ORDER_ID) { // ..outside of the order list.
1537 this->order_over = INVALID_VEH_ORDER_ID;
1538 this->SetWidgetDirty(widget);
1539 }
1540 }
1541 }
1542 }
1543
1544 void OnResize() override
1545 {
1546 /* Update the scroll bar */
1547 this->vscroll->SetCapacityFromWidget(this, WID_O_ORDER_LIST, WidgetDimensions::scaled.framerect.Vertical());
1548 }
1549
1550 static inline HotkeyList hotkeys{"order", {
1551 Hotkey('D', "skip", OHK_SKIP),
1552 Hotkey('F', "delete", OHK_DELETE),
1553 Hotkey('G', "goto", OHK_GOTO),
1554 Hotkey('H', "nonstop", OHK_NONSTOP),
1555 Hotkey('J', "fullload", OHK_FULLLOAD),
1556 Hotkey('K', "unload", OHK_UNLOAD),
1557 Hotkey(0, "nearest_depot", OHK_NEAREST_DEPOT),
1558 Hotkey(0, "always_service", OHK_ALWAYS_SERVICE),
1559 Hotkey(0, "transfer", OHK_TRANSFER),
1560 Hotkey(0, "no_unload", OHK_NO_UNLOAD),
1561 Hotkey(0, "no_load", OHK_NO_LOAD),
1562 }};
1563};
1564
1566static constexpr std::initializer_list<NWidgetPart> _nested_orders_train_widgets = {
1568 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1569 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION),
1570 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetStringTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1571 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1572 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1573 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1574 EndContainer(),
1576 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 62), SetToolTip(STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1578 EndContainer(),
1579
1580 /* First button row. */
1584 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_NON_STOP), SetMinimalSize(93, 12), SetFill(1, 0),
1585 SetStringTip(STR_ORDER_NON_STOP, STR_ORDER_TOOLTIP_NON_STOP), SetResize(1, 0),
1586 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_LEFT),
1587 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_FULL_LOAD), SetMinimalSize(93, 12), SetFill(1, 0),
1588 SetStringTip(STR_ORDER_TOGGLE_FULL_LOAD, STR_ORDER_TOOLTIP_FULL_LOAD), SetResize(1, 0),
1589 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_REFIT), SetMinimalSize(93, 12), SetFill(1, 0),
1590 SetStringTip(STR_ORDER_REFIT, STR_ORDER_REFIT_TOOLTIP), SetResize(1, 0),
1591 EndContainer(),
1593 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_UNLOAD), SetMinimalSize(93, 12), SetFill(1, 0),
1594 SetStringTip(STR_ORDER_TOGGLE_UNLOAD, STR_ORDER_TOOLTIP_UNLOAD), SetResize(1, 0),
1596 SetStringTip(STR_JUST_STRING), SetResize(1, 0),
1597 EndContainer(),
1598 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_RIGHT),
1599 NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(93, 12), SetFill(1, 0), SetResize(1, 0), EndContainer(),
1601 SetStringTip(STR_ORDER_REFIT_AUTO, STR_ORDER_REFIT_AUTO_TOOLTIP), SetResize(1, 0),
1602 EndContainer(),
1603 EndContainer(),
1605 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_VARIABLE), SetMinimalSize(124, 12), SetFill(1, 0),
1606 SetToolTip(STR_ORDER_CONDITIONAL_VARIABLE_TOOLTIP), SetResize(1, 0),
1607 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_COMPARATOR), SetMinimalSize(124, 12), SetFill(1, 0),
1608 SetToolTip(STR_ORDER_CONDITIONAL_COMPARATOR_TOOLTIP), SetResize(1, 0),
1609 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_COND_VALUE), SetMinimalSize(124, 12), SetFill(1, 0),
1610 SetToolTip(STR_ORDER_CONDITIONAL_VALUE_TOOLTIP), SetResize(1, 0),
1611 EndContainer(),
1612 EndContainer(),
1613 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_O_SHARED_ORDER_LIST), SetAspect(1), SetSpriteTip(SPR_SHARED_ORDERS_ICON, STR_ORDERS_VEH_WITH_SHARED_ORDERS_LIST_TOOLTIP),
1614 EndContainer(),
1615
1616 /* Second button row. */
1619 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_SKIP), SetMinimalSize(124, 12), SetFill(1, 0),
1620 SetStringTip(STR_ORDERS_SKIP_BUTTON, STR_ORDERS_SKIP_TOOLTIP), SetResize(1, 0),
1622 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_DELETE), SetMinimalSize(124, 12), SetFill(1, 0),
1623 SetStringTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP), SetResize(1, 0),
1624 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_STOP_SHARING), SetMinimalSize(124, 12), SetFill(1, 0),
1625 SetStringTip(STR_ORDERS_STOP_SHARING_BUTTON, STR_ORDERS_STOP_SHARING_TOOLTIP), SetResize(1, 0),
1626 EndContainer(),
1627 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_GOTO), SetMinimalSize(124, 12), SetFill(1, 0),
1628 SetStringTip(STR_ORDERS_GO_TO_BUTTON, STR_ORDERS_GO_TO_TOOLTIP), SetResize(1, 0),
1629 EndContainer(),
1630 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1631 EndContainer(),
1632};
1633
1634static WindowDesc _orders_train_desc(
1635 WDP_AUTO, "view_vehicle_orders_train", 384, 100,
1639 &OrdersWindow::hotkeys
1640);
1641
1643static constexpr std::initializer_list<NWidgetPart> _nested_orders_widgets = {
1645 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1646 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetStringTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1647 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetStringTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1648 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1649 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1650 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1651 EndContainer(),
1653 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 62), SetToolTip(STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1655 EndContainer(),
1656
1657 /* First button row. */
1659 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_ROW),
1660 /* Load + unload + refit buttons. */
1662 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_FULL_LOAD), SetMinimalSize(124, 12), SetFill(1, 0),
1663 SetStringTip(STR_ORDER_TOGGLE_FULL_LOAD, STR_ORDER_TOOLTIP_FULL_LOAD), SetResize(1, 0),
1664 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_UNLOAD), SetMinimalSize(124, 12), SetFill(1, 0),
1665 SetStringTip(STR_ORDER_TOGGLE_UNLOAD, STR_ORDER_TOOLTIP_UNLOAD), SetResize(1, 0),
1667 SetStringTip(STR_ORDER_REFIT_AUTO, STR_ORDER_REFIT_AUTO_TOOLTIP), SetResize(1, 0),
1668 EndContainer(),
1669 /* Refit + service buttons. */
1671 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_REFIT), SetMinimalSize(186, 12), SetFill(1, 0),
1672 SetStringTip(STR_ORDER_REFIT, STR_ORDER_REFIT_TOOLTIP), SetResize(1, 0),
1674 SetResize(1, 0),
1675 EndContainer(),
1676
1677 /* Buttons for setting a condition. */
1679 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_VARIABLE), SetMinimalSize(124, 12), SetFill(1, 0),
1680 SetToolTip(STR_ORDER_CONDITIONAL_VARIABLE_TOOLTIP), SetResize(1, 0),
1681 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_COMPARATOR), SetMinimalSize(124, 12), SetFill(1, 0),
1682 SetToolTip(STR_ORDER_CONDITIONAL_COMPARATOR_TOOLTIP), SetResize(1, 0),
1683 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_COND_VALUE), SetMinimalSize(124, 12), SetFill(1, 0),
1684 SetStringTip(STR_JUST_COMMA, STR_ORDER_CONDITIONAL_VALUE_TOOLTIP), SetResize(1, 0),
1685 EndContainer(),
1686 EndContainer(),
1687
1688 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_O_SHARED_ORDER_LIST), SetAspect(1), SetSpriteTip(SPR_SHARED_ORDERS_ICON, STR_ORDERS_VEH_WITH_SHARED_ORDERS_LIST_TOOLTIP),
1689 EndContainer(),
1690
1691 /* Second button row. */
1693 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_SKIP), SetMinimalSize(124, 12), SetFill(1, 0),
1694 SetStringTip(STR_ORDERS_SKIP_BUTTON, STR_ORDERS_SKIP_TOOLTIP), SetResize(1, 0),
1696 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_DELETE), SetMinimalSize(124, 12), SetFill(1, 0),
1697 SetStringTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP), SetResize(1, 0),
1698 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_STOP_SHARING), SetMinimalSize(124, 12), SetFill(1, 0),
1699 SetStringTip(STR_ORDERS_STOP_SHARING_BUTTON, STR_ORDERS_STOP_SHARING_TOOLTIP), SetResize(1, 0),
1700 EndContainer(),
1701 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_GOTO), SetMinimalSize(124, 12), SetFill(1, 0),
1702 SetStringTip(STR_ORDERS_GO_TO_BUTTON, STR_ORDERS_GO_TO_TOOLTIP), SetResize(1, 0),
1703 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1704 EndContainer(),
1705};
1706
1707static WindowDesc _orders_desc(
1708 WDP_AUTO, "view_vehicle_orders", 384, 100,
1712 &OrdersWindow::hotkeys
1713);
1714
1716static constexpr std::initializer_list<NWidgetPart> _nested_other_orders_widgets = {
1718 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1719 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetStringTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1720 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetStringTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1721 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1722 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1723 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1724 EndContainer(),
1726 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 72), SetToolTip(STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1729 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1730 EndContainer(),
1731 EndContainer(),
1732};
1733
1734static WindowDesc _other_orders_desc(
1735 WDP_AUTO, "view_vehicle_orders_competitor", 384, 86,
1739 &OrdersWindow::hotkeys
1740);
1741
1742void ShowOrdersWindow(const Vehicle *v)
1743{
1744 CloseWindowById(WC_VEHICLE_DETAILS, v->index, false);
1745 CloseWindowById(WC_VEHICLE_TIMETABLE, v->index, false);
1746 if (BringWindowToFrontById(WC_VEHICLE_ORDERS, v->index) != nullptr) return;
1747
1748 /* Using a different WindowDescs for _local_company causes problems.
1749 * Due to this we have to close order windows in ChangeWindowOwner/CloseCompanyWindows,
1750 * because we cannot change switch the WindowDescs and keeping the old WindowDesc results
1751 * in crashed due to missing widget.
1752 * TODO Rewrite the order GUI to not use different WindowDescs.
1753 */
1754 if (v->owner != _local_company) {
1755 new OrdersWindow(_other_orders_desc, v);
1756 } else {
1757 new OrdersWindow(v->IsGroundVehicle() ? _orders_train_desc : _orders_desc, v);
1758 }
1759}
Base for aircraft.
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
static const CargoType CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition cargo_type.h:76
static const CargoType CARGO_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-renew).
Definition cargo_type.h:77
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Tstorage base() const noexcept
Retrieve the raw value behind this bit set.
constexpr Timpl & Flip(Tvalue_type value)
Flip the value-th bit.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Base class for a 'real' widget.
void SetStringTip(StringID string, StringID tool_tip)
Set string and tool tip of the nested widget.
Definition widget.cpp:1167
Stacked widgets, widgets all occupying the same space in the window.
bool SetDisplayedPlane(int plane)
Select which plane to show (for NWID_SELECTION only).
Definition widget.cpp:1425
Scrollbar data structure.
bool IsVisible(size_type item) const
Checks whether given current item is visible in the list.
void SetCount(size_t num)
Sets the number of elements in the list.
size_type GetScrolledRowFromWidget(int clickpos, const Window *const w, WidgetID widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition widget.cpp:2428
void SetCapacityFromWidget(Window *w, WidgetID widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition widget.cpp:2502
void ScrollTowards(size_type position)
Scroll towards the given position; if the item is visible nothing happens, otherwise it will be shown...
size_type GetPosition() const
Gets the position of the first visible element in the list.
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition window_gui.h:30
Functions related to commands.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Command definitions related to companies.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
Map related accessors for depots.
bool IsDepotTypeTile(Tile tile, TransportType type)
Check if a tile is a depot and it is a depot of the given type.
Definition depot_map.h:22
DestinationID GetDepotDestinationIndex(Tile t)
Get the destination index of a 'depot'.
Definition depot_map.h:69
void ShowDropDownMenu(Window *w, std::span< const StringID > strings, int selected, WidgetID button, uint32_t disabled_mask, uint32_t hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition dropdown.cpp:459
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, DropDownOptions options)
Show a drop down list.
Definition dropdown.cpp:419
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.
bool IsEngineRefittable(EngineID engine)
Check if an engine is refittable.
Definition engine.cpp:1292
Functions related to engines.
@ AutoRefit
Automatic refitting is allowed.
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
Functions related to errors.
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition error.h:24
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
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.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition gfx.cpp:972
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition gfx.cpp:900
Dimension GetStringListBoundingBox(std::span< const StringID > list, FontSize fontsize)
Get maximum dimension of a list of strings.
Definition gfx.cpp:939
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition gfx.cpp:669
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
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
void GfxFillRect(int left, int top, int right, int bottom, const std::variant< PixelColour, PaletteID > &colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition gfx.cpp:116
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
@ SA_RIGHT
Right align the text (must be a single bit).
Definition gfx_type.h:390
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition gfx_type.h:400
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:307
@ TC_NO_SHADE
Do not add shading to this text colour.
Definition gfx_type.h:331
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 SetScrollbar(WidgetID index)
Attach a scrollbar to 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 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 NWidget(WidgetType tp, Colours col, WidgetID idx=INVALID_WIDGET)
Widget part function for starting a new 'real' widget.
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
void SetDirty() const
Mark entire window as dirty (in need of re-paint).
Definition window.cpp:979
Hotkey related functions.
Base of all industries.
#define Point
Macro that prevents name conflicts between included headers.
constexpr bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
void ShowQueryString(std::string_view str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
bool _networking
are we in networking mode?
Definition network.cpp:66
Basic functions/variables used all over the place.
@ Order
Something wrong with the order, e.g. invalid or duplicate entries, too few entries.
Definition news_type.h:54
uint GetOrderDistance(VehicleOrderID prev, VehicleOrderID cur, const Vehicle *v, int conditional_depth)
Get the distance between two orders of a vehicle.
Command definitions related to orders.
static constexpr std::initializer_list< NWidgetPart > _nested_orders_widgets
Nested widget definition for "your" orders (non-train).
static constexpr std::initializer_list< NWidgetPart > _nested_other_orders_widgets
Nested widget definition for competitor orders.
uint ConvertSpeedToDisplaySpeed(uint speed, VehicleType type)
Convert the given (internal) speed to the display speed.
Definition strings.cpp:969
static Order GetOrderCmdFromTile(const Vehicle *v, TileIndex tile)
Get the order command a vehicle can do in a given tile.
static const OrderConditionVariable _order_conditional_variable[]
Variables for conditional orders; this defines the order of appearance in the dropdown box.
OrderHotKeys
Hotkeys for order window.
static const StringID _station_load_types[][5][5]
Order load types that could be given to station orders.
Definition order_gui.cpp:47
static constexpr std::initializer_list< NWidgetPart > _nested_orders_train_widgets
Nested widget definition for "your" train orders.
uint ConvertDisplaySpeedToSpeed(uint speed, VehicleType type)
Convert the given display speed to the (internal) speed.
Definition strings.cpp:983
void DrawOrderString(const Vehicle *v, const Order *order, VehicleOrderID order_index, int y, bool selected, bool timetable, int left, int middle, int right)
Draws an order in order or timetable GUI.
OrderUnloadType
Unloading order types.
Definition order_type.h:67
@ Transfer
Transfer all cargo onto the platform.
Definition order_type.h:70
@ UnloadIfPossible
Unload all cargo that the station accepts.
Definition order_type.h:68
@ NoUnload
Totally no unloading will be done.
Definition order_type.h:71
@ Unload
Force unloading all cargo onto the platform, possibly not getting paid.
Definition order_type.h:69
OrderConditionVariable
Variables (of a vehicle) to 'cause' skipping on.
Definition order_type.h:128
@ Unconditionally
Always skip.
Definition order_type.h:134
@ MaxSpeed
Skip based on the maximum speed.
Definition order_type.h:131
@ Reliability
Skip based on the reliability.
Definition order_type.h:130
@ MaxReliability
Skip based on the maximum reliability.
Definition order_type.h:136
@ RequiresService
Skip when the vehicle requires service.
Definition order_type.h:133
@ LoadPercentage
Skip based on the amount of load.
Definition order_type.h:129
@ Age
Skip based on the age.
Definition order_type.h:132
@ RemainingLifetime
Skip based on the remaining lifetime.
Definition order_type.h:135
OrderStopLocation
Where to stop the trains.
Definition order_type.h:97
@ End
End marker.
Definition order_type.h:101
@ FarEnd
Stop at the far end of the platform.
Definition order_type.h:100
@ MOF_COND_VARIABLE
A conditional variable changes.
Definition order_type.h:165
@ MOF_LOAD
Passes an OrderLoadType.
Definition order_type.h:163
@ MOF_UNLOAD
Passes an OrderUnloadType.
Definition order_type.h:162
@ MOF_STOP_LOCATION
Passes an OrderStopLocation.
Definition order_type.h:161
@ MOF_COND_COMPARATOR
A comparator changes.
Definition order_type.h:166
@ MOF_COND_VALUE
The value to set the condition to.
Definition order_type.h:167
@ MOF_DEPOT_ACTION
Selects the OrderDepotAction.
Definition order_type.h:164
@ MOF_NON_STOP
Passes an OrderNonStopFlags.
Definition order_type.h:160
OrderDepotAction
Depot action to switch to when doing a MOF_DEPOT_ACTION.
Definition order_type.h:175
@ Stop
Go to the depot and stop there.
Definition order_type.h:178
@ AlwaysGo
Always go to the depot.
Definition order_type.h:176
@ Service
Service only if needed.
Definition order_type.h:177
@ Unbunch
Go to the depot and unbunch.
Definition order_type.h:179
@ NoDestination
The vehicle will stop at any station it passes except the destination, aka via.
Definition order_type.h:89
@ NoIntermediate
The vehicle will not stop at any stations it passes except the destination, aka non-stop.
Definition order_type.h:88
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related).
Definition order_type.h:18
OrderLoadType
Loading order types.
Definition order_type.h:77
@ NoLoad
Do not load anything.
Definition order_type.h:81
@ FullLoadAny
Full load a single cargo of the consist.
Definition order_type.h:80
@ LoadIfPossible
Load as long as there is cargo that fits in the train.
Definition order_type.h:78
@ Halt
Service the vehicle and then halt it.
Definition order_type.h:118
@ NearestDepot
Send the vehicle to the nearest depot.
Definition order_type.h:119
@ Unbunch
Service the vehicle and then unbunch it.
Definition order_type.h:120
@ PartOfOrders
This depot order is because of a regular order.
Definition order_type.h:109
@ Service
This depot order is because of the servicing limit.
Definition order_type.h:108
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel).
Definition order_type.h:39
OrderConditionComparator
Comparator for the skip reasoning.
Definition order_type.h:143
@ IsTrue
Skip if the variable is true.
Definition order_type.h:150
@ IsFalse
Skip if the variable is false.
Definition order_type.h:151
Types related to the order widgets.
@ WID_O_TIMETABLE_VIEW
Toggle timetable view.
@ WID_O_SHARED_ORDER_LIST
Open list of shared vehicles.
@ WID_O_SKIP
Skip current order.
@ WID_O_SCROLLBAR
Order list scrollbar.
@ WID_O_SEL_TOP_MIDDLE
NWID_SELECTION widget for middle part of the top row of the 'your train' order window.
@ WID_O_SEL_BOTTOM_MIDDLE
NWID_SELECTION widget for the middle part of the bottom row of the 'your train' order window.
@ WID_O_REFIT
Select refit.
@ WID_O_ORDER_LIST
Order list panel.
@ WID_O_COND_VARIABLE
Choose condition variable.
@ WID_O_SEL_TOP_ROW
NWID_SELECTION widget for the top row of the 'your non-trains' order window.
@ WID_O_DELETE
Delete selected order.
@ WID_O_STOP_SHARING
Stop sharing orders.
@ WID_O_COND_COMPARATOR
Choose condition type.
@ WID_O_CAPTION
Caption of the window.
@ WID_O_UNLOAD
Select unload.
@ WID_O_SEL_TOP_LEFT
NWID_SELECTION widget for left part of the top row of the 'your train' order window.
@ WID_O_DEPOT_ACTION
Dropdown to select the depot action (stop, service if needed, unbunch).
@ WID_O_REFIT_DROPDOWN
Open refit options.
@ WID_O_SEL_TOP_RIGHT
NWID_SELECTION widget for right part of the top row of the 'your train' order window.
@ WID_O_NON_STOP
Goto non-stop to destination.
@ WID_O_COND_VALUE
Choose condition value.
@ WID_O_FULL_LOAD
Select full load.
@ WID_O_SEL_TOP_ROW_GROUNDVEHICLE
NWID_SELECTION widget for the top row of the 'your train' order window.
@ WID_O_GOTO
Goto destination.
PixelColour GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:388
Road vehicle states.
A number of safeguards to prevent using unsafe methods.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
static const CursorID ANIMCURSOR_PICKSTATION
716 - 718 - goto-order icon
Definition sprites.h:1525
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition sprites.h:1404
Base classes/functions for stations.
bool IsRailWaypointTile(Tile t)
Is this tile a station tile and a rail waypoint?
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
bool IsRoadWaypointTile(Tile t)
Is this tile a station tile and a road waypoint?
bool IsBuoyTile(Tile t)
Is tile t a buoy tile?
@ Dock
Station with a dock.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ Airport
Station with an airport.
@ BusStop
Station with bus stops.
Definition of base types and functions in a cross-platform compatible way.
Parse strings.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
Functions related to low-level strings.
@ CS_NUMERAL
Only numeric ones.
Definition string_type.h:26
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
Get some number that is suitable for string size computations.
Definition strings.cpp:236
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
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition strings.cpp:56
Functions related to OTTD's strings.
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).
@ TD_RTL
Text is written right-to-left by default.
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
StationFacilities facilities
The facilities that this station has.
Owner owner
The owner of this station.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
VehicleType type
Type of vehicle.
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:138
GUISettings gui
settings related to the GUI
T y
Y coordinate.
Dimensions (a width and height) of a rectangle in 2D.
bool quick_goto
Allow quick access to 'goto button' in vehicle orders window.
List of hotkeys for a window.
Definition hotkeys.h:37
All data for a single hotkey.
Definition hotkeys.h:21
Defines the internal data of a functional industry.
Definition industry.h:62
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition industry.h:251
Station * neutral_station
Associated neutral station.
Definition industry.h:108
VehicleOrderID GetNext(VehicleOrderID cur) const
Get the order after the given one or the first one, if the given one is the last one.
Definition order_base.h:475
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
bool IsGotoOrder() const
Is this a 'goto' order with a real destination?
Definition order_base.h:89
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition order_base.h:169
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
Definition order_base.h:181
DestinationID GetDestination() const
Gets the destination of this order.
Definition order_base.h:99
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:66
void SetNonStopType(OrderNonStopFlags non_stop_type)
Set whether we must stop at stations or not.
Definition order_base.h:217
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition order_base.h:193
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition order_base.h:163
uint16_t GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition order_base.h:293
CargoType GetRefitCargo() const
Get the cargo to to refit to.
Definition order_base.h:127
OrderType GetType() const
Get the type of order of this order.
Definition order_base.h:72
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
Definition order_cmd.cpp:58
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
Definition order_base.h:223
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
Definition order_cmd.cpp:87
OrderUnloadType GetUnloadType() const
How must the consist be unloaded?
Definition order_base.h:151
void MakeGoToDepot(DestinationID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=OrderNonStopFlag::NoIntermediate, OrderDepotActionFlags action={}, CargoType cargo=CARGO_NO_REFIT)
Makes this order a Go To Depot order.
Definition order_cmd.cpp:73
bool IsWaitTimetabled() const
Does this order have an explicit wait time set?
Definition order_base.h:270
void MakeConditional(VehicleOrderID order)
Makes this order an conditional order.
void SetDepotActionType(OrderDepotActionFlags depot_service_type)
Set what we are going to do in the depot.
Definition order_base.h:235
OrderLoadType GetLoadType() const
How must the consist be loaded?
Definition order_base.h:145
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition order_base.h:175
void Free()
'Free' the order
Definition order_cmd.cpp:47
void SetLoadType(OrderLoadType load_type)
Set how the consist must be loaded.
Definition order_base.h:205
bool IsAutoRefit() const
Is this order a auto-refit order.
Definition order_base.h:120
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
Definition order_base.h:187
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition order_base.h:157
bool IsRefit() const
Is this order a refit order.
Definition order_base.h:113
uint16_t GetConditionValue() const
Get the value to base the skip on.
Definition order_base.h:199
Order window code for all vehicles.
void OrderClick_Refit(int i, bool auto_refit)
Handle the click on the refit button.
void OnDropdownSelect(WidgetID widget, int index, int) override
A dropdown option associated to this window has been selected.
void OrderClick_Delete()
Handle the click on the delete button.
void OnResize() override
Called after the window got resized.
void OrderClick_Skip()
Handle the click on the skip button.
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
bool OnVehicleSelect(VehicleList::const_iterator begin, VehicleList::const_iterator end) override
Clones an order list from a vehicle list.
void OrderClick_FullLoad(OrderLoadType load_type, bool toggle=false)
Handle the click on the full load button.
const Vehicle * vehicle
Vehicle owning the orders being displayed and manipulated.
void DrawWidget(const Rect &r, WidgetID widget) const override
Draw the contents of a nested widget.
bool can_do_refit
Vehicle chain can be refitted in depot.
EventState OnHotkey(int hotkey) override
A hotkey has been pressed.
DisplayPane
Displayed planes of the NWID_SELECTION widgets.
@ DP_BOTTOM_MIDDLE_DELETE
Display 'delete' in the middle button of the bottom row of the vehicle order window.
@ DP_ROW_CONDITIONAL
Display the conditional order buttons in the top row of the ship/airplane order window.
@ DP_ROW_DEPOT
Display 'refit' / 'service' buttons in the top row of the ship/airplane order window.
@ DP_BOTTOM_MIDDLE_STOP_SHARING
Display 'stop sharing' in the middle button of the bottom row of the vehicle order window.
@ DP_MIDDLE_UNLOAD
Display 'unload' in the middle button of the top row of the train/rv order window.
@ DP_LEFT_LOAD
Display 'load' in the left button of the top row of the train/rv order window.
@ DP_RIGHT_EMPTY
Display an empty panel in the right button of the top row of the train/rv order window.
@ DP_RIGHT_REFIT
Display 'refit' in the right button of the top row of the train/rv order window.
@ DP_ROW_LOAD
Display 'load' / 'unload' / 'refit' buttons in the top row of the ship/airplane order window.
@ DP_MIDDLE_SERVICE
Display 'service' in the middle button of the top row of the train/rv order window.
@ DP_GROUNDVEHICLE_ROW_CONDITIONAL
Display the row for conditional orders in the top row of the train/rv order window.
@ DP_LEFT_REFIT
Display 'refit' in the left button of the top row of the train/rv order window.
@ DP_GROUNDVEHICLE_ROW_NORMAL
Display the row for normal/depot orders in the top row of the train/rv order window.
void OrderClick_NearestDepot()
Handle the click on the service in nearest depot button.
void OrderClick_StopSharing()
Handle the click on the 'stop sharing' button.
VehicleOrderID OrderGetSel() const
Return the memorised selected order.
void UpdateAutoRefitState()
Cache auto-refittability of the vehicle chain.
void OnPaint() override
The window must be repainted.
void OnDragDrop(Point pt, WidgetID widget) override
A dragged 'object' has been released.
void OnClick(Point pt, WidgetID widget, int click_count) override
A click with the left mouse button has been made on the window.
void OnMouseDrag(Point pt, WidgetID widget) override
An 'object' is being dragged at the provided position, highlight the target if possible.
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.
OrderPlaceObjectState
Under what reason are we using the PlaceObject functionality?
void OrderClick_Unload(OrderUnloadType unload_type, bool toggle=false)
Handle the click on the unload button.
void OnPlaceObject(Point pt, TileIndex tile) override
The user clicked some place on the map when a tile highlight mode has been set.
void OnPlaceObjectAbort() override
The user cancelled a tile highlight mode that has been set.
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
Get the raw string for a widget.
VehicleOrderID GetOrderFromPt(int y)
Calculate the selected order.
void OrderClick_Service(std::optional< OrderDepotAction > i)
Handle the click on the service.
bool can_do_autorefit
Vehicle chain can be auto-refitted.
void OrderClick_Nonstop(std::optional< OrderNonStopFlags > non_stop)
Handle the click on the nonstop button.
void OnQueryTextFinished(std::optional< std::string > str) override
The query window opened from this window has closed.
void OrderClick_Goto(OrderPlaceObjectState type)
Handle the click on the goto button.
VehicleOrderID order_over
Order over which another order is dragged, INVALID_VEH_ORDER_ID if none.
static Engine * Get(auto index)
Specification of a rectangle with absolute coordinates of all edges.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
static Station * Get(auto index)
Station data structure.
Vehicle data structure.
bool IsOrderListShared() const
Check if we share our orders with another vehicle.
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
OrderList * orders
Pointer to the order list for this vehicle.
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Vehicle * PreviousShared() const
Get the previous vehicle of the shared vehicle chain.
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
TileIndex tile
Current tile index.
Owner owner
Which company owns the vehicle?
High level window description.
Definition window_gui.h:168
Data structure for an opened window.
Definition window_gui.h:274
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition window.cpp:1821
void DrawWidgets() const
Paint all widgets of a window.
Definition widget.cpp:768
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:569
virtual std::string GetWidgetString(WidgetID widget, StringID stringid) const
Get the raw string for a widget.
Definition window.cpp:517
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
Definition window.cpp:1088
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:1811
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition window_gui.h:317
void SetWidgetLoweredState(WidgetID widget_index, bool lowered_stat)
Sets the lowered/raised status of a widget.
Definition window_gui.h:442
void EnableWidget(WidgetID widget_index)
Sets a widget to Enabled.
Definition window_gui.h:401
int top
y position of top edge of the window
Definition window_gui.h:311
Window(WindowDesc &desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition window.cpp:1844
const NWID * GetWidget(WidgetID widnum) const
Get the nested widget with number widnum from the nested widget tree.
Definition window_gui.h:990
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
Definition window.cpp:326
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Definition window_gui.h:382
WindowNumber window_number
Window number within the window class.
Definition window_gui.h:303
Stuff related to the text buffer GUI.
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
bool IsTileOwner(Tile tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition tile_map.h:214
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
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Industry
Part of an industry.
Definition tile_type.h:57
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
HighLightStyle
Highlighting draw styles.
@ HT_DRAG
dragging items in the depot windows
@ HT_NONE
default
@ HT_RECT
rectangle (stations, depots, ...)
@ HT_VEHICLE
vehicle is accepted as target as well (bitmask)
Functions related to time tabling.
void ShowTimetableWindow(const Vehicle *v)
Show the timetable for a given vehicle.
std::pair< StringParameter, StringParameter > GetTimetableParameters(TimerGameTick::Ticks ticks)
Get parameters to format timetable time.
TransportType
Available types of transport.
bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicles have the same list of orders.
Definition vehicle.cpp:3306
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition vehicle.cpp:3075
Functions related to vehicles.
void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order, Window *parent, bool auto_refit)
Show the refit window for a vehicle.
@ VIWD_CONSIST_CHANGED
Vehicle composition was changed.
Definition vehicle_gui.h:37
@ VIWD_AUTOREPLACE
Autoreplace replaced the vehicle.
Definition vehicle_gui.h:38
@ VIWD_MODIFY_ORDERS
Other order modifications.
Definition vehicle_gui.h:36
@ VIWD_REMOVE_ALL_ORDERS
Removed / replaced all orders (after deleting / sharing).
Definition vehicle_gui.h:35
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
Functions and type for generating vehicle lists.
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Functions related to (drawing on) viewports.
Base of waypoints.
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
@ WWT_PUSHIMGBTN
Normal push-button (no toggle button) with image caption.
@ NWID_BUTTON_DROPDOWN
Button with a drop-down.
Definition widget_type.h:74
@ NWID_HORIZONTAL
Horizontal container.
Definition widget_type.h:66
@ 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_VSCROLLBAR
Vertical scrollbar.
Definition widget_type.h:76
@ 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_RESIZEBOX
Resize box (normally at bottom-right of a window).
Definition widget_type.h:59
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX).
Definition widget_type.h:56
@ WWT_DROPDOWN
Drop down list.
Definition widget_type.h:61
@ NWID_SELECTION
Stacked widgets, only one visible at a time (eg in a panel with tabs).
Definition widget_type.h:71
@ EqualSize
Containers should keep all their (resizing) children equally large.
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:1208
Window * BringWindowToFrontById(WindowClass cls, WindowNumber number)
Find a window and make it the relative top-window on the screen.
Definition window.cpp:1292
@ Construction
This window is used for construction; close it whenever changing company.
Definition window_gui.h:153
bool AllEqual(It begin, It end, Pred pred)
Generic helper function that checks if all elements of the range are equal with respect to the given ...
Definition window_gui.h:953
@ WDP_AUTO
Find a place automatically.
Definition window_gui.h:144
int WidgetID
Widget ID.
Definition window_type.h:20
EventState
State of handling an event.
@ ES_HANDLED
The passed event is handled.
@ ES_NOT_HANDLED
The passed event is not handled.
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers: