OpenTTD Source: src/order_base.h Source File

OpenTTD Source 14.0-beta1

order_base.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef ORDER_BASE_H
11 #define ORDER_BASE_H
12
13 #include "order_type.h"
14 #include "core/pool_type.hpp"
15 #include "core/bitmath_func.hpp"
16 #include "cargo_type.h"
17 #include "depot_type.h"
18 #include "station_type.h"
19 #include "vehicle_type.h"
20 #include "timer/timer_game_tick.h"
21 #include "saveload/saveload.h"
22
23 typedef Pool<Order, OrderID, 256, 0xFF0000> OrderPool;
24 typedef Pool<OrderList, OrderListID, 128, 64000> OrderListPool;
25 extern OrderPool _order_pool;
26 extern OrderListPool _orderlist_pool;
27
28 template <typename, typename>
29 class EndianBufferWriter;
30
31 /* If you change this, keep in mind that it is saved on 3 places:
32 * - Load_ORDR, all the global orders
33 * - Vehicle -> current_order
34 * - REF_ORDER (all REFs are currently limited to 16 bits!!)
35 */
36 struct Order : OrderPool::PoolItem<&_order_pool> {
37 private:
38 friend struct VEHSChunkHandler;
39 friend SaveLoadTable GetOrderDescription();
40 /* So we can use private/protected variables in the saveload code */
41 friend class SlVehicleCommon;
42 friend class SlVehicleDisaster;
43
44 template <typename Tcont, typename Titer>
45 friend EndianBufferWriter<Tcont, Titer> &operator <<(EndianBufferWriter<Tcont, Titer> &buffer, const Order &data);
46 friend class EndianBufferReader &operator >>(class EndianBufferReader &buffer, Order &order);
47
48 uint8_t type;
49 uint8_t flags;
50 DestinationID dest;
51
52 CargoID refit_cargo;
53
54 uint16_t wait_time;
55 uint16_t travel_time;
56 uint16_t max_speed;
57
58 public:
59 Order *next;
60
61 Order() : flags(0), refit_cargo(CARGO_NO_REFIT), wait_time(0), travel_time(0), max_speed(UINT16_MAX) {}
62 ~Order();
63
64 Order(uint32_t packed);
65
71 inline bool IsType(OrderType type) const { return this->GetType() == type; }
72
77 inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
78
79 void Free();
80
81 void MakeGoToStation(StationID destination);
82 void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type = ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action = ODATF_SERVICE_ONLY, CargoID cargo = CARGO_NO_REFIT);
83 void MakeGoToWaypoint(StationID destination);
84 void MakeLoading(bool ordered);
85 void MakeLeaveStation();
86 void MakeDummy();
87 void MakeConditional(VehicleOrderID order);
88 void MakeImplicit(StationID destination);
89
94 inline bool IsGotoOrder() const
95 {
96 return IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION);
97 }
98
104 inline DestinationID GetDestination() const { return this->dest; }
105
111 inline void SetDestination(DestinationID destination) { this->dest = destination; }
112
118 inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO || this->refit_cargo == CARGO_AUTO_REFIT; }
119
125 inline bool IsAutoRefit() const { return this->refit_cargo == CARGO_AUTO_REFIT; }
126
132 inline CargoID GetRefitCargo() const { return this->refit_cargo; }
133
134 void SetRefit(CargoID cargo);
135
137 inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 3); }
139 inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 3); }
141 inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
143 inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
145 inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 3); }
147 inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 3, 4); }
149 inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
151 inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
153 inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
155 inline uint16_t GetConditionValue() const { return GB(this->dest, 0, 11); }
156
158 inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 3, load_type); }
160 inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 3, unload_type); }
162 inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
164 inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
166 inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 3, depot_order_type); }
168 inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 3, 4, depot_service_type); }
170 inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
172 inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
174 inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
176 inline void SetConditionValue(uint16_t value) { SB(this->dest, 0, 11, value); }
177
178 /* As conditional orders write their "skip to" order all over the flags, we cannot check the
179 * flags to find out if timetabling is enabled. However, as conditional orders are never
180 * autofilled we can be sure that any non-zero values for their wait_time and travel_time are
181 * explicitly set (but travel_time is actually unused for conditionals). */
182
184 inline bool IsWaitTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->wait_time > 0 : HasBit(this->flags, 3); }
186 inline bool IsTravelTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->travel_time > 0 : HasBit(this->flags, 7); }
187
189 inline uint16_t GetTimetabledWait() const { return this->IsWaitTimetabled() ? this->wait_time : 0; }
191 inline uint16_t GetTimetabledTravel() const { return this->IsTravelTimetabled() ? this->travel_time : 0; }
193 inline uint16_t GetWaitTime() const { return this->wait_time; }
195 inline uint16_t GetTravelTime() const { return this->travel_time; }
196
202 inline uint16_t GetMaxSpeed() const { return this->max_speed; }
203
205 inline void SetWaitTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 3, 1, timetabled ? 1 : 0); }
207 inline void SetTravelTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 7, 1, timetabled ? 1 : 0); }
208
213 inline void SetWaitTime(uint16_t time) { this->wait_time = time; }
214
219 inline void SetTravelTime(uint16_t time) { this->travel_time = time; }
220
226 inline void SetMaxSpeed(uint16_t speed) { this->max_speed = speed; }
227
228 bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
229 bool CanLoadOrUnload() const;
230 bool CanLeaveWithCargo(bool has_cargo) const;
231
232 TileIndex GetLocation(const Vehicle *v, bool airport = false) const;
233
235 inline bool IsCompletelyTimetabled() const
236 {
237 if (!this->IsTravelTimetabled() && !this->IsType(OT_CONDITIONAL)) return false;
238 if (!this->IsWaitTimetabled() && this->IsType(OT_GOTO_STATION) &&
239 !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) {
240 return false;
241 }
242 return true;
243 }
244
245 void AssignOrder(const Order &other);
246 bool Equals(const Order &other) const;
247
248 uint32_t Pack() const;
249 uint16_t MapOldOrder() const;
250 void ConvertFromOldSavegame();
251 };
252
253 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
254 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
255
260 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
261 private:
262 friend void AfterLoadVehicles(bool part_of_load);
263 friend SaveLoadTable GetOrderListDescription();
264
265 Order *first;
266 VehicleOrderID num_orders;
267 VehicleOrderID num_manual_orders;
268 uint num_vehicles;
269 Vehicle *first_shared;
270
271 TimerGameTick::Ticks timetable_duration;
272 TimerGameTick::Ticks total_duration;
273
274 public:
276 OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
277 : first(nullptr), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(nullptr),
278 timetable_duration(0), total_duration(0) { }
279
285 OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
286
288 ~OrderList() {}
289
290 void Initialize(Order *chain, Vehicle *v);
291
292 void RecalculateTimetableDuration();
293
298 inline Order *GetFirstOrder() const { return this->first; }
299
300 Order *GetOrderAt(int index) const;
301
306 inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
307
314 inline const Order *GetNext(const Order *curr) const { return (curr->next == nullptr) ? this->GetFirstOrder() : curr->next; }
315
320 inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
321
326 inline VehicleOrderID GetNumManualOrders() const { return this->num_manual_orders; }
327
328 StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first = nullptr, uint hops = 0) const;
329 const Order *GetNextDecisionNode(const Order *next, uint hops) const;
330
331 void InsertOrderAt(Order *new_order, int index);
332 void DeleteOrderAt(int index);
333 void MoveOrder(int from, int to);
334
339 inline bool IsShared() const { return this->num_vehicles > 1; };
340
345 inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
346
351 inline uint GetNumVehicles() const { return this->num_vehicles; }
352
359 inline void AddVehicle([[maybe_unused]] Vehicle *v) { ++this->num_vehicles; }
360
361 void RemoveVehicle(Vehicle *v);
362
363 bool IsCompleteTimetable() const;
364
369 inline TimerGameTick::Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : Ticks::INVALID_TICKS; }
370
375 inline TimerGameTick::Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
376
381 inline TimerGameTick::Ticks GetTotalDuration() const { return this->total_duration; }
382
387 void UpdateTimetableDuration(TimerGameTick::Ticks delta) { this->timetable_duration += delta; }
388
393 void UpdateTotalDuration(TimerGameTick::Ticks delta) { this->total_duration += delta; }
394
395 void FreeChain(bool keep_orderlist = false);
396
397 void DebugCheckSanity() const;
398 };
399
400 #endif /* ORDER_BASE_H */
OrderList::first_shared
Vehicle * first_shared
NOSAVE: pointer to the first vehicle in the shared order chain.
Definition: order_base.h:269
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
Order::IsRefit
bool IsRefit() const
Is this order a refit order.
Definition: order_base.h:118
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:133
SmallStack
Minimal stack that uses a pool to avoid pointers.
Definition: smallstack_type.hpp:135
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:71
Order::SetLoadType
void SetLoadType(OrderLoadFlags load_type)
Set how the consist must be loaded.
Definition: order_base.h:158
CARGO_NO_REFIT
static const CargoID CARGO_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-renew).
Definition: cargo_type.h:72
SaveLoadTable
std::span< const struct SaveLoad > SaveLoadTable
A table of SaveLoad entries.
Definition: saveload.h:494
OrderLoadFlags
OrderLoadFlags
Flags related to the loading order.
Definition: order_type.h:62
Order::MakeLoading
void MakeLoading(bool ordered)
Makes this order a Loading order.
Definition: order_cmd.cpp:115
Order::MakeLeaveStation
void MakeLeaveStation()
Makes this order a Leave Station order.
Definition: order_cmd.cpp:124
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:104
Order::GetConditionValue
uint16_t GetConditionValue() const
Get the value to base the skip on.
Definition: order_base.h:155
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
OrderList::MoveOrder
void MoveOrder(int from, int to)
Move an order to another position within the order list.
Definition: order_cmd.cpp:536
OrderList::UpdateTimetableDuration
void UpdateTimetableDuration(TimerGameTick::Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:387
Pool::PoolItem<&_orderlist_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
Order::Free
void Free()
'Free' the order
Definition: order_cmd.cpp:63
Order::SetTravelTimetabled
void SetTravelTimetabled(bool timetabled)
Set if the travel time is explicitly timetabled (unless the order is conditional).
Definition: order_base.h:207
Order::GetUnloadType
OrderUnloadFlags GetUnloadType() const
How must the consist be unloaded?
Definition: order_base.h:139
saveload.h
OrderDepotTypeFlags
OrderDepotTypeFlags
Reasons that could cause us to go to the depot.
Definition: order_type.h:93
Order::GetOrderDescription
friend SaveLoadTable GetOrderDescription()
Saving and loading of orders.
Definition: order_sl.cpp:105
Order::AssignOrder
void AssignOrder(const Order &other)
Assign data to an order (from another order) This function makes sure that the index is maintained co...
Definition: order_cmd.cpp:273
OrderList::IsCompleteTimetable
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
Definition: order_cmd.cpp:578
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
Order::type
uint8_t type
The type of order + non-stop flags.
Definition: order_base.h:48
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
VEHSChunkHandler
Definition: vehicle_sl.cpp:1034
OrderList::IsShared
bool IsShared() const
Is this a shared order list?
Definition: order_base.h:339
OrderList::RemoveVehicle
void RemoveVehicle(Vehicle *v)
Removes the vehicle from the shared order list.
Definition: order_cmd.cpp:568
OrderStopLocation
OrderStopLocation
Where to stop the trains.
Definition: order_type.h:83
OrderList::GetTimetableDurationIncomplete
TimerGameTick::Ticks GetTimetableDurationIncomplete() const
Gets the known duration of the vehicles timetable even if the timetable is not complete.
Definition: order_base.h:375
OrderList::GetOrderListDescription
friend SaveLoadTable GetOrderListDescription()
Saving and loading of order lists.
Definition: order_sl.cpp:201
OrderList::OrderList
OrderList(VehicleOrderID num_orders=INVALID_VEH_ORDER_ID)
Default constructor producing an invalid order list.
Definition: order_base.h:276
OrderList::GetNextDecisionNode
const Order * GetNextDecisionNode(const Order *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...
Definition: order_cmd.cpp:380
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:77
InsertOrder
void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
Insert a new order but skip the validation.
Definition: order_cmd.cpp:911
Order::GetStopLocation
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition: order_base.h:143
SlVehicleCommon
Definition: vehicle_sl.cpp:606
Order::wait_time
uint16_t wait_time
How long in ticks to wait at the destination.
Definition: order_base.h:54
OrderList::UpdateTotalDuration
void UpdateTotalDuration(TimerGameTick::Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:393
ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS
@ ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS
The vehicle will not stop at any stations it passes except the destination.
Definition: order_type.h:74
Order::GetNonStopType
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition: order_base.h:141
bitmath_func.hpp
Order::GetRefitCargo
CargoID GetRefitCargo() const
Get the cargo to to refit to.
Definition: order_base.h:132
OrderList::GetNumManualOrders
VehicleOrderID GetNumManualOrders() const
Get number of manually added orders in the order list.
Definition: order_base.h:326
INVALID_VEH_ORDER_ID
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition: order_type.h:21
Order::GetTravelTime
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:195
Order::MakeGoToWaypoint
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
Definition: order_cmd.cpp:104
EndianBufferReader
Endian-aware buffer adapter that always reads values in little endian order.
Definition: endian_buffer.hpp:119
OrderList::GetFirstSharedVehicle
Vehicle * GetFirstSharedVehicle() const
Get the first vehicle of this vehicle chain.
Definition: order_base.h:345
cargo_type.h
Order::SetDestination
void SetDestination(DestinationID destination)
Sets the destination of this order.
Definition: order_base.h:111
Ticks::INVALID_TICKS
static constexpr TimerGameTick::Ticks INVALID_TICKS
Representation of an invalid number of ticks.
Definition: timer_game_tick.h:41
DeleteOrder
void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord)
Delete an order but skip the parameter validation.
Definition: order_cmd.cpp:1036
OrderList::DeleteOrderAt
void DeleteOrderAt(int index)
Remove an order from the order list and delete it.
Definition: order_cmd.cpp:510
timer_game_tick.h
OrderList::Initialize
void Initialize(Order *chain, Vehicle *v)
Recomputes everything.
Definition: order_cmd.cpp:291
OrderList::num_manual_orders
VehicleOrderID num_manual_orders
NOSAVE: How many manually added orders are there in the list.
Definition: order_base.h:267
Order::IsGotoOrder
bool IsGotoOrder() const
Is this a 'goto' order with a real destination?
Definition: order_base.h:94
Order::GetConditionComparator
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
Definition: order_base.h:151
OrderList::FreeChain
void FreeChain(bool keep_orderlist=false)
Free a complete order chain.
Definition: order_cmd.cpp:334
Order::SetWaitTime
void SetWaitTime(uint16_t time)
Set the time in ticks to wait at the destination.
Definition: order_base.h:213
Order::ConvertFromOldSavegame
void ConvertFromOldSavegame()
Converts this order from an old savegame's version; it moves all bits to the new location.
Definition: order_sl.cpp:26
EndianBufferReader::buffer
std::span< const byte > buffer
Reference to storage buffer.
Definition: endian_buffer.hpp:121
Order::IsCompletelyTimetabled
bool IsCompletelyTimetabled() const
Checks if travel_time and wait_time apply to this order and if they are timetabled.
Definition: order_base.h:235
Order::SetTravelTime
void SetTravelTime(uint16_t time)
Set the time in ticks to take for travelling to the destination.
Definition: order_base.h:219
Order::MakeGoToStation
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
Definition: order_cmd.cpp:75
OrderList::GetNextStoppingStation
StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first=nullptr, uint hops=0) const
Recursively determine the next deterministic station to stop at.
Definition: order_cmd.cpp:415
Order::GetConditionSkipToOrder
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition: order_base.h:153
Order::SetStopLocation
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
Definition: order_base.h:164
OrderList::GetOrderAt
Order * GetOrderAt(int index) const
Get a certain order of the order chain.
Definition: order_cmd.cpp:357
Order::flags
uint8_t flags
Load/unload types, depot order/action types.
Definition: order_base.h:49
OrderList::OrderList
OrderList(Order *chain, Vehicle *v)
Create an order list with the given order chain for the given vehicle.
Definition: order_base.h:285
Order::IsTravelTimetabled
bool IsTravelTimetabled() const
Does this order have an explicit travel time set?
Definition: order_base.h:186
ONSF_NO_STOP_AT_DESTINATION_STATION
@ ONSF_NO_STOP_AT_DESTINATION_STATION
The vehicle will stop at any station it passes except the destination.
Definition: order_type.h:75
CARGO_AUTO_REFIT
static const CargoID CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition: cargo_type.h:71
Order::GetWaitTime
uint16_t GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition: order_base.h:193
DepotID
uint16_t DepotID
Type for the unique identifier of depots.
Definition: depot_type.h:13
Order::SetRefit
void SetRefit(CargoID cargo)
Make this depot/station order also a refit order.
Definition: order_cmd.cpp:165
TimerGameTick::Ticks
int32_t Ticks
The type to store ticks in.
Definition: timer_game_tick.h:24
OrderUnloadFlags
OrderUnloadFlags
Flags related to the unloading order.
Definition: order_type.h:52
OrderNonStopFlags
OrderNonStopFlags
Non-stop order flags.
Definition: order_type.h:72
vehicle_type.h
Pool
Base class for all pools.
Definition: pool_type.hpp:80
Order::SetConditionVariable
void SetConditionVariable(OrderConditionVariable condition_variable)
Set variable we have to compare.
Definition: order_base.h:170
OrderList::GetTotalDuration
TimerGameTick::Ticks GetTotalDuration() const
Gets the known duration of the vehicles orders, timetabled or not.
Definition: order_base.h:381
Order::refit_cargo
CargoID refit_cargo
Refit CargoID.
Definition: order_base.h:52
OrderList::~OrderList
~OrderList()
Destructor.
Definition: order_base.h:288
OrderList::timetable_duration
TimerGameTick::Ticks timetable_duration
NOSAVE: Total timetabled duration of the order list.
Definition: order_base.h:271
Order::~Order
~Order()
Clean everything up.
Definition: order_cmd.cpp:47
OrderList::RecalculateTimetableDuration
void RecalculateTimetableDuration()
Recomputes Timetable duration.
Definition: order_cmd.cpp:321
depot_type.h
Order::GetTimetabledTravel
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:191
Order::GetTimetabledWait
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:189
OrderList
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition: order_base.h:260
Order::MapOldOrder
uint16_t MapOldOrder() const
Pack this order into a 16 bits integer as close to the TTD representation as possible.
Definition: order_cmd.cpp:208
Order::SetConditionSkipToOrder
void SetConditionSkipToOrder(VehicleOrderID order_id)
Get the order to skip to.
Definition: order_base.h:174
OrderList::GetLastOrder
Order * GetLastOrder() const
Get the last order of the order chain.
Definition: order_base.h:306
Order::max_speed
uint16_t max_speed
How fast the vehicle may go on the way to the destination.
Definition: order_base.h:56
Order::SetDepotOrderType
void SetDepotOrderType(OrderDepotTypeFlags depot_order_type)
Set the cause to go to the depot.
Definition: order_base.h:166
Order::IsAutoRefit
bool IsAutoRefit() const
Is this order a auto-refit order.
Definition: order_base.h:125
Order::Pack
uint32_t Pack() const
Pack this order into a 32 bits integer, or actually only the type, flags and destination.
Definition: order_cmd.cpp:198
OrderList::first
Order * first
First order of the order list.
Definition: order_base.h:265
Order::SetDepotActionType
void SetDepotActionType(OrderDepotActionFlags depot_service_type)
Set what we are going to do in the depot.
Definition: order_base.h:168
Order::GetMaxSpeed
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:202
Order::MakeConditional
void MakeConditional(VehicleOrderID order)
Makes this order an conditional order.
Definition: order_cmd.cpp:143
Order::ShouldStopAtStation
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...
Definition: order_cmd.cpp:2230
OrderType
OrderType
Order types.
Definition: order_type.h:35
Order::GetDepotOrderType
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition: order_base.h:145
OrderList::GetNext
const Order * GetNext(const Order *curr) const
Get the order after the given one or the first one, if the given one is the last one.
Definition: order_base.h:314
OrderList::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the order chain.
Definition: order_base.h:298
Order::GetConditionVariable
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
Definition: order_base.h:149
OrderList::AfterLoadVehicles
friend void AfterLoadVehicles(bool part_of_load)
For instantiating the shared vehicle chain.
Definition: vehicle_sl.cpp:255
OrderList::AddVehicle
void AddVehicle([[maybe_unused]] Vehicle *v)
Adds the given vehicle to this shared order list.
Definition: order_base.h:359
OrderList::num_vehicles
uint num_vehicles
NOSAVE: Number of vehicles that share this order list.
Definition: order_base.h:268
Order::SetConditionComparator
void SetConditionComparator(OrderConditionComparator condition_comparator)
Set the comparator to use.
Definition: order_base.h:172
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
OrderConditionVariable
OrderConditionVariable
Variables (of a vehicle) to 'cause' skipping on.
Definition: order_type.h:113
OrderList::GetNumVehicles
uint GetNumVehicles() const
Return the number of vehicles that share this orders list.
Definition: order_base.h:351
ODATF_SERVICE_ONLY
@ ODATF_SERVICE_ONLY
Only service the vehicle.
Definition: order_type.h:103
Order::GetLocation
TileIndex GetLocation(const Vehicle *v, bool airport=false) const
Returns a tile somewhat representing the order destination (not suitable for pathfinding).
Definition: order_cmd.cpp:658
SlVehicleDisaster
Definition: vehicle_sl.cpp:953
EndianBufferWriter
Endian-aware buffer adapter that always writes values in little endian order.
Definition: endian_buffer.hpp:26
SB
constexpr T SB(T &x, const uint8_t s, const uint8_t n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
Order::SetUnloadType
void SetUnloadType(OrderUnloadFlags unload_type)
Set how the consist must be unloaded.
Definition: order_base.h:160
Order::SetConditionValue
void SetConditionValue(uint16_t value)
Set the value to base the skip on.
Definition: order_base.h:176
pool_type.hpp
OrderList::GetTimetableTotalDuration
TimerGameTick::Ticks GetTimetableTotalDuration() const
Gets the total duration of the vehicles timetable or Ticks::INVALID_TICKS is the timetable is not com...
Definition: order_base.h:369
Order::travel_time
uint16_t travel_time
How long in ticks the journey to this destination should take.
Definition: order_base.h:55
NUM_CARGO
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:68
Order::SetMaxSpeed
void SetMaxSpeed(uint16_t speed)
Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
Definition: order_base.h:226
Order::CanLeaveWithCargo
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
Definition: order_cmd.cpp:2254
OrderDepotActionFlags
OrderDepotActionFlags
Actions that can be performed when the vehicle enters the depot.
Definition: order_type.h:102
Order::GetDepotActionType
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition: order_base.h:147
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:233
Order::MakeGoToDepot
void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action=ODATF_SERVICE_ONLY, CargoID cargo=CARGO_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:90
order_type.h
Order::next
Order * next
Pointer to next order. If nullptr, end of list.
Definition: order_base.h:59
OrderList::total_duration
TimerGameTick::Ticks total_duration
NOSAVE: Total (timetabled or not) duration of the order list.
Definition: order_base.h:272
Order
Definition: order_base.h:36
OrderList::GetNumOrders
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition: order_base.h:320
Order::Equals
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
Definition: order_cmd.cpp:175
OrderList::InsertOrderAt
void InsertOrderAt(Order *new_order, int index)
Insert a new order into the order chain.
Definition: order_cmd.cpp:472
Order::IsWaitTimetabled
bool IsWaitTimetabled() const
Does this order have an explicit wait time set?
Definition: order_base.h:184
Order::SetNonStopType
void SetNonStopType(OrderNonStopFlags non_stop_type)
Set whether we must stop at stations or not.
Definition: order_base.h:162
Order::dest
DestinationID dest
The destination of the order.
Definition: order_base.h:50
Order::MakeImplicit
void MakeImplicit(StationID destination)
Makes this order an implicit order.
Definition: order_cmd.cpp:154
OrderConditionComparator
OrderConditionComparator
Comparator for the skip reasoning.
Definition: order_type.h:128
OrderList::num_orders
VehicleOrderID num_orders
NOSAVE: How many orders there are in the list.
Definition: order_base.h:266
Order::GetLoadType
OrderLoadFlags GetLoadType() const
How must the consist be loaded?
Definition: order_base.h:137
station_type.h
Order::SetWaitTimetabled
void SetWaitTimetabled(bool timetabled)
Set if the wait time is explicitly timetabled (unless the order is conditional).
Definition: order_base.h:205
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103