OpenTTD Source: src/order_base.h Source File

OpenTTD Source 1.11.0-RC1

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 "date_type.h"
21
22 typedef Pool<Order, OrderID, 256, 0xFF0000> OrderPool;
23 typedef Pool<OrderList, OrderListID, 128, 64000> OrderListPool;
24 extern OrderPool _order_pool;
25 extern OrderListPool _orderlist_pool;
26
27 /* If you change this, keep in mind that it is saved on 3 places:
28 * - Load_ORDR, all the global orders
29 * - Vehicle -> current_order
30 * - REF_ORDER (all REFs are currently limited to 16 bits!!)
31 */
32 struct Order : OrderPool::PoolItem<&_order_pool> {
33 private:
34 friend const struct SaveLoad *GetVehicleDescription(VehicleType vt);
35 friend void Load_VEHS();
36 friend const struct SaveLoad *GetOrderDescription();
37
38 uint8 type;
39 uint8 flags;
40 DestinationID dest;
41
42 CargoID refit_cargo;
43
44 uint16 wait_time;
45 uint16 travel_time;
46 uint16 max_speed;
47
48 public:
49 Order *next;
50
51 Order() : flags(0), refit_cargo(CT_NO_REFIT), max_speed(UINT16_MAX) {}
52 ~Order();
53
54 Order(uint32 packed);
55
61 inline bool IsType(OrderType type) const { return this->GetType() == type; }
62
67 inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
68
69 void Free();
70
71 void MakeGoToStation(StationID destination);
72 void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type = ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action = ODATF_SERVICE_ONLY, CargoID cargo = CT_NO_REFIT);
73 void MakeGoToWaypoint(StationID destination);
74 void MakeLoading(bool ordered);
75 void MakeLeaveStation();
76 void MakeDummy();
77 void MakeConditional(VehicleOrderID order);
78 void MakeImplicit(StationID destination);
79
84 inline bool IsGotoOrder() const
85 {
86 return IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION);
87 }
88
94 inline DestinationID GetDestination() const { return this->dest; }
95
101 inline void SetDestination(DestinationID destination) { this->dest = destination; }
102
108 inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO || this->refit_cargo == CT_AUTO_REFIT; }
109
115 inline bool IsAutoRefit() const { return this->refit_cargo == CT_AUTO_REFIT; }
116
122 inline CargoID GetRefitCargo() const { return this->refit_cargo; }
123
124 void SetRefit(CargoID cargo);
125
127 inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 3); }
129 inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 3); }
131 inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
133 inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
135 inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 3); }
137 inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 3); }
139 inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
141 inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
143 inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
145 inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
146
148 inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 3, load_type); }
150 inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 3, unload_type); }
152 inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
154 inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
156 inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 3, depot_order_type); }
158 inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 3, depot_service_type); }
160 inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
162 inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
164 inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
166 inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
167
168 /* As conditional orders write their "skip to" order all over the flags, we cannot check the
169 * flags to find out if timetabling is enabled. However, as conditional orders are never
170 * autofilled we can be sure that any non-zero values for their wait_time and travel_time are
171 * explicitly set (but travel_time is actually unused for conditionals). */
172
174 inline bool IsWaitTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->wait_time > 0 : HasBit(this->flags, 3); }
176 inline bool IsTravelTimetabled() const { return this->IsType(OT_CONDITIONAL) ? this->travel_time > 0 : HasBit(this->flags, 7); }
177
179 inline uint16 GetTimetabledWait() const { return this->IsWaitTimetabled() ? this->wait_time : 0; }
181 inline uint16 GetTimetabledTravel() const { return this->IsTravelTimetabled() ? this->travel_time : 0; }
183 inline uint16 GetWaitTime() const { return this->wait_time; }
185 inline uint16 GetTravelTime() const { return this->travel_time; }
186
192 inline uint16 GetMaxSpeed() const { return this->max_speed; }
193
195 inline void SetWaitTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 3, 1, timetabled ? 1 : 0); }
197 inline void SetTravelTimetabled(bool timetabled) { if (!this->IsType(OT_CONDITIONAL)) SB(this->flags, 7, 1, timetabled ? 1 : 0); }
198
203 inline void SetWaitTime(uint16 time) { this->wait_time = time; }
204
209 inline void SetTravelTime(uint16 time) { this->travel_time = time; }
210
216 inline void SetMaxSpeed(uint16 speed) { this->max_speed = speed; }
217
218 bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
219 bool CanLoadOrUnload() const;
220 bool CanLeaveWithCargo(bool has_cargo) const;
221
222 TileIndex GetLocation(const Vehicle *v, bool airport = false) const;
223
225 inline bool IsCompletelyTimetabled() const
226 {
227 if (!this->IsTravelTimetabled() && !this->IsType(OT_CONDITIONAL)) return false;
228 if (!this->IsWaitTimetabled() && this->IsType(OT_GOTO_STATION) &&
229 !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) {
230 return false;
231 }
232 return true;
233 }
234
235 void AssignOrder(const Order &other);
236 bool Equals(const Order &other) const;
237
238 uint32 Pack() const;
239 uint16 MapOldOrder() const;
240 void ConvertFromOldSavegame();
241 };
242
243 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
244 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
245
250 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
251 private:
252 friend void AfterLoadVehicles(bool part_of_load);
253 friend const struct SaveLoad *GetOrderListDescription();
254
255 StationID GetBestLoadableNext(const Vehicle *v, const Order *o1, const Order *o2) const;
256
257 Order *first;
258 VehicleOrderID num_orders;
259 VehicleOrderID num_manual_orders;
260 uint num_vehicles;
261 Vehicle *first_shared;
262
263 Ticks timetable_duration;
264 Ticks total_duration;
265
266 public:
268 OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
269 : first(nullptr), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(nullptr),
270 timetable_duration(0), total_duration(0) { }
271
277 OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
278
280 ~OrderList() {}
281
282 void Initialize(Order *chain, Vehicle *v);
283
284 void RecalculateTimetableDuration();
285
290 inline Order *GetFirstOrder() const { return this->first; }
291
292 Order *GetOrderAt(int index) const;
293
298 inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
299
306 inline const Order *GetNext(const Order *curr) const { return (curr->next == nullptr) ? this->GetFirstOrder() : curr->next; }
307
312 inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
313
318 inline VehicleOrderID GetNumManualOrders() const { return this->num_manual_orders; }
319
320 StationIDStack GetNextStoppingStation(const Vehicle *v, const Order *first = nullptr, uint hops = 0) const;
321 const Order *GetNextDecisionNode(const Order *next, uint hops) const;
322
323 void InsertOrderAt(Order *new_order, int index);
324 void DeleteOrderAt(int index);
325 void MoveOrder(int from, int to);
326
331 inline bool IsShared() const { return this->num_vehicles > 1; };
332
337 inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
338
343 inline uint GetNumVehicles() const { return this->num_vehicles; }
344
345 bool IsVehicleInSharedOrdersList(const Vehicle *v) const;
346 int GetPositionInSharedOrderList(const Vehicle *v) const;
347
354 inline void AddVehicle(Vehicle *v) { ++this->num_vehicles; }
355
356 void RemoveVehicle(Vehicle *v);
357
358 bool IsCompleteTimetable() const;
359
364 inline Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : INVALID_TICKS; }
365
370 inline Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
371
376 inline Ticks GetTotalDuration() const { return this->total_duration; }
377
382 void UpdateTimetableDuration(Ticks delta) { this->timetable_duration += delta; }
383
388 void UpdateTotalDuration(Ticks delta) { this->total_duration += delta; }
389
390 void FreeChain(bool keep_orderlist = false);
391
392 void DebugCheckSanity() const;
393 };
394
395 #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:261
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:108
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
Order::GetWaitTime
uint16 GetWaitTime() const
Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
Definition: order_base.h:183
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:132
SmallStack
Minimal stack that uses a pool to avoid pointers.
Definition: smallstack_type.hpp:136
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:61
Order::GetTimetabledWait
uint16 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:179
Order::SetLoadType
void SetLoadType(OrderLoadFlags load_type)
Set how the consist must be loaded.
Definition: order_base.h:148
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
OrderList::GetTotalDuration
Ticks GetTotalDuration() const
Gets the known duration of the vehicles orders, timetabled or not.
Definition: order_base.h:376
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:114
Order::MakeLeaveStation
void MakeLeaveStation()
Makes this order a Leave Station order.
Definition: order_cmd.cpp:123
OrderList::UpdateTimetableDuration
void UpdateTimetableDuration(Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:382
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:94
OrderList::total_duration
Ticks total_duration
NOSAVE: Total (timetabled or not) duration of the order list.
Definition: order_base.h:264
Order::GetTimetabledTravel
uint16 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:181
Order::GetConditionValue
uint16 GetConditionValue() const
Get the value to base the skip on.
Definition: order_base.h:145
OrderList::MoveOrder
void MoveOrder(int from, int to)
Move an order to another position within the order list.
Definition: order_cmd.cpp:535
DepotID
uint16 DepotID
Type for the unique identifier of depots.
Definition: depot_type.h:13
Pool::PoolItem<&_orderlist_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
Order::wait_time
uint16 wait_time
How long in ticks to wait at the destination.
Definition: order_base.h:44
Order::Free
void Free()
'Free' the order
Definition: order_cmd.cpp:62
Order::Load_VEHS
friend void Load_VEHS()
Loading of ancient vehicles.
Definition: vehicle_sl.cpp:894
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
Order::SetTravelTimetabled
void SetTravelTimetabled(bool timetabled)
Set if the travel time is explicitly timetabled (unless the order is conditional).
Definition: order_base.h:197
Order::GetUnloadType
OrderUnloadFlags GetUnloadType() const
How must the consist be unloaded?
Definition: order_base.h:129
OrderDepotTypeFlags
OrderDepotTypeFlags
Reasons that could cause us to go to the depot.
Definition: order_type.h:93
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:272
OrderList::IsCompleteTimetable
bool IsCompleteTimetable() const
Checks whether all orders of the list have a filled timetable.
Definition: order_cmd.cpp:602
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
OrderList::IsShared
bool IsShared() const
Is this a shared order list?
Definition: order_base.h:331
OrderList::GetTimetableTotalDuration
Ticks GetTimetableTotalDuration() const
Gets the total duration of the vehicles timetable or INVALID_TICKS is the timetable is not complete.
Definition: order_base.h:364
OrderList::RemoveVehicle
void RemoveVehicle(Vehicle *v)
Removes the vehicle from the shared order list.
Definition: order_cmd.cpp:567
OrderStopLocation
OrderStopLocation
Where to stop the trains.
Definition: order_type.h:83
OrderList::OrderList
OrderList(VehicleOrderID num_orders=INVALID_VEH_ORDER_ID)
Default constructor producing an invalid order list.
Definition: order_base.h:268
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:379
Order::Pack
uint32 Pack() const
Pack this order into a 32 bits integer, or actually only the type, flags and destination.
Definition: order_cmd.cpp:197
Order::GetVehicleDescription
friend const struct SaveLoad * GetVehicleDescription(VehicleType vt)
Saving and loading the current order of vehicles.
Definition: vehicle_sl.cpp:581
OrderList::timetable_duration
Ticks timetable_duration
NOSAVE: Total timetabled duration of the order list.
Definition: order_base.h:263
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=CT_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:89
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:67
Order::GetMaxSpeed
uint16 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:192
InsertOrder
void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
Insert a new order but skip the validation.
Definition: order_cmd.cpp:927
Order::GetStopLocation
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition: order_base.h:133
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:131
bitmath_func.hpp
Order::GetRefitCargo
CargoID GetRefitCargo() const
Get the cargo to to refit to.
Definition: order_base.h:122
OrderList::GetNumManualOrders
VehicleOrderID GetNumManualOrders() const
Get number of manually added orders in the order list.
Definition: order_base.h:318
INVALID_VEH_ORDER_ID
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition: order_type.h:21
Order::MakeGoToWaypoint
void MakeGoToWaypoint(StationID destination)
Makes this order a Go To Waypoint order.
Definition: order_cmd.cpp:103
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
OrderList::GetFirstSharedVehicle
Vehicle * GetFirstSharedVehicle() const
Get the first vehicle of this vehicle chain.
Definition: order_base.h:337
cargo_type.h
Order::GetTravelTime
uint16 GetTravelTime() const
Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
Definition: order_base.h:185
Order::SetDestination
void SetDestination(DestinationID destination)
Sets the destination of this order.
Definition: order_base.h:101
DeleteOrder
void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord)
Delete an order but skip the parameter validation.
Definition: order_cmd.cpp:1054
OrderList::DeleteOrderAt
void DeleteOrderAt(int index)
Remove an order from the order list and delete it.
Definition: order_cmd.cpp:509
Order::SetTravelTime
void SetTravelTime(uint16 time)
Set the time in ticks to take for travelling to the destination.
Definition: order_base.h:209
OrderList::Initialize
void Initialize(Order *chain, Vehicle *v)
Recomputes everything.
Definition: order_cmd.cpp:290
OrderList::num_manual_orders
VehicleOrderID num_manual_orders
NOSAVE: How many manually added orders are there in the list.
Definition: order_base.h:259
Ticks
int32 Ticks
The type to store ticks in.
Definition: date_type.h:16
Order::IsGotoOrder
bool IsGotoOrder() const
Is this a 'goto' order with a real destination?
Definition: order_base.h:84
Order::GetConditionComparator
OrderConditionComparator GetConditionComparator() const
What is the comparator to use?
Definition: order_base.h:141
OrderList::FreeChain
void FreeChain(bool keep_orderlist=false)
Free a complete order chain.
Definition: order_cmd.cpp:333
OrderList::GetPositionInSharedOrderList
int GetPositionInSharedOrderList(const Vehicle *v) const
Gets the position of the given vehicle within the shared order vehicle list.
Definition: order_cmd.cpp:591
Order::SetConditionValue
void SetConditionValue(uint16 value)
Set the value to base the skip on.
Definition: order_base.h:166
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:23
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:225
Order::MakeGoToStation
void MakeGoToStation(StationID destination)
Makes this order a Go To Station order.
Definition: order_cmd.cpp:74
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:414
Order::GetConditionSkipToOrder
VehicleOrderID GetConditionSkipToOrder() const
Get the order to skip to.
Definition: order_base.h:143
Order::max_speed
uint16 max_speed
How fast the vehicle may go on the way to the destination.
Definition: order_base.h:46
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
Order::SetStopLocation
void SetStopLocation(OrderStopLocation stop_location)
Set where we must stop at the platform.
Definition: order_base.h:154
OrderList::GetOrderAt
Order * GetOrderAt(int index) const
Get a certain order of the order chain.
Definition: order_cmd.cpp:356
INVALID_TICKS
static const Ticks INVALID_TICKS
Representation of an invalid number of ticks.
Definition: date_type.h:111
OrderList::OrderList
OrderList(Order *chain, Vehicle *v)
Create an order list with the given order chain for the given vehicle.
Definition: order_base.h:277
date_type.h
Order::IsTravelTimetabled
bool IsTravelTimetabled() const
Does this order have an explicit travel time set?
Definition: order_base.h:176
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
OrderList::UpdateTotalDuration
void UpdateTotalDuration(Ticks delta)
Must be called if an order's timetable is changed to update internal book keeping.
Definition: order_base.h:388
Order::SetRefit
void SetRefit(CargoID cargo)
Make this depot/station order also a refit order.
Definition: order_cmd.cpp:164
OrderUnloadFlags
OrderUnloadFlags
Flags related to the unloading order.
Definition: order_type.h:52
OrderNonStopFlags
OrderNonStopFlags
Non-stop order flags.
Definition: order_type.h:72
OrderList::DebugCheckSanity
void DebugCheckSanity() const
Checks for internal consistency of order list.
Definition: order_cmd.cpp:615
vehicle_type.h
Pool
Base class for all pools.
Definition: pool_type.hpp:81
Order::SetConditionVariable
void SetConditionVariable(OrderConditionVariable condition_variable)
Set variable we have to compare.
Definition: order_base.h:160
Order::refit_cargo
CargoID refit_cargo
Refit CargoID.
Definition: order_base.h:42
OrderList::~OrderList
~OrderList()
Destructor.
Definition: order_base.h:280
OrderList::AddVehicle
void AddVehicle(Vehicle *v)
Adds the given vehicle to this shared order list.
Definition: order_base.h:354
Order::~Order
~Order()
Clean everything up.
Definition: order_cmd.cpp:46
OrderList::RecalculateTimetableDuration
void RecalculateTimetableDuration()
Recomputes Timetable duration.
Definition: order_cmd.cpp:320
depot_type.h
Order::MapOldOrder
uint16 MapOldOrder() const
Pack this order into a 16 bits integer as close to the TTD representation as possible.
Definition: order_cmd.cpp:207
OrderList
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition: order_base.h:250
OrderList::GetTimetableDurationIncomplete
Ticks GetTimetableDurationIncomplete() const
Gets the known duration of the vehicles timetable even if the timetable is not complete.
Definition: order_base.h:370
Order::SetConditionSkipToOrder
void SetConditionSkipToOrder(VehicleOrderID order_id)
Get the order to skip to.
Definition: order_base.h:164
CT_AUTO_REFIT
@ CT_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition: cargo_type.h:66
OrderList::GetLastOrder
Order * GetLastOrder() const
Get the last order of the order chain.
Definition: order_base.h:298
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:64
Order::SetWaitTime
void SetWaitTime(uint16 time)
Set the time in ticks to wait at the destination.
Definition: order_base.h:203
Order::SetDepotOrderType
void SetDepotOrderType(OrderDepotTypeFlags depot_order_type)
Set the cause to go to the depot.
Definition: order_base.h:156
Order::IsAutoRefit
bool IsAutoRefit() const
Is this order a auto-refit order.
Definition: order_base.h:115
OrderList::first
Order * first
First order of the order list.
Definition: order_base.h:257
Order::SetDepotActionType
void SetDepotActionType(OrderDepotActionFlags depot_service_type)
Set what we are going to do in the depot.
Definition: order_base.h:158
Order::MakeConditional
void MakeConditional(VehicleOrderID order)
Makes this order an conditional order.
Definition: order_cmd.cpp:142
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:2229
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:135
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:306
OrderList::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the order chain.
Definition: order_base.h:290
Order::GetConditionVariable
OrderConditionVariable GetConditionVariable() const
What variable do we have to compare?
Definition: order_base.h:139
OrderList::AfterLoadVehicles
friend void AfterLoadVehicles(bool part_of_load)
For instantiating the shared vehicle chain.
Definition: vehicle_sl.cpp:240
OrderList::num_vehicles
uint num_vehicles
NOSAVE: Number of vehicles that share this order list.
Definition: order_base.h:260
OrderList::GetOrderListDescription
friend const struct SaveLoad * GetOrderListDescription()
Saving and loading of order lists.
Definition: order_sl.cpp:199
Order::SetConditionComparator
void SetConditionComparator(OrderConditionComparator condition_comparator)
Set the comparator to use.
Definition: order_base.h:162
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:112
OrderList::GetNumVehicles
uint GetNumVehicles() const
Return the number of vehicles that share this orders list.
Definition: order_base.h:343
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:680
Order::SetMaxSpeed
void SetMaxSpeed(uint16 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:216
Order::SetUnloadType
void SetUnloadType(OrderUnloadFlags unload_type)
Set how the consist must be unloaded.
Definition: order_base.h:150
pool_type.hpp
OrderList::IsVehicleInSharedOrdersList
bool IsVehicleInSharedOrdersList(const Vehicle *v) const
Checks whether a vehicle is part of the shared vehicle chain.
Definition: order_cmd.cpp:577
SaveLoad
SaveLoad type struct.
Definition: saveload.h:516
Order::travel_time
uint16 travel_time
How long in ticks the journey to this destination should take.
Definition: order_base.h:45
Order::CanLeaveWithCargo
bool CanLeaveWithCargo(bool has_cargo) const
A vehicle can leave the current station with cargo if:
Definition: order_cmd.cpp:2253
Order::GetOrderDescription
friend const struct SaveLoad * GetOrderDescription()
Saving and loading of orders.
Definition: order_sl.cpp:102
OrderDepotActionFlags
OrderDepotActionFlags
Actions that can be performed when the vehicle enters the depot.
Definition: order_type.h:102
CT_NO_REFIT
@ CT_NO_REFIT
Do not refit cargo of a vehicle (used in vehicle orders and auto-replace/auto-new).
Definition: cargo_type.h:67
Order::GetDepotActionType
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition: order_base.h:137
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:226
order_type.h
Order::next
Order * next
Pointer to next order. If nullptr, end of list.
Definition: order_base.h:49
Order::flags
uint8 flags
Load/unload types, depot order/action types.
Definition: order_base.h:39
Order
Definition: order_base.h:32
Order::type
uint8 type
The type of order + non-stop flags.
Definition: order_base.h:38
OrderList::GetNumOrders
VehicleOrderID GetNumOrders() const
Get number of orders in the order list.
Definition: order_base.h:312
Order::Equals
bool Equals(const Order &other) const
Does this order have the same type, flags and destination?
Definition: order_cmd.cpp:174
OrderList::InsertOrderAt
void InsertOrderAt(Order *new_order, int index)
Insert a new order into the order chain.
Definition: order_cmd.cpp:471
Order::IsWaitTimetabled
bool IsWaitTimetabled() const
Does this order have an explicit wait time set?
Definition: order_base.h:174
Order::SetNonStopType
void SetNonStopType(OrderNonStopFlags non_stop_type)
Set whether we must stop at stations or not.
Definition: order_base.h:152
Order::dest
DestinationID dest
The destination of the order.
Definition: order_base.h:40
Order::MakeImplicit
void MakeImplicit(StationID destination)
Makes this order an implicit order.
Definition: order_cmd.cpp:153
OrderConditionComparator
OrderConditionComparator
Comparator for the skip reasoning.
Definition: order_type.h:127
OrderList::num_orders
VehicleOrderID num_orders
NOSAVE: How many orders there are in the list.
Definition: order_base.h:258
Order::GetLoadType
OrderLoadFlags GetLoadType() const
How must the consist be loaded?
Definition: order_base.h:127
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:195