OpenTTD Source 20260206-master-g4d4e37dbf1
order_cmd.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 "debug.h"
12#include "command_func.h"
13#include "company_func.h"
14#include "news_func.h"
15#include "strings_func.h"
16#include "timetable.h"
17#include "vehicle_func.h"
18#include "depot_base.h"
19#include "core/pool_func.hpp"
20#include "aircraft.h"
21#include "roadveh.h"
22#include "station_base.h"
23#include "waypoint_base.h"
24#include "company_base.h"
25#include "order_backup.h"
26#include "cheat_type.h"
27#include "order_cmd.h"
28#include "train_cmd.h"
29
30#include "table/strings.h"
31
32#include "safeguards.h"
33
34/* DestinationID must be at least as large as every these below, because it can
35 * be any of them
36 */
37static_assert(sizeof(DestinationID) >= sizeof(DepotID));
38static_assert(sizeof(DestinationID) >= sizeof(StationID));
39
40OrderListPool _orderlist_pool("OrderList");
42
43
47void Order::Free()
48{
49 this->type = OT_NOTHING;
50 this->flags = 0;
51 this->dest = 0;
52}
53
58void Order::MakeGoToStation(StationID destination)
59{
60 this->type = OT_GOTO_STATION;
61 this->flags = 0;
62 this->dest = destination;
63}
64
73void Order::MakeGoToDepot(DestinationID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type, OrderDepotActionFlags action, CargoType cargo)
74{
75 this->type = OT_GOTO_DEPOT;
76 this->SetDepotOrderType(order);
77 this->SetDepotActionType(action);
78 this->SetNonStopType(non_stop_type);
79 this->dest = destination;
80 this->SetRefit(cargo);
81}
82
87void Order::MakeGoToWaypoint(StationID destination)
88{
89 this->type = OT_GOTO_WAYPOINT;
90 this->flags = 0;
91 this->dest = destination;
92}
93
98void Order::MakeLoading(bool ordered)
99{
100 this->type = OT_LOADING;
101 if (!ordered) this->flags = 0;
102}
103
108{
109 this->type = OT_LEAVESTATION;
110 this->flags = 0;
111}
112
117{
118 this->type = OT_DUMMY;
119 this->flags = 0;
120}
121
127{
128 this->type = OT_CONDITIONAL;
129 this->flags = order;
130 this->dest = 0;
131}
132
137void Order::MakeImplicit(StationID destination)
138{
139 this->type = OT_IMPLICIT;
140 this->dest = destination;
141}
142
149{
150 this->refit_cargo = cargo;
151}
152
158bool Order::Equals(const Order &other) const
159{
160 /* In case of go to nearest depot orders we need "only" compare the flags
161 * with the other and not the nearest depot order bit or the actual
162 * destination because those get clear/filled in during the order
163 * evaluation. If we do not do this the order will continuously be seen as
164 * a different order and it will try to find a "nearest depot" every tick. */
165 if ((this->IsType(OT_GOTO_DEPOT) && this->type == other.type) &&
166 (this->GetDepotActionType().Test(OrderDepotActionFlag::NearestDepot) ||
168 return this->GetDepotOrderType() == other.GetDepotOrderType() &&
170 }
171
172 return this->type == other.type && this->flags == other.flags && this->dest == other.dest;
173}
174
180uint16_t Order::MapOldOrder() const
181{
182 uint16_t order = this->GetType();
183 switch (this->GetType()) {
184 case OT_GOTO_STATION:
185 if (this->GetUnloadType() == OrderUnloadType::Unload) SetBit(order, 5);
186 if (this->IsFullLoadOrder()) SetBit(order, 6);
187 if (this->GetNonStopType().Test(OrderNonStopFlag::NoIntermediate)) SetBit(order, 7);
188 order |= GB(this->GetDestination().value, 0, 8) << 8;
189 break;
190 case OT_GOTO_DEPOT:
191 if (!this->GetDepotOrderType().Test(OrderDepotTypeFlag::PartOfOrders)) SetBit(order, 6);
192 SetBit(order, 7);
193 order |= GB(this->GetDestination().value, 0, 8) << 8;
194 break;
195 case OT_LOADING:
196 if (this->IsFullLoadOrder()) SetBit(order, 6);
197 /* If both "no load" and "no unload" are set, return nothing order instead */
199 order = OT_NOTHING;
200 }
201 break;
202 default:
203 break;
204 }
205 return order;
206}
207
213void InvalidateVehicleOrder(const Vehicle *v, int data)
214{
216
217 if (data != 0) {
218 /* Calls SetDirty() too */
221 return;
222 }
223
226}
227
235void Order::AssignOrder(const Order &other)
236{
237 this->type = other.type;
238 this->flags = other.flags;
239 this->dest = other.dest;
240
241 this->refit_cargo = other.refit_cargo;
242
243 this->wait_time = other.wait_time;
244 this->travel_time = other.travel_time;
245 this->max_speed = other.max_speed;
246}
247
253{
254 this->first_shared = v;
255
256 this->num_manual_orders = 0;
257 this->num_vehicles = 1;
258 this->timetable_duration = 0;
259
260 for (const Order &o : this->orders) {
261 if (!o.IsType(OT_IMPLICIT)) ++this->num_manual_orders;
262 this->total_duration += o.GetWaitTime() + o.GetTravelTime();
263 }
264
266
267 for (Vehicle *u = this->first_shared->PreviousShared(); u != nullptr; u = u->PreviousShared()) {
268 ++this->num_vehicles;
269 this->first_shared = u;
270 }
271
272 for (const Vehicle *u = v->NextShared(); u != nullptr; u = u->NextShared()) ++this->num_vehicles;
273}
274
280{
281 this->timetable_duration = 0;
282 for (const Order &o : this->orders) {
283 this->timetable_duration += o.GetTimetabledWait() + o.GetTimetabledTravel();
284 }
285}
286
292void OrderList::FreeChain(bool keep_orderlist)
293{
294 /* We can visit oil rigs and buoys that are not our own. They will be shown in
295 * the list of stations. So, we need to invalidate that window if needed. */
296 for (Order &order: this->orders) {
297 if (order.IsType(OT_GOTO_STATION) || order.IsType(OT_GOTO_WAYPOINT)) {
298 BaseStation *bs = BaseStation::GetIfValid(order.GetDestination().ToStationID());
299 if (bs != nullptr && bs->owner == OWNER_NONE) {
301 break;
302 }
303 }
304 }
305
306 if (keep_orderlist) {
307 this->orders.clear();
308 this->num_manual_orders = 0;
309 this->timetable_duration = 0;
310 } else {
311 delete this;
312 }
313}
314
327{
328 if (hops > this->GetNumOrders() || next >= this->GetNumOrders()) return INVALID_VEH_ORDER_ID;
329
330 const Order &order_next = this->orders[next];
331 if (order_next.IsType(OT_CONDITIONAL)) {
332 if (order_next.GetConditionVariable() != OrderConditionVariable::Unconditionally) return next;
333
334 /* We can evaluate trivial conditions right away. They're conceptually
335 * the same as regular order progression. */
336 return this->GetNextDecisionNode(
337 order_next.GetConditionSkipToOrder(),
338 hops + 1);
339 }
340
341 if (order_next.IsType(OT_GOTO_DEPOT)) {
343 if (order_next.IsRefit()) return next;
344 }
345
346 if (!order_next.CanLoadOrUnload()) {
347 return this->GetNextDecisionNode(this->GetNext(next), hops + 1);
348 }
349
350 return next;
351}
352
363void OrderList::GetNextStoppingStation(std::vector<StationID> &next_station, const Vehicle *v, VehicleOrderID first, uint hops) const
364{
365 VehicleOrderID next = first;
366 if (first == INVALID_VEH_ORDER_ID) {
367 next = v->cur_implicit_order_index;
368 if (next >= this->GetNumOrders()) {
369 next = this->GetFirstOrder();
370 if (next == INVALID_VEH_ORDER_ID) return;
371 } else {
372 /* GetNext never returns INVALID_VEH_ORDER_ID if there is a valid station in the list.
373 * As the given "next" is already valid and a station in the list, we
374 * don't have to check for INVALID_VEH_ORDER_ID here. */
375 next = this->GetNext(next);
376 assert(next != INVALID_VEH_ORDER_ID);
377 }
378 }
379
380 auto orders = v->Orders();
381 do {
382 next = this->GetNextDecisionNode(next, ++hops);
383
384 /* Resolve possibly nested conditionals by estimation. */
385 while (next != INVALID_VEH_ORDER_ID && orders[next].IsType(OT_CONDITIONAL)) {
386 /* We return both options of conditional orders. */
387 VehicleOrderID skip_to = this->GetNextDecisionNode(orders[next].GetConditionSkipToOrder(), hops);
388 VehicleOrderID advance = this->GetNextDecisionNode(this->GetNext(next), hops);
389 if (advance == INVALID_VEH_ORDER_ID || advance == first || skip_to == advance) {
390 next = (skip_to == first) ? INVALID_VEH_ORDER_ID : skip_to;
391 } else if (skip_to == INVALID_VEH_ORDER_ID || skip_to == first) {
392 next = (advance == first) ? INVALID_VEH_ORDER_ID : advance;
393 } else {
394 this->GetNextStoppingStation(next_station, v, skip_to, hops);
395 this->GetNextStoppingStation(next_station, v, advance, hops);
396 return;
397 }
398 ++hops;
399 }
400
401 /* Don't return a next stop if the vehicle has to unload everything. */
402 if (next == INVALID_VEH_ORDER_ID || ((orders[next].IsType(OT_GOTO_STATION) || orders[next].IsType(OT_IMPLICIT)) &&
403 orders[next].GetDestination() == v->last_station_visited &&
404 (orders[next].GetUnloadType() == OrderUnloadType::Transfer || orders[next].GetUnloadType() == OrderUnloadType::Unload))) {
405 return;
406 }
407 } while (orders[next].IsType(OT_GOTO_DEPOT) || orders[next].GetDestination() == v->last_station_visited);
408
409 next_station.push_back(orders[next].GetDestination().ToStationID());
410}
411
418{
419 auto it = std::ranges::next(std::begin(this->orders), index, std::end(this->orders));
420 auto new_order = this->orders.emplace(it, std::move(order));
421
422 if (!new_order->IsType(OT_IMPLICIT)) ++this->num_manual_orders;
423 this->timetable_duration += new_order->GetTimetabledWait() + new_order->GetTimetabledTravel();
424 this->total_duration += new_order->GetWaitTime() + new_order->GetTravelTime();
425
426 /* We can visit oil rigs and buoys that are not our own. They will be shown in
427 * the list of stations. So, we need to invalidate that window if needed. */
428 if (new_order->IsType(OT_GOTO_STATION) || new_order->IsType(OT_GOTO_WAYPOINT)) {
429 BaseStation *bs = BaseStation::Get(new_order->GetDestination().ToStationID());
431 }
432}
433
434
440{
441 auto to_remove = std::ranges::next(std::begin(this->orders), index, std::end(this->orders));
442 if (to_remove == std::end(this->orders)) return;
443
444 if (!to_remove->IsType(OT_IMPLICIT)) --this->num_manual_orders;
445
446 this->timetable_duration -= (to_remove->GetTimetabledWait() + to_remove->GetTimetabledTravel());
447 this->total_duration -= (to_remove->GetWaitTime() + to_remove->GetTravelTime());
448
449 this->orders.erase(to_remove);
450}
451
458{
459 if (from == to) return;
460 if (from >= this->GetNumOrders()) return;
461 if (to >= this->GetNumOrders()) return;
462
463 auto it = std::begin(this->orders);
464 if (from < to) {
465 std::rotate(it + from, it + from + 1, it + to + 1);
466 } else {
467 std::rotate(it + to, it + from, it + from + 1);
468 }
469}
470
477{
478 --this->num_vehicles;
479 if (v == this->first_shared) this->first_shared = v->NextShared();
480}
481
487{
488 for (const Order &o : this->orders) {
489 /* Implicit orders are, by definition, not timetabled. */
490 if (o.IsType(OT_IMPLICIT)) continue;
491 if (!o.IsCompletelyTimetabled()) return false;
492 }
493 return true;
494}
495
496#ifdef WITH_ASSERT
500void OrderList::DebugCheckSanity() const
501{
502 VehicleOrderID check_num_orders = 0;
503 VehicleOrderID check_num_manual_orders = 0;
504 uint check_num_vehicles = 0;
505 TimerGameTick::Ticks check_timetable_duration = 0;
506 TimerGameTick::Ticks check_total_duration = 0;
507
508 Debug(misc, 6, "Checking OrderList {} for sanity...", this->index);
509
510 for (const Order &o : this->orders) {
511 ++check_num_orders;
512 if (!o.IsType(OT_IMPLICIT)) ++check_num_manual_orders;
513 check_timetable_duration += o.GetTimetabledWait() + o.GetTimetabledTravel();
514 check_total_duration += o.GetWaitTime() + o.GetTravelTime();
515 }
516 assert(this->GetNumOrders() == check_num_orders);
517 assert(this->num_manual_orders == check_num_manual_orders);
518 assert(this->timetable_duration == check_timetable_duration);
519 assert(this->total_duration == check_total_duration);
520
521 for (const Vehicle *v = this->first_shared; v != nullptr; v = v->NextShared()) {
522 ++check_num_vehicles;
523 assert(v->orders == this);
524 }
525 assert(this->num_vehicles == check_num_vehicles);
526 Debug(misc, 6, "... detected {} orders ({} manual), {} vehicles, {} timetabled, {} total",
527 (uint)this->GetNumOrders(), (uint)this->num_manual_orders,
529}
530#endif
531
539static inline bool OrderGoesToStation(const Vehicle *v, const Order &o)
540{
541 return o.IsType(OT_GOTO_STATION) ||
542 (v->type == VEH_AIRCRAFT && o.IsType(OT_GOTO_DEPOT) && o.GetDestination() != StationID::Invalid());
543}
544
551static void DeleteOrderWarnings(const Vehicle *v)
552{
554}
555
562TileIndex Order::GetLocation(const Vehicle *v, bool airport) const
563{
564 switch (this->GetType()) {
565 case OT_GOTO_WAYPOINT:
566 case OT_GOTO_STATION:
567 case OT_IMPLICIT:
568 if (airport && v->type == VEH_AIRCRAFT) return Station::Get(this->GetDestination().ToStationID())->airport.tile;
569 return BaseStation::Get(this->GetDestination().ToStationID())->xy;
570
571 case OT_GOTO_DEPOT:
572 if (this->GetDestination() == DepotID::Invalid()) return INVALID_TILE;
573 return (v->type == VEH_AIRCRAFT) ? Station::Get(this->GetDestination().ToStationID())->xy : Depot::Get(this->GetDestination().ToDepotID())->xy;
574
575 default:
576 return INVALID_TILE;
577 }
578}
579
589uint GetOrderDistance(VehicleOrderID prev, VehicleOrderID cur, const Vehicle *v, int conditional_depth)
590{
591 assert(v->orders != nullptr);
592 const OrderList &orderlist = *v->orders;
593 auto orders = orderlist.GetOrders();
594
595 if (orders[cur].IsType(OT_CONDITIONAL)) {
596 if (conditional_depth > v->GetNumOrders()) return 0;
597
598 conditional_depth++;
599
600 int dist1 = GetOrderDistance(prev, orders[cur].GetConditionSkipToOrder(), v, conditional_depth);
601 int dist2 = GetOrderDistance(prev, orderlist.GetNext(cur), v, conditional_depth);
602 return std::max(dist1, dist2);
603 }
604
605 TileIndex prev_tile = orders[prev].GetLocation(v, true);
606 TileIndex cur_tile = orders[cur].GetLocation(v, true);
607 if (prev_tile == INVALID_TILE || cur_tile == INVALID_TILE) return 0;
608 return v->type == VEH_AIRCRAFT ? DistanceSquare(prev_tile, cur_tile) : DistanceManhattan(prev_tile, cur_tile);
609}
610
621CommandCost CmdInsertOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID sel_ord, const Order &new_order)
622{
624 if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
625
627 if (ret.Failed()) return ret;
628
629 /* Validate properties we don't want to have different from default as they are set by other commands. */
630 if (new_order.GetRefitCargo() != CARGO_NO_REFIT || new_order.GetWaitTime() != 0 || new_order.GetTravelTime() != 0 || new_order.GetMaxSpeed() != UINT16_MAX) return CMD_ERROR;
631
632 /* Check if the inserted order is to the correct destination (owner, type),
633 * and has the correct flags if any */
634 switch (new_order.GetType()) {
635 case OT_GOTO_STATION: {
636 const Station *st = Station::GetIfValid(new_order.GetDestination().ToStationID());
637 if (st == nullptr) return CMD_ERROR;
638
639 if (st->owner != OWNER_NONE) {
640 ret = CheckOwnership(st->owner);
641 if (ret.Failed()) return ret;
642 }
643
644 if (!CanVehicleUseStation(v, st)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, GetVehicleCannotUseStationReason(v, st));
645 for (Vehicle *u = v->FirstShared(); u != nullptr; u = u->NextShared()) {
646 if (!CanVehicleUseStation(u, st)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER_SHARED, GetVehicleCannotUseStationReason(u, st));
647 }
648
649 /* Non stop only allowed for ground vehicles. */
650 if (new_order.GetNonStopType().Any() && !v->IsGroundVehicle()) return CMD_ERROR;
651
652 /* Filter invalid load/unload types. */
653 switch (new_order.GetLoadType()) {
656 break;
657
660 if (v->HasUnbunchingOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_FULL_LOAD);
661 break;
662
663 default:
664 return CMD_ERROR;
665 }
666 switch (new_order.GetUnloadType()) {
671 break;
672
673 default:
674 return CMD_ERROR;
675 }
676
677 /* Filter invalid stop locations */
678 switch (new_order.GetStopLocation()) {
681 if (v->type != VEH_TRAIN) return CMD_ERROR;
682 [[fallthrough]];
683
685 break;
686
687 default:
688 return CMD_ERROR;
689 }
690
691 break;
692 }
693
694 case OT_GOTO_DEPOT: {
696 if (v->type == VEH_AIRCRAFT) {
697 const Station *st = Station::GetIfValid(new_order.GetDestination().ToStationID());
698
699 if (st == nullptr) return CMD_ERROR;
700
701 ret = CheckOwnership(st->owner);
702 if (ret.Failed()) return ret;
703
704 if (!CanVehicleUseStation(v, st) || !st->airport.HasHangar()) {
705 return CMD_ERROR;
706 }
707 } else {
708 const Depot *dp = Depot::GetIfValid(new_order.GetDestination().ToDepotID());
709
710 if (dp == nullptr) return CMD_ERROR;
711
712 ret = CheckOwnership(GetTileOwner(dp->xy));
713 if (ret.Failed()) return ret;
714
715 switch (v->type) {
716 case VEH_TRAIN:
717 if (!IsRailDepotTile(dp->xy)) return CMD_ERROR;
718 break;
719
720 case VEH_ROAD:
721 if (!IsRoadDepotTile(dp->xy)) return CMD_ERROR;
722 break;
723
724 case VEH_SHIP:
725 if (!IsShipDepotTile(dp->xy)) return CMD_ERROR;
726 break;
727
728 default: return CMD_ERROR;
729 }
730 }
731 }
732
733 if (new_order.GetNonStopType().Any() && !v->IsGroundVehicle()) return CMD_ERROR;
734
735 /* Check depot order type is valid. */
736 OrderDepotTypeFlags depot_order_type = new_order.GetDepotOrderType();
737 if (depot_order_type.Test(OrderDepotTypeFlag::PartOfOrders)) depot_order_type.Reset(OrderDepotTypeFlag::Service);
738 depot_order_type.Reset(OrderDepotTypeFlag::PartOfOrders);
739 if (depot_order_type.Any()) return CMD_ERROR;
740
741 /* Check depot action type is valid. */
742 if (new_order.GetDepotActionType().Reset({OrderDepotActionFlag::Halt, OrderDepotActionFlag::NearestDepot, OrderDepotActionFlag::Unbunch}).Any()) return CMD_ERROR;
743
744 /* Vehicles cannot have a "service if needed" order that also has a depot action. */
745 if (new_order.GetDepotOrderType().Test(OrderDepotTypeFlag::Service) && new_order.GetDepotActionType().Any({OrderDepotActionFlag::Halt, OrderDepotActionFlag::Unbunch})) return CMD_ERROR;
746
747 /* Check if we're allowed to have a new unbunching order. */
749 if (v->HasFullLoadOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_FULL_LOAD);
750 if (v->HasUnbunchingOrder()) return CommandCost(STR_ERROR_UNBUNCHING_ONLY_ONE_ALLOWED);
751 if (v->HasConditionalOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_CONDITIONAL);
752 }
753 break;
754 }
755
756 case OT_GOTO_WAYPOINT: {
757 const Waypoint *wp = Waypoint::GetIfValid(new_order.GetDestination().ToStationID());
758 if (wp == nullptr) return CMD_ERROR;
759
760 switch (v->type) {
761 default: return CMD_ERROR;
762
763 case VEH_TRAIN: {
764 if (!wp->facilities.Test(StationFacility::Train)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_NO_RAIL_WAYPOINT);
765
766 ret = CheckOwnership(wp->owner);
767 if (ret.Failed()) return ret;
768 break;
769 }
770
771 case VEH_ROAD: {
772 if (!wp->facilities.Test(StationFacility::BusStop) && !wp->facilities.Test(StationFacility::TruckStop)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_NO_ROAD_WAYPOINT);
773
774 ret = CheckOwnership(wp->owner);
775 if (ret.Failed()) return ret;
776 break;
777 }
778
779 case VEH_SHIP:
780 if (!wp->facilities.Test(StationFacility::Dock)) return CommandCost(STR_ERROR_CAN_T_ADD_ORDER, STR_ERROR_NO_BUOY);
781 if (wp->owner != OWNER_NONE) {
782 ret = CheckOwnership(wp->owner);
783 if (ret.Failed()) return ret;
784 }
785 break;
786 }
787
788 /* Order flags can be any of the following for waypoints:
789 * [non-stop]
790 * non-stop orders (if any) are only valid for trains and road vehicles */
791 if (new_order.GetNonStopType().Any() && !v->IsGroundVehicle()) return CMD_ERROR;
792 break;
793 }
794
795 case OT_CONDITIONAL: {
796 VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();
797 if (skip_to != 0 && skip_to >= v->GetNumOrders()) return CMD_ERROR; // Always allow jumping to the first (even when there is no order).
799 if (v->HasUnbunchingOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_CONDITIONAL);
800
802 if (occ >= OrderConditionComparator::End) return CMD_ERROR;
803 switch (new_order.GetConditionVariable()) {
806 break;
807
810 if (new_order.GetConditionValue() != 0) return CMD_ERROR;
811 break;
812
815 if (new_order.GetConditionValue() > 100) return CMD_ERROR;
816 [[fallthrough]];
817
818 default:
820 break;
821 }
822 break;
823 }
824
825 default: return CMD_ERROR;
826 }
827
828 if (sel_ord > v->GetNumOrders()) return CMD_ERROR;
829
830 if (v->GetNumOrders() >= MAX_VEH_ORDER_ID) return CommandCost(STR_ERROR_TOO_MANY_ORDERS);
831 if (v->orders == nullptr && !OrderList::CanAllocateItem()) return CommandCost(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
832
833 if (flags.Test(DoCommandFlag::Execute)) {
834 InsertOrder(v, Order(new_order), sel_ord);
835 }
836
837 return CommandCost();
838}
839
846void InsertOrder(Vehicle *v, Order &&new_o, VehicleOrderID sel_ord)
847{
848 /* Create new order and link in list */
849 if (v->orders == nullptr) {
850 v->orders = OrderList::Create(std::move(new_o), v);
851 } else {
852 v->orders->InsertOrderAt(std::move(new_o), sel_ord);
853 }
854
855 Vehicle *u = v->FirstShared();
857 for (; u != nullptr; u = u->NextShared()) {
858 assert(v->orders == u->orders);
859
860 /* If there is added an order before the current one, we need
861 * to update the selected order. We do not change implicit/real order indices though.
862 * If the new order is between the current implicit order and real order, the implicit order will
863 * later skip the inserted order. */
864 if (sel_ord <= u->cur_real_order_index) {
865 uint cur = u->cur_real_order_index + 1;
866 /* Check if we don't go out of bound */
867 if (cur < u->GetNumOrders()) {
868 u->cur_real_order_index = cur;
869 }
870 }
871 if (sel_ord == u->cur_implicit_order_index && u->IsGroundVehicle()) {
872 /* We are inserting an order just before the current implicit order.
873 * We do not know whether we will reach current implicit or the newly inserted order first.
874 * So, disable creation of implicit orders until we are on track again. */
875 uint16_t &gv_flags = u->GetGroundVehicleFlags();
877 }
878 if (sel_ord <= u->cur_implicit_order_index) {
879 uint cur = u->cur_implicit_order_index + 1;
880 /* Check if we don't go out of bound */
881 if (cur < u->GetNumOrders()) {
883 }
884 }
885 /* Unbunching data is no longer valid. */
887
888 /* Update any possible open window of the vehicle */
889 InvalidateVehicleOrder(u, INVALID_VEH_ORDER_ID | (sel_ord << 8));
890 }
891
892 /* As we insert an order, the order to skip to will be 'wrong'. */
893 VehicleOrderID cur_order_id = 0;
894 for (Order &order : v->Orders()) {
895 if (order.IsType(OT_CONDITIONAL)) {
896 VehicleOrderID order_id = order.GetConditionSkipToOrder();
897 if (order_id >= sel_ord) {
898 order.SetConditionSkipToOrder(order_id + 1);
899 }
900 if (order_id == cur_order_id) {
901 order.SetConditionSkipToOrder((order_id + 1) % v->GetNumOrders());
902 }
903 }
904 cur_order_id++;
905 }
906
907 /* Make sure to rebuild the whole list */
909}
910
916static CommandCost DecloneOrder(Vehicle *dst, DoCommandFlags flags)
917{
918 if (flags.Test(DoCommandFlag::Execute)) {
922 }
923 return CommandCost();
924}
925
933CommandCost CmdDeleteOrder(DoCommandFlags flags, VehicleID veh_id, VehicleOrderID sel_ord)
934{
935 Vehicle *v = Vehicle::GetIfValid(veh_id);
936
937 if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
938
940 if (ret.Failed()) return ret;
941
942 /* If we did not select an order, we maybe want to de-clone the orders */
943 if (sel_ord >= v->GetNumOrders()) return DecloneOrder(v, flags);
944
945 if (v->GetOrder(sel_ord) == nullptr) return CMD_ERROR;
946
947 if (flags.Test(DoCommandFlag::Execute)) DeleteOrder(v, sel_ord);
948 return CommandCost();
949}
950
956{
957 assert(v->current_order.IsType(OT_LOADING));
958 /* NON-stop flag is misused to see if a train is in a station that is
959 * on its order list or not */
961 /* When full loading, "cancel" that order so the vehicle doesn't
962 * stay indefinitely at this station anymore. */
964}
965
972{
973 v->orders->DeleteOrderAt(sel_ord);
974
975 Vehicle *u = v->FirstShared();
977 for (; u != nullptr; u = u->NextShared()) {
978 assert(v->orders == u->orders);
979
980 if (sel_ord == u->cur_real_order_index && u->current_order.IsType(OT_LOADING)) {
982 }
983
984 if (sel_ord < u->cur_real_order_index) {
986 } else if (sel_ord == u->cur_real_order_index) {
988 }
989
990 if (sel_ord < u->cur_implicit_order_index) {
992 } else if (sel_ord == u->cur_implicit_order_index) {
993 /* Make sure the index is valid */
995
996 /* Skip non-implicit orders for the implicit-order-index (e.g. if the current implicit order was deleted */
1000 }
1001 }
1002 /* Unbunching data is no longer valid. */
1004
1005 /* Update any possible open window of the vehicle */
1006 InvalidateVehicleOrder(u, sel_ord | (INVALID_VEH_ORDER_ID << 8));
1007 }
1008
1009 /* As we delete an order, the order to skip to will be 'wrong'. */
1010 VehicleOrderID cur_order_id = 0;
1011 for (Order &order : v->Orders()) {
1012 if (order.IsType(OT_CONDITIONAL)) {
1013 VehicleOrderID order_id = order.GetConditionSkipToOrder();
1014 if (order_id >= sel_ord) {
1015 order_id = std::max(order_id - 1, 0);
1016 }
1017 if (order_id == cur_order_id) {
1018 order_id = (order_id + 1) % v->GetNumOrders();
1019 }
1020 order.SetConditionSkipToOrder(order_id);
1021 }
1022 cur_order_id++;
1023 }
1024
1026}
1027
1035CommandCost CmdSkipToOrder(DoCommandFlags flags, VehicleID veh_id, VehicleOrderID sel_ord)
1036{
1037 Vehicle *v = Vehicle::GetIfValid(veh_id);
1038
1039 if (v == nullptr || !v->IsPrimaryVehicle() || sel_ord == v->cur_implicit_order_index || sel_ord >= v->GetNumOrders() || v->GetNumOrders() < 2) return CMD_ERROR;
1040
1042 if (ret.Failed()) return ret;
1043
1044 if (flags.Test(DoCommandFlag::Execute)) {
1045 if (v->current_order.IsType(OT_LOADING)) v->LeaveStation();
1046
1049
1050 /* Unbunching data is no longer valid. */
1052
1054
1055 /* We have an aircraft/ship, they have a mini-schedule, so update them all */
1058 }
1059
1060 return CommandCost();
1061}
1062
1073CommandCost CmdMoveOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID moving_order, VehicleOrderID target_order)
1074{
1075 Vehicle *v = Vehicle::GetIfValid(veh);
1076 if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1077
1079 if (ret.Failed()) return ret;
1080
1081 /* Don't make senseless movements */
1082 if (moving_order >= v->GetNumOrders() || target_order >= v->GetNumOrders() ||
1083 moving_order == target_order || v->GetNumOrders() <= 1) return CMD_ERROR;
1084
1085 Order *moving_one = v->GetOrder(moving_order);
1086 /* Don't move an empty order */
1087 if (moving_one == nullptr) return CMD_ERROR;
1088
1089 if (flags.Test(DoCommandFlag::Execute)) {
1090 v->orders->MoveOrder(moving_order, target_order);
1091
1092 /* Update shared list */
1093 Vehicle *u = v->FirstShared();
1094
1096
1097 for (; u != nullptr; u = u->NextShared()) {
1098 /* Update the current order.
1099 * There are multiple ways to move orders, which result in cur_implicit_order_index
1100 * and cur_real_order_index to not longer make any sense. E.g. moving another
1101 * real order between them.
1102 *
1103 * Basically one could choose to preserve either of them, but not both.
1104 * While both ways are suitable in this or that case from a human point of view, neither
1105 * of them makes really sense.
1106 * However, from an AI point of view, preserving cur_real_order_index is the most
1107 * predictable and transparent behaviour.
1108 *
1109 * With that decision it basically does not matter what we do to cur_implicit_order_index.
1110 * If we change orders between the implicit- and real-index, the implicit orders are mostly likely
1111 * completely out-dated anyway. So, keep it simple and just keep cur_implicit_order_index as well.
1112 * The worst which can happen is that a lot of implicit orders are removed when reaching current_order.
1113 */
1114 if (u->cur_real_order_index == moving_order) {
1115 u->cur_real_order_index = target_order;
1116 } else if (u->cur_real_order_index > moving_order && u->cur_real_order_index <= target_order) {
1118 } else if (u->cur_real_order_index < moving_order && u->cur_real_order_index >= target_order) {
1120 }
1121
1122 if (u->cur_implicit_order_index == moving_order) {
1123 u->cur_implicit_order_index = target_order;
1124 } else if (u->cur_implicit_order_index > moving_order && u->cur_implicit_order_index <= target_order) {
1126 } else if (u->cur_implicit_order_index < moving_order && u->cur_implicit_order_index >= target_order) {
1128 }
1129 /* Unbunching data is no longer valid. */
1131
1132
1133 assert(v->orders == u->orders);
1134 /* Update any possible open window of the vehicle */
1135 InvalidateVehicleOrder(u, moving_order | (target_order << 8));
1136 }
1137
1138 /* As we move an order, the order to skip to will be 'wrong'. */
1139 for (Order &order : v->Orders()) {
1140 if (order.IsType(OT_CONDITIONAL)) {
1141 VehicleOrderID order_id = order.GetConditionSkipToOrder();
1142 if (order_id == moving_order) {
1143 order_id = target_order;
1144 } else if (order_id > moving_order && order_id <= target_order) {
1145 order_id--;
1146 } else if (order_id < moving_order && order_id >= target_order) {
1147 order_id++;
1148 }
1149 order.SetConditionSkipToOrder(order_id);
1150 }
1151 }
1152
1153 /* Make sure to rebuild the whole list */
1155 }
1156
1157 return CommandCost();
1158}
1159
1171CommandCost CmdModifyOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID sel_ord, ModifyOrderFlags mof, uint16_t data)
1172{
1173 if (mof >= MOF_END) return CMD_ERROR;
1174
1175 Vehicle *v = Vehicle::GetIfValid(veh);
1176 if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1177
1179 if (ret.Failed()) return ret;
1180
1181 /* Is it a valid order? */
1182 if (sel_ord >= v->GetNumOrders()) return CMD_ERROR;
1183
1184 Order *order = v->GetOrder(sel_ord);
1185 assert(order != nullptr);
1186 switch (order->GetType()) {
1187 case OT_GOTO_STATION:
1188 if (mof != MOF_NON_STOP && mof != MOF_STOP_LOCATION && mof != MOF_UNLOAD && mof != MOF_LOAD) return CMD_ERROR;
1189 break;
1190
1191 case OT_GOTO_DEPOT:
1192 if (mof != MOF_NON_STOP && mof != MOF_DEPOT_ACTION) return CMD_ERROR;
1193 break;
1194
1195 case OT_GOTO_WAYPOINT:
1196 if (mof != MOF_NON_STOP) return CMD_ERROR;
1197 break;
1198
1199 case OT_CONDITIONAL:
1200 if (mof != MOF_COND_VARIABLE && mof != MOF_COND_COMPARATOR && mof != MOF_COND_VALUE && mof != MOF_COND_DESTINATION) return CMD_ERROR;
1201 break;
1202
1203 default:
1204 return CMD_ERROR;
1205 }
1206
1207 switch (mof) {
1208 default: NOT_REACHED();
1209
1210 case MOF_NON_STOP: {
1211 if (!v->IsGroundVehicle()) return CMD_ERROR;
1212
1213 OrderNonStopFlags nonstop_flags = static_cast<OrderNonStopFlags>(data);
1214 if (nonstop_flags == order->GetNonStopType()) return CMD_ERROR;
1215
1216 /* Test for invalid flags. */
1218 if (nonstop_flags.Any()) return CMD_ERROR;
1219 break;
1220 }
1221
1222 case MOF_STOP_LOCATION:
1223 if (v->type != VEH_TRAIN) return CMD_ERROR;
1224 if (data >= to_underlying(OrderStopLocation::End)) return CMD_ERROR;
1225 break;
1226
1227 case MOF_UNLOAD: {
1229
1230 OrderUnloadType unload_type = static_cast<OrderUnloadType>(data);
1231 if (unload_type == order->GetUnloadType()) return CMD_ERROR;
1232
1233 /* Test for invalid types. */
1234 switch (unload_type) {
1239 break;
1240
1241 default: return CMD_ERROR;
1242 }
1243 break;
1244 }
1245
1246 case MOF_LOAD: {
1248
1249 OrderLoadType load_type = static_cast<OrderLoadType>(data);
1250 if (load_type == order->GetLoadType()) return CMD_ERROR;
1251
1252 /* Test for invalid types. */
1253 switch (load_type) {
1256 break;
1257
1260 if (v->HasUnbunchingOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_FULL_LOAD);
1261 break;
1262
1263 default: return CMD_ERROR;
1264 }
1265 break;
1266 }
1267
1268 case MOF_DEPOT_ACTION: {
1269 OrderDepotAction depot_action = static_cast<OrderDepotAction>(data);
1270 if (depot_action >= OrderDepotAction::End) return CMD_ERROR;
1271 /* Check if we are allowed to add unbunching. We are always allowed to remove it. */
1272 if (depot_action == OrderDepotAction::Unbunch) {
1273 /* Only one unbunching order is allowed in a vehicle's orders. If this order already has an unbunching action, no error is needed. */
1274 if (v->HasUnbunchingOrder() && !order->GetDepotActionType().Test(OrderDepotActionFlag::Unbunch)) return CommandCost(STR_ERROR_UNBUNCHING_ONLY_ONE_ALLOWED);
1275 /* We don't allow unbunching if the vehicle has a conditional order. */
1276 if (v->HasConditionalOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_CONDITIONAL);
1277 /* We don't allow unbunching if the vehicle has a full load order. */
1278 if (v->HasFullLoadOrder()) return CommandCost(STR_ERROR_UNBUNCHING_NO_UNBUNCHING_FULL_LOAD);
1279 }
1280 break;
1281 }
1282
1283 case MOF_COND_VARIABLE: {
1284 OrderConditionVariable cond_variable = static_cast<OrderConditionVariable>(data);
1285 if (cond_variable >= OrderConditionVariable::End) return CMD_ERROR;
1286 break;
1287 }
1288
1289 case MOF_COND_COMPARATOR: {
1290 OrderConditionComparator cond_comparator = static_cast<OrderConditionComparator>(data);
1291 if (cond_comparator >= OrderConditionComparator::End) return CMD_ERROR;
1292 switch (order->GetConditionVariable()) {
1294
1296 if (cond_comparator != OrderConditionComparator::IsTrue && cond_comparator != OrderConditionComparator::IsFalse) return CMD_ERROR;
1297 break;
1298
1299 default:
1300 if (cond_comparator == OrderConditionComparator::IsTrue || cond_comparator == OrderConditionComparator::IsFalse) return CMD_ERROR;
1301 break;
1302 }
1303 break;
1304 }
1305
1306 case MOF_COND_VALUE:
1307 switch (order->GetConditionVariable()) {
1310 return CMD_ERROR;
1311
1314 if (data > 100) return CMD_ERROR;
1315 break;
1316
1317 default:
1318 if (data > 2047) return CMD_ERROR;
1319 break;
1320 }
1321 break;
1322
1324 if (data >= v->GetNumOrders()) return CMD_ERROR;
1325 break;
1326 }
1327
1328 if (flags.Test(DoCommandFlag::Execute)) {
1329 switch (mof) {
1330 case MOF_NON_STOP:
1331 order->SetNonStopType(static_cast<OrderNonStopFlags>(data));
1333 order->SetRefit(CARGO_NO_REFIT);
1336 }
1337 break;
1338
1339 case MOF_STOP_LOCATION:
1340 order->SetStopLocation(static_cast<OrderStopLocation>(data));
1341 break;
1342
1343 case MOF_UNLOAD:
1344 order->SetUnloadType(static_cast<OrderUnloadType>(data));
1345 break;
1346
1347 case MOF_LOAD:
1348 order->SetLoadType(static_cast<OrderLoadType>(data));
1350 break;
1351
1352 case MOF_DEPOT_ACTION: {
1353 switch (static_cast<OrderDepotAction>(data)) {
1356 order->SetDepotActionType(order->GetDepotActionType().Reset({OrderDepotActionFlag::Halt, OrderDepotActionFlag::Unbunch}));
1357 break;
1358
1361 order->SetDepotActionType(order->GetDepotActionType().Reset({OrderDepotActionFlag::Halt, OrderDepotActionFlag::Unbunch}));
1362 order->SetRefit(CARGO_NO_REFIT);
1363 break;
1364
1368 order->SetRefit(CARGO_NO_REFIT);
1369 break;
1370
1374 break;
1375
1376 default:
1377 NOT_REACHED();
1378 }
1379 break;
1380 }
1381
1382 case MOF_COND_VARIABLE: {
1384
1386 switch (order->GetConditionVariable()) {
1389 order->SetConditionValue(0);
1390 break;
1391
1394 order->SetConditionValue(0);
1395 break;
1396
1399 if (order->GetConditionValue() > 100) order->SetConditionValue(100);
1400 [[fallthrough]];
1401
1402 default:
1404 break;
1405 }
1406 break;
1407 }
1408
1411 break;
1412
1413 case MOF_COND_VALUE:
1414 order->SetConditionValue(data);
1415 break;
1416
1418 order->SetConditionSkipToOrder(data);
1419 break;
1420
1421 default: NOT_REACHED();
1422 }
1423
1424 /* Update the windows and full load flags, also for vehicles that share the same order list */
1425 Vehicle *u = v->FirstShared();
1427 for (; u != nullptr; u = u->NextShared()) {
1428 /* Toggle u->current_order "Full load" flag if it changed.
1429 * However, as the same flag is used for depot orders, check
1430 * whether we are not going to a depot as there are three
1431 * cases where the full load flag can be active and only
1432 * one case where the flag is used for depot orders. In the
1433 * other cases for the OrderType the flags are not used,
1434 * so do not care and those orders should not be active
1435 * when this function is called.
1436 */
1437 if (sel_ord == u->cur_real_order_index &&
1438 (u->current_order.IsType(OT_GOTO_STATION) || u->current_order.IsType(OT_LOADING)) &&
1439 u->current_order.GetLoadType() != order->GetLoadType()) {
1441 }
1442
1443 /* Unbunching data is no longer valid. */
1445
1447 }
1448 }
1449
1450 return CommandCost();
1451}
1452
1459static bool CheckAircraftOrderDistance(const Aircraft *v_new, const Vehicle *v_order)
1460{
1461 if (v_new->acache.cached_max_range == 0) return true;
1462 if (v_order->GetNumOrders() == 0) return true;
1463
1464 const OrderList &orderlist = *v_order->orders;
1465 auto orders = orderlist.GetOrders();
1466
1467 /* Iterate over all orders to check the distance between all
1468 * 'goto' orders and their respective next order (of any type). */
1469 for (VehicleOrderID cur = 0; cur < orderlist.GetNumOrders(); ++cur) {
1470 switch (orders[cur].GetType()) {
1471 case OT_GOTO_STATION:
1472 case OT_GOTO_DEPOT:
1473 case OT_GOTO_WAYPOINT:
1474 /* If we don't have a next order, we've reached the end and must check the first order instead. */
1475 if (GetOrderDistance(cur, orderlist.GetNext(cur), v_order) > v_new->acache.cached_max_range_sqr) return false;
1476 break;
1477
1478 default: break;
1479 }
1480 }
1481
1482 return true;
1483}
1484
1493CommandCost CmdCloneOrder(DoCommandFlags flags, CloneOptions action, VehicleID veh_dst, VehicleID veh_src)
1494{
1495 Vehicle *dst = Vehicle::GetIfValid(veh_dst);
1496 if (dst == nullptr || !dst->IsPrimaryVehicle()) return CMD_ERROR;
1497
1498 CommandCost ret = CheckOwnership(dst->owner);
1499 if (ret.Failed()) return ret;
1500
1501 switch (action) {
1502 case CO_SHARE: {
1503 Vehicle *src = Vehicle::GetIfValid(veh_src);
1504
1505 /* Sanity checks */
1506 if (src == nullptr || !src->IsPrimaryVehicle() || dst->type != src->type || dst == src) return CMD_ERROR;
1507
1508 ret = CheckOwnership(src->owner);
1509 if (ret.Failed()) return ret;
1510
1511 /* Trucks can't share orders with busses (and visa versa) */
1512 if (src->type == VEH_ROAD && RoadVehicle::From(src)->IsBus() != RoadVehicle::From(dst)->IsBus()) {
1513 return CMD_ERROR;
1514 }
1515
1516 /* Is the vehicle already in the shared list? */
1517 if (src->FirstShared() == dst->FirstShared()) return CMD_ERROR;
1518
1519 for (const Order &order : src->Orders()) {
1520 if (!OrderGoesToStation(dst, order)) continue;
1521
1522 /* Allow copying unreachable destinations if they were already unreachable for the source.
1523 * This is basically to allow cloning / autorenewing / autoreplacing vehicles, while the stations
1524 * are temporarily invalid due to reconstruction. */
1525 const Station *st = Station::Get(order.GetDestination().ToStationID());
1526 if (CanVehicleUseStation(src, st) && !CanVehicleUseStation(dst, st)) {
1527 return CommandCost(STR_ERROR_CAN_T_COPY_SHARE_ORDER, GetVehicleCannotUseStationReason(dst, st));
1528 }
1529 }
1530
1531 /* Check for aircraft range limits. */
1532 if (dst->type == VEH_AIRCRAFT && !CheckAircraftOrderDistance(Aircraft::From(dst), src)) {
1533 return CommandCost(STR_ERROR_AIRCRAFT_NOT_ENOUGH_RANGE);
1534 }
1535
1536 if (src->orders == nullptr && !OrderList::CanAllocateItem()) {
1537 return CommandCost(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1538 }
1539
1540 if (flags.Test(DoCommandFlag::Execute)) {
1541 /* If the destination vehicle had a OrderList, destroy it.
1542 * We only reset the order indices, if the new orders are obviously different.
1543 * (We mainly do this to keep the order indices valid and in range.) */
1544 DeleteVehicleOrders(dst, false, dst->GetNumOrders() != src->GetNumOrders());
1545
1546 dst->orders = src->orders;
1547
1548 /* Link this vehicle in the shared-list */
1549 dst->AddToShared(src);
1550
1553
1555 }
1556 break;
1557 }
1558
1559 case CO_COPY: {
1560 Vehicle *src = Vehicle::GetIfValid(veh_src);
1561
1562 /* Sanity checks */
1563 if (src == nullptr || !src->IsPrimaryVehicle() || dst->type != src->type || dst == src) return CMD_ERROR;
1564
1565 ret = CheckOwnership(src->owner);
1566 if (ret.Failed()) return ret;
1567
1568 /* Trucks can't copy all the orders from busses (and visa versa),
1569 * and neither can helicopters and aircraft. */
1570 for (const Order &order : src->Orders()) {
1571 if (!OrderGoesToStation(dst, order)) continue;
1572 Station *st = Station::Get(order.GetDestination().ToStationID());
1573 if (!CanVehicleUseStation(dst, st)) {
1574 return CommandCost(STR_ERROR_CAN_T_COPY_SHARE_ORDER, GetVehicleCannotUseStationReason(dst, st));
1575 }
1576 }
1577
1578 /* Check for aircraft range limits. */
1579 if (dst->type == VEH_AIRCRAFT && !CheckAircraftOrderDistance(Aircraft::From(dst), src)) {
1580 return CommandCost(STR_ERROR_AIRCRAFT_NOT_ENOUGH_RANGE);
1581 }
1582
1583 /* make sure there are orders available */
1585 return CommandCost(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1586 }
1587
1588 if (flags.Test(DoCommandFlag::Execute)) {
1589 /* If the destination vehicle had an order list, destroy the chain but keep the OrderList.
1590 * We only reset the order indices, if the new orders are obviously different.
1591 * (We mainly do this to keep the order indices valid and in range.) */
1592 DeleteVehicleOrders(dst, true, dst->GetNumOrders() != src->GetNumOrders());
1593
1594 std::vector<Order> dst_orders;
1595 for (const Order &order : src->Orders()) {
1596 dst_orders.emplace_back(order);
1597 }
1598
1599 if (dst->orders != nullptr) {
1600 assert(dst->orders->GetNumOrders() == 0);
1601 assert(!dst->orders->IsShared());
1602 delete dst->orders;
1603 }
1604
1606 dst->orders = OrderList::Create(std::move(dst_orders), dst);
1607
1609
1611 }
1612 break;
1613 }
1614
1615 case CO_UNSHARE: return DecloneOrder(dst, flags);
1616 default: return CMD_ERROR;
1617 }
1618
1619 return CommandCost();
1620}
1621
1630CommandCost CmdOrderRefit(DoCommandFlags flags, VehicleID veh, VehicleOrderID order_number, CargoType cargo)
1631{
1632 if (cargo >= NUM_CARGO && cargo != CARGO_NO_REFIT && cargo != CARGO_AUTO_REFIT) return CMD_ERROR;
1633
1634 const Vehicle *v = Vehicle::GetIfValid(veh);
1635 if (v == nullptr || !v->IsPrimaryVehicle()) return CMD_ERROR;
1636
1638 if (ret.Failed()) return ret;
1639
1640 Order *order = v->GetOrder(order_number);
1641 if (order == nullptr) return CMD_ERROR;
1642
1643 /* Automatic refit cargo is only supported for goto station orders. */
1644 if (cargo == CARGO_AUTO_REFIT && !order->IsType(OT_GOTO_STATION)) return CMD_ERROR;
1645
1646 if (order->GetLoadType() == OrderLoadType::NoLoad) return CMD_ERROR;
1647
1648 if (flags.Test(DoCommandFlag::Execute)) {
1649 order->SetRefit(cargo);
1650
1651 /* Make the depot order an 'always go' order. */
1652 if (cargo != CARGO_NO_REFIT && order->IsType(OT_GOTO_DEPOT)) {
1655 }
1656
1657 for (Vehicle *u = v->FirstShared(); u != nullptr; u = u->NextShared()) {
1658 /* Update any possible open window of the vehicle */
1660
1661 /* If the vehicle already got the current depot set as current order, then update current order as well */
1662 if (u->cur_real_order_index == order_number && u->current_order.GetDepotOrderType().Test(OrderDepotTypeFlag::PartOfOrders)) {
1663 u->current_order.SetRefit(cargo);
1664 }
1665 }
1666 }
1667
1668 return CommandCost();
1669}
1670
1671
1677void CheckOrders(const Vehicle *v)
1678{
1679 /* Does the user wants us to check things? */
1680 if (_settings_client.gui.order_review_system == 0) return;
1681
1682 /* Do nothing for crashed vehicles */
1683 if (v->vehstatus.Test(VehState::Crashed)) return;
1684
1685 /* Do nothing for stopped vehicles if setting is '1' */
1686 if (_settings_client.gui.order_review_system == 1 && v->vehstatus.Test(VehState::Stopped)) return;
1687
1688 /* do nothing we we're not the first vehicle in a share-chain */
1689 if (v->FirstShared() != v) return;
1690
1691 /* Only check every 20 days, so that we don't flood the message log */
1692 if (v->owner == _local_company && v->day_counter % 20 == 0) {
1693 StringID message = INVALID_STRING_ID;
1694
1695 /* Check the order list */
1696 int n_st = 0;
1697
1698 for (const Order &order : v->Orders()) {
1699 /* Dummy order? */
1700 if (order.IsType(OT_DUMMY)) {
1701 message = STR_NEWS_VEHICLE_HAS_VOID_ORDER;
1702 break;
1703 }
1704 /* Does station have a load-bay for this vehicle? */
1705 if (order.IsType(OT_GOTO_STATION)) {
1706 const Station *st = Station::Get(order.GetDestination().ToStationID());
1707
1708 n_st++;
1709 if (!CanVehicleUseStation(v, st)) {
1710 message = STR_NEWS_VEHICLE_HAS_INVALID_ENTRY;
1711 } else if (v->type == VEH_AIRCRAFT &&
1712 (AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&
1714 !_cheats.no_jetcrash.value &&
1715 message == INVALID_STRING_ID) {
1716 message = STR_NEWS_PLANE_USES_TOO_SHORT_RUNWAY;
1717 }
1718 }
1719 }
1720
1721 /* Check if the last and the first order are the same */
1722 if (v->GetNumOrders() > 1) {
1723 auto orders = v->Orders();
1724
1725 if (orders.front().Equals(orders.back())) {
1726 message = STR_NEWS_VEHICLE_HAS_DUPLICATE_ENTRY;
1727 }
1728 }
1729
1730 /* Do we only have 1 station in our order list? */
1731 if (n_st < 2 && message == INVALID_STRING_ID) message = STR_NEWS_VEHICLE_HAS_TOO_FEW_ORDERS;
1732
1733#ifdef WITH_ASSERT
1734 if (v->orders != nullptr) v->orders->DebugCheckSanity();
1735#endif
1736
1737 /* We don't have a problem */
1738 if (message == INVALID_STRING_ID) return;
1739
1740 AddVehicleAdviceNewsItem(AdviceType::Order, GetEncodedString(message, v->index), v->index);
1741 }
1742}
1743
1752void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
1753{
1754 /* Aircraft have StationIDs for depot orders and never use DepotIDs
1755 * This fact is handled specially below
1756 */
1757
1758 /* Go through all vehicles */
1759 for (Vehicle *v : Vehicle::Iterate()) {
1760 if ((v->type == VEH_AIRCRAFT && v->current_order.IsType(OT_GOTO_DEPOT) && !hangar ? OT_GOTO_STATION : v->current_order.GetType()) == type &&
1761 (!hangar || v->type == VEH_AIRCRAFT) && v->current_order.GetDestination() == destination) {
1762 v->current_order.MakeDummy();
1764 }
1765
1766 if (v->orders == nullptr) continue;
1767
1768 /* Clear the order from the order-list */
1769 for (VehicleOrderID id = 0, next_id = 0; id < v->GetNumOrders(); id = next_id) {
1770 next_id = id + 1;
1771 Order *order = v->orders->GetOrderAt(id);
1772 OrderType ot = order->GetType();
1773 if (ot == OT_GOTO_DEPOT && order->GetDepotActionType().Test(OrderDepotActionFlag::NearestDepot)) continue;
1774 if (ot == OT_GOTO_DEPOT && hangar && v->type != VEH_AIRCRAFT) continue; // Not an aircraft? Can't have a hangar order.
1775 if (ot == OT_IMPLICIT || (v->type == VEH_AIRCRAFT && ot == OT_GOTO_DEPOT && !hangar)) ot = OT_GOTO_STATION;
1776 if (ot == type && order->GetDestination() == destination) {
1777 /* We want to clear implicit orders, but we don't want to make them
1778 * dummy orders. They should just vanish. Also check the actual order
1779 * type as ot is currently OT_GOTO_STATION. */
1780 if (order->IsType(OT_IMPLICIT)) {
1781 DeleteOrder(v, id);
1782 next_id = id;
1783 continue;
1784 }
1785
1786 /* Clear wait time */
1787 v->orders->UpdateTotalDuration(-order->GetWaitTime());
1788 if (order->IsWaitTimetabled()) {
1789 v->orders->UpdateTimetableDuration(-order->GetTimetabledWait());
1790 order->SetWaitTimetabled(false);
1791 }
1792 order->SetWaitTime(0);
1793
1794 /* Clear order, preserving travel time */
1795 bool travel_timetabled = order->IsTravelTimetabled();
1796 order->MakeDummy();
1797 order->SetTravelTimetabled(travel_timetabled);
1798
1799 for (const Vehicle *w = v->FirstShared(); w != nullptr; w = w->NextShared()) {
1800 /* In GUI, simulate by removing the order and adding it back */
1803 }
1804 }
1805 }
1806 }
1807
1808 OrderBackup::RemoveOrder(type, destination, hangar);
1809}
1810
1816{
1817 return std::ranges::any_of(this->Orders(), [](const Order &order) { return order.IsType(OT_GOTO_DEPOT); });
1818}
1819
1829void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
1830{
1832
1833 if (v->IsOrderListShared()) {
1834 /* Remove ourself from the shared order list. */
1835 v->RemoveFromShared();
1836 v->orders = nullptr;
1837 } else if (v->orders != nullptr) {
1838 /* Remove the orders */
1839 v->orders->FreeChain(keep_orderlist);
1840 if (!keep_orderlist) v->orders = nullptr;
1841 }
1842
1843 /* Unbunching data is no longer valid. */
1845
1846 if (reset_order_indices) {
1848 if (v->current_order.IsType(OT_LOADING)) {
1850 }
1851 }
1852}
1853
1861uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
1862{
1863 /* Service intervals are in percents. */
1864 if (ispercent) return Clamp(interval, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT);
1865
1866 /* Service intervals are in minutes. */
1867 if (TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU)) return Clamp(interval, MIN_SERVINT_MINUTES, MAX_SERVINT_MINUTES);
1868
1869 /* Service intervals are in days. */
1870 return Clamp(interval, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);
1871}
1872
1881static bool CheckForValidOrders(const Vehicle *v)
1882{
1883 /* Check if vehicle has any valid orders.
1884 * Function is only called for aircraft, no type check needed. */
1885 return std::ranges::any_of(v->Orders(), [](const Order &order) {
1886 return order.IsGotoOrder() && !order.IsType(OT_GOTO_DEPOT);
1887 });
1888}
1889
1893static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
1894{
1895 switch (occ) {
1896 case OrderConditionComparator::Equal: return variable == value;
1897 case OrderConditionComparator::NotEqual: return variable != value;
1898 case OrderConditionComparator::LessThan: return variable < value;
1899 case OrderConditionComparator::LessThanOrEqual: return variable <= value;
1900 case OrderConditionComparator::MoreThan: return variable > value;
1901 case OrderConditionComparator::MoreThanOrEqual: return variable >= value;
1902 case OrderConditionComparator::IsTrue: return variable != 0;
1903 case OrderConditionComparator::IsFalse: return variable == 0;
1904 default: NOT_REACHED();
1905 }
1906}
1907
1908static bool OrderConditionCompare(OrderConditionComparator occ, ConvertibleThroughBase auto variable, int value)
1909{
1910 return OrderConditionCompare(occ, variable.base(), value);
1911}
1912
1920{
1921 if (order->GetType() != OT_CONDITIONAL) return INVALID_VEH_ORDER_ID;
1922
1923 bool skip_order = false;
1925 uint16_t value = order->GetConditionValue();
1926
1927 switch (order->GetConditionVariable()) {
1928 case OrderConditionVariable::LoadPercentage: skip_order = OrderConditionCompare(occ, CalcPercentVehicleFilled(v, nullptr), value); break;
1929 case OrderConditionVariable::Reliability: skip_order = OrderConditionCompare(occ, ToPercent16(v->reliability), value); break;
1931 case OrderConditionVariable::MaxSpeed: skip_order = OrderConditionCompare(occ, v->GetDisplayMaxSpeed() * 10 / 16, value); break;
1933 case OrderConditionVariable::RequiresService: skip_order = OrderConditionCompare(occ, v->NeedsServicing(), value); break;
1934 case OrderConditionVariable::Unconditionally: skip_order = true; break;
1935 case OrderConditionVariable::RemainingLifetime: skip_order = OrderConditionCompare(occ, std::max(TimerGameCalendar::DateToYear(v->max_age - v->age + CalendarTime::DAYS_IN_LEAP_YEAR - 1), TimerGameCalendar::Year(0)), value); break;
1936 default: NOT_REACHED();
1937 }
1938
1939 return skip_order ? order->GetConditionSkipToOrder() : (VehicleOrderID)INVALID_VEH_ORDER_ID;
1940}
1941
1949bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
1950{
1951 if (conditional_depth > v->GetNumOrders()) {
1952 v->current_order.Free();
1953 v->SetDestTile(INVALID_TILE);
1954 return false;
1955 }
1956
1957 switch (order->GetType()) {
1958 case OT_GOTO_STATION:
1959 v->SetDestTile(v->GetOrderStationLocation(order->GetDestination().ToStationID()));
1960 return true;
1961
1962 case OT_GOTO_DEPOT:
1964 assert(!pbs_look_ahead);
1965 UpdateVehicleTimetable(v, true);
1967 break;
1968 }
1969
1971 /* If the vehicle can't find its destination, delay its next search.
1972 * In case many vehicles are in this state, use the vehicle index to spread out pathfinder calls. */
1973 if (v->dest_tile == INVALID_TILE && TimerGameEconomy::date_fract != (v->index % Ticks::DAY_TICKS)) break;
1974
1975 /* We need to search for the nearest depot (hangar). */
1976 ClosestDepot closest_depot = v->FindClosestDepot();
1977
1978 if (closest_depot.found) {
1979 /* PBS reservations cannot reverse */
1980 if (pbs_look_ahead && closest_depot.reverse) return false;
1981
1982 v->SetDestTile(closest_depot.location);
1983 v->current_order.SetDestination(closest_depot.destination);
1984
1985 /* If there is no depot in front, reverse automatically (trains only) */
1986 if (v->type == VEH_TRAIN && closest_depot.reverse) Command<Commands::ReverseTrainDirection>::Do(DoCommandFlag::Execute, v->index, false);
1987
1988 if (v->type == VEH_AIRCRAFT) {
1989 Aircraft *a = Aircraft::From(v);
1990 if (a->state == FLYING && a->targetairport != closest_depot.destination) {
1991 /* The aircraft is now heading for a different hangar than the next in the orders */
1993 }
1994 }
1995 return true;
1996 }
1997
1998 /* If there is no depot, we cannot help PBS either. */
1999 if (pbs_look_ahead) return false;
2000
2001 UpdateVehicleTimetable(v, true);
2003 } else {
2004 if (v->type != VEH_AIRCRAFT) {
2005 v->SetDestTile(Depot::Get(order->GetDestination().ToStationID())->xy);
2006 } else {
2007 Aircraft *a = Aircraft::From(v);
2008 DestinationID destination = a->current_order.GetDestination();
2009 if (a->targetairport != destination) {
2010 /* The aircraft is now heading for a different hangar than the next in the orders */
2011 a->SetDestTile(a->GetOrderStationLocation(destination.ToStationID()));
2012 }
2013 }
2014 return true;
2015 }
2016 break;
2017
2018 case OT_GOTO_WAYPOINT:
2019 v->SetDestTile(Waypoint::Get(order->GetDestination().ToStationID())->xy);
2020 return true;
2021
2022 case OT_CONDITIONAL: {
2023 assert(!pbs_look_ahead);
2024 VehicleOrderID next_order = ProcessConditionalOrder(order, v);
2025 if (next_order != INVALID_VEH_ORDER_ID) {
2026 /* Jump to next_order. cur_implicit_order_index becomes exactly that order,
2027 * cur_real_order_index might come after next_order. */
2028 UpdateVehicleTimetable(v, false);
2032
2033 /* Disable creation of implicit orders.
2034 * When inserting them we do not know that we would have to make the conditional orders point to them. */
2035 if (v->IsGroundVehicle()) {
2036 uint16_t &gv_flags = v->GetGroundVehicleFlags();
2038 }
2039 } else {
2040 UpdateVehicleTimetable(v, true);
2042 }
2043 break;
2044 }
2045
2046 default:
2047 v->SetDestTile(INVALID_TILE);
2048 return false;
2049 }
2050
2051 assert(v->cur_implicit_order_index < v->GetNumOrders());
2052 assert(v->cur_real_order_index < v->GetNumOrders());
2053
2054 /* Get the current order */
2055 order = v->GetOrder(v->cur_real_order_index);
2056 if (order != nullptr && order->IsType(OT_IMPLICIT)) {
2057 assert(v->GetNumManualOrders() == 0);
2058 order = nullptr;
2059 }
2060
2061 if (order == nullptr) {
2062 v->current_order.Free();
2063 v->SetDestTile(INVALID_TILE);
2064 return false;
2065 }
2066
2067 v->current_order = *order;
2068 return UpdateOrderDest(v, order, conditional_depth + 1, pbs_look_ahead);
2069}
2070
2079{
2080 switch (v->current_order.GetType()) {
2081 case OT_GOTO_DEPOT:
2082 /* Let a depot order in the orderlist interrupt. */
2084 break;
2085
2086 case OT_LOADING:
2087 return false;
2088
2089 case OT_LEAVESTATION:
2090 if (v->type != VEH_AIRCRAFT) return false;
2091 break;
2092
2093 default: break;
2094 }
2095
2103 bool may_reverse = v->current_order.IsType(OT_NOTHING);
2104
2105 /* Check if we've reached a 'via' destination. */
2106 if (((v->current_order.IsType(OT_GOTO_STATION) && v->current_order.GetNonStopType().Test(OrderNonStopFlag::NoDestination)) || v->current_order.IsType(OT_GOTO_WAYPOINT)) &&
2110 /* We set the last visited station here because we do not want
2111 * the train to stop at this 'via' station if the next order
2112 * is a no-non-stop order; in that case not setting the last
2113 * visited station will cause the vehicle to still stop. */
2114 v->last_station_visited = v->current_order.GetDestination().ToStationID();
2115 UpdateVehicleTimetable(v, true);
2117 }
2118
2119 /* Get the current order */
2122
2123 const Order *order = v->GetOrder(v->cur_real_order_index);
2124 if (order != nullptr && order->IsType(OT_IMPLICIT)) {
2125 assert(v->GetNumManualOrders() == 0);
2126 order = nullptr;
2127 }
2128
2129 /* If no order, do nothing. */
2130 if (order == nullptr || (v->type == VEH_AIRCRAFT && !CheckForValidOrders(v))) {
2131 if (v->type == VEH_AIRCRAFT) {
2132 /* Aircraft do something vastly different here, so handle separately */
2133 HandleMissingAircraftOrders(Aircraft::From(v));
2134 return false;
2135 }
2136
2137 v->current_order.Free();
2138 v->SetDestTile(INVALID_TILE);
2139 return false;
2140 }
2141
2142 /* If it is unchanged, keep it. */
2143 if (order->Equals(v->current_order) && (v->type == VEH_AIRCRAFT || v->dest_tile != INVALID_TILE) &&
2144 (v->type != VEH_SHIP || !order->IsType(OT_GOTO_STATION) || Station::Get(order->GetDestination().ToStationID())->ship_station.tile != INVALID_TILE)) {
2145 return false;
2146 }
2147
2148 /* Otherwise set it, and determine the destination tile. */
2149 v->current_order = *order;
2150
2152 switch (v->type) {
2153 default:
2154 NOT_REACHED();
2155
2156 case VEH_ROAD:
2157 case VEH_TRAIN:
2158 break;
2159
2160 case VEH_AIRCRAFT:
2161 case VEH_SHIP:
2163 break;
2164 }
2165
2166 return UpdateOrderDest(v, order) && may_reverse;
2167}
2168
2176bool Order::ShouldStopAtStation(const Vehicle *v, StationID station) const
2177{
2178 bool is_dest_station = this->IsType(OT_GOTO_STATION) && this->dest == station;
2179
2180 return (!this->IsType(OT_GOTO_DEPOT) || this->GetDepotOrderType().Test(OrderDepotTypeFlag::PartOfOrders)) &&
2181 v->last_station_visited != station && // Do stop only when we've not just been there
2182 /* Finally do stop when there is no non-stop flag set for this type of station. */
2184}
2185
2186bool Order::CanLoadOrUnload() const
2187{
2188 return (this->IsType(OT_GOTO_STATION) || this->IsType(OT_IMPLICIT)) &&
2190 (this->GetLoadType() != OrderLoadType::NoLoad ||
2192}
2193
2200bool Order::CanLeaveWithCargo(bool has_cargo) const
2201{
2202 return this->GetLoadType() != OrderLoadType::NoLoad || (has_cargo &&
2205}
Base for aircraft.
void AircraftNextAirportPos_and_Order(Aircraft *v)
set the right pos when heading to other airports after takeoff
@ FLYING
Vehicle is flying in the air.
Definition airport.h:77
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 T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
static const CargoType CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition cargo_type.h:76
static const CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:73
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
Cheats _cheats
All the cheats.
Definition cheat.cpp:16
Types related to cheating.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Common return value for all commands.
bool Failed() const
Did this command fail?
uint16_t reliability
Current reliability of the engine.
Definition engine_base.h:49
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
static bool UsingWallclockUnits(bool newgame=false)
Check if we are using wallclock units.
static DateFract date_fract
Fractional part of the day.
int32_t Ticks
The type to store ticks in.
static constexpr Year DateToYear(Date date)
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
A type is considered 'convertible through base()' when it has a 'base()' function that returns someth...
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
Base for all depots (except hangars).
PoolID< uint16_t, struct DepotIDTag, 64000, 0xFFFF > DepotID
Type for the unique identifier of depots.
Definition depot_type.h:15
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:17
@ GVF_SUPPRESS_IMPLICIT_ORDERS
Disable insertion and removal of automatic orders until the vehicle completes the real order.
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the 'Square' distance between the two given tiles.
Definition map.cpp:175
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:158
constexpr uint ToPercent16(uint i)
Converts a "fract" value 0..65535 to "percent" value 0..100.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
Functions related to news.
void AddVehicleAdviceNewsItem(AdviceType advice_type, EncodedString &&headline, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition news_func.h:40
void DeleteVehicleNews(VehicleID vid, AdviceType advice_type=AdviceType::Invalid)
Delete news with a given advice type about a vehicle.
@ Vehicle
Vehicle news item. (new engine available).
Definition news_type.h:81
@ Order
Something wrong with the order, e.g. invalid or duplicate entries, too few entries.
Definition news_type.h:54
Functions related to order backups.
CommandCost CmdSkipToOrder(DoCommandFlags flags, VehicleID veh_id, VehicleOrderID sel_ord)
Goto order of order-list.
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
static bool CheckForValidOrders(const Vehicle *v)
Check if a vehicle has any valid orders.
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
static bool OrderConditionCompare(OrderConditionComparator occ, int variable, int value)
Compare the variable and value based on the given comparator.
static void CancelLoadingDueToDeletedOrder(Vehicle *v)
Cancel the current loading order of the vehicle as the order was deleted.
bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
Update the vehicle's destination tile from an order.
CommandCost CmdOrderRefit(DoCommandFlags flags, VehicleID veh, VehicleOrderID order_number, CargoType cargo)
Add/remove refit orders from an order.
void InsertOrder(Vehicle *v, Order &&new_o, VehicleOrderID sel_ord)
Insert a new order but skip the validation.
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
CommandCost CmdInsertOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID sel_ord, const Order &new_order)
Add an order to the orderlist of a vehicle.
CommandCost CmdModifyOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID sel_ord, ModifyOrderFlags mof, uint16_t data)
Modify an order in the orderlist of a vehicle.
CommandCost CmdCloneOrder(DoCommandFlags flags, CloneOptions action, VehicleID veh_dst, VehicleID veh_src)
Clone/share/copy an order-list of another vehicle.
static CommandCost DecloneOrder(Vehicle *dst, DoCommandFlags flags)
Declone an order-list.
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
Delete all orders from a vehicle.
CommandCost CmdDeleteOrder(DoCommandFlags flags, VehicleID veh_id, VehicleOrderID sel_ord)
Delete an order from the orderlist of a vehicle.
uint GetOrderDistance(VehicleOrderID prev, VehicleOrderID cur, const Vehicle *v, int conditional_depth)
Get the distance between two orders of a vehicle.
static void DeleteOrderWarnings(const Vehicle *v)
Delete all news items regarding defective orders about a vehicle This could kill still valid warnings...
void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord)
Delete an order but skip the parameter validation.
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
CommandCost CmdMoveOrder(DoCommandFlags flags, VehicleID veh, VehicleOrderID moving_order, VehicleOrderID target_order)
Move an order inside the orderlist.
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
static bool CheckAircraftOrderDistance(const Aircraft *v_new, const Vehicle *v_order)
Check if an aircraft has enough range for an order list.
static bool OrderGoesToStation(const Vehicle *v, const Order &o)
Checks whether the order goes to a station or not, i.e.
Command definitions related to orders.
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
@ NearEnd
Stop at the near end of the platform.
Definition order_type.h:98
@ End
End marker.
Definition order_type.h:101
@ FarEnd
Stop at the far end of the platform.
Definition order_type.h:100
@ Middle
Stop at the middle of the platform.
Definition order_type.h:99
ModifyOrderFlags
Enumeration for the data to set in CmdModifyOrder.
Definition order_type.h:159
@ 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_DESTINATION
Change the destination of a conditional order.
Definition order_type.h:168
@ 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
@ End
End marker.
Definition order_type.h:180
@ 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
@ FullLoad
Full load all cargoes of the consist.
Definition order_type.h:79
@ 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
static const VehicleOrderID MAX_VEH_ORDER_ID
Last valid VehicleOrderID.
Definition order_type.h:41
@ 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
@ NotEqual
Skip if both values are not equal.
Definition order_type.h:145
@ IsFalse
Skip if the variable is false.
Definition order_type.h:151
@ LessThanOrEqual
Skip if the value is less or equal to the limit.
Definition order_type.h:147
@ MoreThan
Skip if the value is more than the limit.
Definition order_type.h:148
@ MoreThanOrEqual
Skip if the value is more or equal to the limit.
Definition order_type.h:149
@ LessThan
Skip if the value is less than the limit.
Definition order_type.h:146
@ Equal
Skip if both values are equal.
Definition order_type.h:144
CloneOptions
Clone actions.
Definition order_type.h:194
OrderType
Order types.
Definition order_type.h:50
Some methods of Pool are placed here in order to reduce compilation time and binary size.
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
static bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition rail_map.h:105
static bool IsRoadDepotTile(Tile t)
Return whether a tile is a road depot tile.
Definition road_map.h:100
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
Base classes/functions for stations.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
@ Dock
Station with a dock.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ BusStop
Station with bus stops.
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
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).
uint32_t cached_max_range_sqr
Cached squared maximum range.
Definition aircraft.h:66
uint16_t cached_max_range
Cached maximum range.
Definition aircraft.h:67
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition aircraft.h:73
uint8_t state
State of the airport.
Definition aircraft.h:78
TileIndex GetOrderStationLocation(StationID station) override
Determine the location for the station where the vehicle goes to next.
StationID targetairport
Airport to go to next.
Definition aircraft.h:77
@ ShortStrip
This airport has a short landing strip, dangerous for fast aircraft.
Definition airport.h:164
Flags flags
Flags for this airport type.
Definition airport.h:193
bool HasHangar() const
Check if this airport has at least one hangar.
const AirportFTAClass * GetFTA() const
Get the finite-state machine for this airport or the finite-state machine for the dummy airport in ca...
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
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.
void ResetDepotUnbunching()
Resets all the data used for depot unbunching.
Base class for all station-ish types.
TileIndex xy
Base tile of the station.
StationFacilities facilities
The facilities that this station has.
Owner owner
The owner of this station.
VehicleType type
Type of vehicle.
Structure to return information about the closest depot location, and whether it could be found.
DestinationID destination
The DestinationID as used for orders.
static void RemoveOrder(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition order_base.h:274
void DeleteOrderAt(VehicleOrderID index)
Remove an order from the order list and delete it.
std::vector< Order > orders
Orders of the order list.
Definition order_base.h:285
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
void InsertOrderAt(Order &&order, VehicleOrderID index)
Insert a new order into the order chain.
void RemoveVehicle(Vehicle *v)
Removes the vehicle from the shared order list.
uint num_vehicles
NOSAVE: Number of vehicles that share this order list.
Definition order_base.h:283
void Initialize(Vehicle *v)
Recomputes everything.
TimerGameTick::Ticks timetable_duration
NOSAVE: Total timetabled duration of the order list.
Definition order_base.h:288
Vehicle * first_shared
NOSAVE: pointer to the first vehicle in the shared order chain.
Definition order_base.h:284
VehicleOrderID GetFirstOrder() const
Get the first order of the order chain.
Definition order_base.h:329
VehicleOrderID num_manual_orders
NOSAVE: How many manually added orders are there in the list.
Definition order_base.h:282
void MoveOrder(VehicleOrderID from, VehicleOrderID to)
Move an order to another position within the order list.
void GetNextStoppingStation(std::vector< StationID > &next_station, const Vehicle *v, VehicleOrderID first=INVALID_VEH_ORDER_ID, uint hops=0) const
Recursively determine the next deterministic station to stop at.
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:363
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition order_base.h:373
void RecalculateTimetableDuration()
Recomputes Timetable duration.
void FreeChain(bool keep_orderlist=false)
Free a complete order chain.
VehicleOrderID GetNextDecisionNode(VehicleOrderID next, uint hops) const
Get the next order which will make the given vehicle stop at a station or refit at a depot or evaluat...
bool IsShared() const
Is this a shared order list?
Definition order_base.h:392
TimerGameTick::Ticks total_duration
NOSAVE: Total (timetabled or not) duration of the order list.
Definition order_base.h:289
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition order_base.h:150
uint16_t GetTimetabledTravel() const
Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled.
Definition order_base.h:196
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
Definition order_base.h:154
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
uint16_t MapOldOrder() const
Pack this order into a 16 bits integer as close to the TTD representation as possible.
uint16_t GetMaxSpeed() const
Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
Definition order_base.h:207
uint16_t max_speed
How fast the vehicle may go on the way to the destination.
Definition order_base.h:55
void SetTravelTimetabled(bool timetabled)
Set if the travel time is explicitly timetabled (unless the order is conditional).
Definition order_base.h:212
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:167
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition order_base.h:158
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition order_base.h:148
uint16_t GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition order_base.h:198
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
bool IsFullLoadOrder() const
Is this order a OrderLoadType::FullLoad or OrderLoadType::FullLoadAny?
Definition order_base.h:135
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
Definition order_cmd.cpp:58
uint8_t type
The type of order + non-stop flags.
Definition order_base.h:47
uint16_t wait_time
How long in ticks to wait at the destination.
Definition order_base.h:53
void SetRefit(CargoType cargo)
Make this depot/station order also a refit order.
void SetDepotOrderType(OrderDepotTypeFlags depot_order_type)
Set the cause to go to the depot.
Definition order_base.h:171
void SetWaitTime(uint16_t time)
Set the time in ticks to wait at the destination.
Definition order_base.h:218
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
Definition order_base.h:169
void MakeDummy()
Makes this order a Dummy order.
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
Definition order_cmd.cpp:87
void SetConditionVariable(OrderConditionVariable condition_variable)
Set variable we have to compare.
Definition order_base.h:175
OrderUnloadType GetUnloadType() const
How must the consist be unloaded?
Definition order_base.h:144
uint8_t flags
Load/unload types, depot order/action types.
Definition order_base.h:48
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:189
DestinationID dest
The destination of the order.
Definition order_base.h:49
void SetDestination(DestinationID destination)
Sets the destination of this order.
Definition order_base.h:106
void SetWaitTimetabled(bool timetabled)
Set if the wait time is explicitly timetabled (unless the order is conditional).
Definition order_base.h:210
bool IsTravelTimetabled() const
Does this order have an explicit travel time set?
Definition order_base.h:191
void SetConditionComparator(OrderConditionComparator condition_comparator)
Set the comparator to use.
Definition order_base.h:177
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:173
void SetConditionSkipToOrder(VehicleOrderID order_id)
Get the order to skip to.
Definition order_base.h:179
OrderLoadType GetLoadType() const
How must the consist be loaded?
Definition order_base.h:142
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition order_base.h:152
void MakeLeaveStation()
Makes this order a Leave Station order.
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
void SetConditionValue(uint16_t value)
Set the value to base the skip on.
Definition order_base.h:181
void SetUnloadType(OrderUnloadType unload_type)
Set how the consist must be unloaded.
Definition order_base.h:165
void Free()
'Free' the order
Definition order_cmd.cpp:47
uint16_t GetTimetabledWait() const
Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.
Definition order_base.h:194
bool ShouldStopAtStation(const Vehicle *v, StationID station) const
Check whether the given vehicle should stop at the given station based on this order and the non-stop...
CargoType refit_cargo
Refit CargoType.
Definition order_base.h:51
uint16_t GetTravelTime() const
Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
Definition order_base.h:200
void MakeImplicit(StationID destination)
Makes this order an implicit order.
void SetLoadType(OrderLoadType load_type)
Set how the consist must be loaded.
Definition order_base.h:163
void AssignOrder(const Order &other)
Assign data to an order (from another order) This function makes sure that the index is maintained co...
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
Definition order_base.h:156
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition order_base.h:146
bool IsRefit() const
Is this order a refit order.
Definition order_base.h:113
void MakeLoading(bool ordered)
Makes this order a Loading order.
Definition order_cmd.cpp:98
uint16_t GetConditionValue() const
Get the value to base the skip on.
Definition order_base.h:160
uint16_t travel_time
How long in ticks the journey to this destination should take.
Definition order_base.h:54
TileIndex tile
The base tile of the area.
static Pool::IterateWrapper< Vehicle > Iterate(size_t from=0)
static BaseStation * Get(auto index)
static BaseStation * GetIfValid(auto index)
static Station * Get(auto index)
static Station * GetIfValid(auto index)
static RoadVehicle * From(Vehicle *v)
Station data structure.
Airport airport
Tile area the airport covers.
Vehicle data structure.
EngineID engine_type
The type of engine used for this vehicle.
uint16_t & GetGroundVehicleFlags()
Access the ground vehicle flags of the vehicle.
Definition vehicle.cpp:3187
bool IsOrderListShared() const
Check if we share our orders with another vehicle.
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition vehicle.cpp:719
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
bool HasDepotOrder() const
Checks if a vehicle has a depot in its order list.
void LeaveStation()
Perform all actions when leaving a station.
Definition vehicle.cpp:2341
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
Definition vehicle.cpp:2970
bool HasUnbunchingOrder() const
Check if the current vehicle has an unbunching order.
Definition vehicle.cpp:2476
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
uint8_t day_counter
Increased by one for each day.
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into string parameters for string processing.
void IncrementImplicitOrderIndex()
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
VehStates vehstatus
Status.
VehicleOrderID GetNumManualOrders() const
Get the number of manually added orders this vehicle has.
virtual TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Order current_order
The current order (+ status, like: loading).
OrderList * orders
Pointer to the order list for this vehicle.
virtual ClosestDepot FindClosestDepot()
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
bool HasFullLoadOrder() const
Check if the current vehicle has a full load order.
Definition vehicle.cpp:2456
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
TimerGameCalendar::Date age
Age in calendar days.
TimerGameCalendar::Date max_age
Maximum age.
uint16_t reliability
Reliability.
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
void RemoveFromShared()
Removes the vehicle from the shared order list.
Definition vehicle.cpp:2993
TileIndex tile
Current tile index.
TileIndex dest_tile
Heading for this tile.
bool NeedsServicing() const
Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for ser...
Definition vehicle.cpp:201
bool HasConditionalOrder() const
Check if the current vehicle has a conditional order.
Definition vehicle.cpp:2467
StationID last_station_visited
The last station we stopped at.
Owner owner
Which company owns the vehicle?
void DeleteUnreachedImplicitOrders()
Delete all implicit orders which were not reached.
Definition vehicle.cpp:2158
void UpdateRealOrderIndex()
Skip implicit orders until cur_real_order_index is a non-implicit order.
Representation of a waypoint.
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
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
Functions related to time tabling.
void UpdateVehicleTimetable(Vehicle *v, bool travelling)
Update the timetable for the vehicle.
Command definitions related to trains.
StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st)
Get reason string why this station can't be used by the given vehicle.
Definition vehicle.cpp:3106
uint8_t CalcPercentVehicleFilled(const Vehicle *front, StringID *colour)
Calculates how full a vehicle is.
Definition vehicle.cpp:1477
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition vehicle.cpp:3060
@ Crashed
Vehicle is crashed.
@ Stopped
Vehicle is stopped by the player.
Functions related to vehicles.
@ 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
WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition vehicle_gui.h:97
PoolID< uint32_t, struct VehicleIDTag, 0xFF000, 0xFFFFF > VehicleID
The type all our vehicle IDs have.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
bool IsShipDepotTile(Tile t)
Is it a ship depot tile?
Definition water_map.h:234
Base of waypoints.
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Definition window.cpp:3218
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3310
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3188
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3328
@ WC_STATION_LIST
Station list; Window numbers:
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
@ WC_SHIPS_LIST
Ships list; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers: