OpenTTD
Public Member Functions | Data Fields | Private Attributes | Friends
Order Struct Reference
Inheritance diagram for Order:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >

Public Member Functions

 ~Order ()
 Clean everything up. More...
 
 Order (uint32 packed)
 Create an order based on a packed representation of that order. More...
 
bool IsType (OrderType type) const
 Check whether this order is of the given type. More...
 
OrderType GetType () const
 Get the type of order of this order. More...
 
void Free ()
 'Free' the order More...
 
void MakeGoToStation (StationID destination)
 Makes this order a Go To Station order. More...
 
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. More...
 
void MakeGoToWaypoint (StationID destination)
 Makes this order a Go To Waypoint order. More...
 
void MakeLoading (bool ordered)
 Makes this order a Loading order. More...
 
void MakeLeaveStation ()
 Makes this order a Leave Station order.
 
void MakeDummy ()
 Makes this order a Dummy order.
 
void MakeConditional (VehicleOrderID order)
 Makes this order an conditional order. More...
 
void MakeImplicit (StationID destination)
 Makes this order an implicit order. More...
 
bool IsGotoOrder () const
 Is this a 'goto' order with a real destination? More...
 
DestinationID GetDestination () const
 Gets the destination of this order. More...
 
void SetDestination (DestinationID destination)
 Sets the destination of this order. More...
 
bool IsRefit () const
 Is this order a refit order. More...
 
bool IsAutoRefit () const
 Is this order a auto-refit order. More...
 
CargoID GetRefitCargo () const
 Get the cargo to to refit to. More...
 
void SetRefit (CargoID cargo)
 Make this depot/station order also a refit order. More...
 
OrderLoadFlags GetLoadType () const
 How must the consist be loaded?
 
OrderUnloadFlags GetUnloadType () const
 How must the consist be unloaded?
 
OrderNonStopFlags GetNonStopType () const
 At which stations must we stop?
 
OrderStopLocation GetStopLocation () const
 Where must we stop at the platform?
 
OrderDepotTypeFlags GetDepotOrderType () const
 What caused us going to the depot?
 
OrderDepotActionFlags GetDepotActionType () const
 What are we going to do when in the depot. More...
 
OrderConditionVariable GetConditionVariable () const
 What variable do we have to compare?
 
OrderConditionComparator GetConditionComparator () const
 What is the comparator to use?
 
VehicleOrderID GetConditionSkipToOrder () const
 Get the order to skip to. More...
 
uint16 GetConditionValue () const
 Get the value to base the skip on. More...
 
void SetLoadType (OrderLoadFlags load_type)
 Set how the consist must be loaded. More...
 
void SetUnloadType (OrderUnloadFlags unload_type)
 Set how the consist must be unloaded. More...
 
void SetNonStopType (OrderNonStopFlags non_stop_type)
 Set whether we must stop at stations or not. More...
 
void SetStopLocation (OrderStopLocation stop_location)
 Set where we must stop at the platform. More...
 
void SetDepotOrderType (OrderDepotTypeFlags depot_order_type)
 Set the cause to go to the depot. More...
 
void SetDepotActionType (OrderDepotActionFlags depot_service_type)
 Set what we are going to do in the depot. More...
 
void SetConditionVariable (OrderConditionVariable condition_variable)
 Set variable we have to compare. More...
 
void SetConditionComparator (OrderConditionComparator condition_comparator)
 Set the comparator to use. More...
 
void SetConditionSkipToOrder (VehicleOrderID order_id)
 Get the order to skip to. More...
 
void SetConditionValue (uint16 value)
 Set the value to base the skip on. More...
 
bool IsWaitTimetabled () const
 Does this order have an explicit wait time set?
 
bool IsTravelTimetabled () const
 Does this order have an explicit travel time set?
 
uint16 GetTimetabledWait () const
 Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled. More...
 
uint16 GetTimetabledTravel () const
 Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled. More...
 
uint16 GetWaitTime () const
 Get the time in ticks a vehicle will probably wait at the destination (timetabled or not). More...
 
uint16 GetTravelTime () const
 Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not). More...
 
uint16 GetMaxSpeed () const
 Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination. More...
 
void SetWaitTimetabled (bool timetabled)
 Set if the wait time is explicitly timetabled (unless the order is conditional). More...
 
void SetTravelTimetabled (bool timetabled)
 Set if the travel time is explicitly timetabled (unless the order is conditional). More...
 
void SetWaitTime (uint16 time)
 Set the time in ticks to wait at the destination. More...
 
void SetTravelTime (uint16 time)
 Set the time in ticks to take for travelling to the destination. More...
 
void SetMaxSpeed (uint16 speed)
 Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination. More...
 
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 settings. More...
 
bool CanLoadOrUnload () const
 
bool CanLeaveWithCargo (bool has_cargo) const
 A vehicle can leave the current station with cargo if: More...
 
TileIndex GetLocation (const Vehicle *v, bool airport=false) const
 Returns a tile somewhat representing the order destination (not suitable for pathfinding). More...
 
bool IsCompletelyTimetabled () const
 Checks if travel_time and wait_time apply to this order and if they are timetabled. More...
 
void AssignOrder (const Order &other)
 Assign data to an order (from another order) This function makes sure that the index is maintained correctly. More...
 
bool Equals (const Order &other) const
 Does this order have the same type, flags and destination? More...
 
uint32 Pack () const
 Pack this order into a 32 bits integer, or actually only the type, flags and destination. More...
 
uint16 MapOldOrder () const
 Pack this order into a 16 bits integer as close to the TTD representation as possible. More...
 
void ConvertFromOldSavegame ()
 Converts this order from an old savegame's version; it moves all bits to the new location.
 
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t size, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 

Data Fields

Ordernext
 Pointer to next order. If NULL, end of list.
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >
Tindex index
 Index of this pool item.
 

Private Attributes

uint8 type
 The type of order + non-stop flags.
 
uint8 flags
 Load/unload types, depot order/action types.
 
DestinationID dest
 The destination of the order.
 
CargoID refit_cargo
 Refit CargoID.
 
uint16 wait_time
 How long in ticks to wait at the destination.
 
uint16 travel_time
 How long in ticks the journey to this destination should take.
 
uint16 max_speed
 How fast the vehicle may go on the way to the destination.
 

Friends

const struct SaveLoadGetVehicleDescription (VehicleType vt)
 Saving and loading the current order of vehicles. More...
 
void Load_VEHS ()
 Loading of ancient vehicles. More...
 
const struct SaveLoadGetOrderDescription ()
 Saving and loading of orders.
 

Additional Inherited Members

- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-NULL) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor (size_t index)
 Dummy function called after destructor of each member. More...
 

Detailed Description

Definition at line 34 of file order_base.h.

Constructor & Destructor Documentation

◆ ~Order()

Order::~Order ( )

Clean everything up.

Definition at line 48 of file order_cmd.cpp.

◆ Order()

Order::Order ( uint32  packed)

Create an order based on a packed representation of that order.

Parameters
packedthe packed representation.

Definition at line 235 of file order_cmd.cpp.

References CT_NO_REFIT, dest, flags, GB(), max_speed, next, refit_cargo, travel_time, type, and wait_time.

Member Function Documentation

◆ AssignOrder()

void Order::AssignOrder ( const Order other)

Assign data to an order (from another order) This function makes sure that the index is maintained correctly.

Parameters
otherthe data to copy (except next pointer).

Definition at line 274 of file order_cmd.cpp.

References dest, flags, max_speed, refit_cargo, travel_time, type, and wait_time.

◆ CanLeaveWithCargo()

bool Order::CanLeaveWithCargo ( bool  has_cargo) const

A vehicle can leave the current station with cargo if:

  1. it can load cargo here OR 2a. it could leave the last station with cargo AND 2b. it doesn't have to unload all cargo here.

Definition at line 2283 of file order_cmd.cpp.

References GetLoadType(), GetUnloadType(), OLFB_NO_LOAD, OUFB_TRANSFER, and OUFB_UNLOAD.

Referenced by SetMaxSpeed().

◆ Equals()

bool Order::Equals ( const Order other) const

Does this order have the same type, flags and destination?

Parameters
otherthe second order to compare to.
Returns
true if the type, flags and destination match.

Definition at line 176 of file order_cmd.cpp.

References IsType().

◆ Free()

void Order::Free ( )

'Free' the order

Note
ONLY use on "current_order" vehicle orders!

Definition at line 64 of file order_cmd.cpp.

References type.

Referenced by GetOrderCmdFromTile(), GetType(), and UpdateOrderDest().

◆ GetConditionSkipToOrder()

VehicleOrderID Order::GetConditionSkipToOrder ( ) const
inline

Get the order to skip to.

Definition at line 145 of file order_base.h.

References flags.

◆ GetConditionValue()

uint16 Order::GetConditionValue ( ) const
inline

Get the value to base the skip on.

Definition at line 147 of file order_base.h.

References GB().

◆ GetDepotActionType()

OrderDepotActionFlags Order::GetDepotActionType ( ) const
inline

What are we going to do when in the depot.

Definition at line 139 of file order_base.h.

References GB().

◆ GetDestination()

DestinationID Order::GetDestination ( ) const
inline

Gets the destination of this order.

Precondition
IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).
Returns
the destination of the order.

Definition at line 96 of file order_base.h.

References dest.

Referenced by AircraftController(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Zeppeliner(), LinkRefresher::RefreshStats(), ReleaseDisastersTargetingIndustry(), and ReleaseDisastersTargetingVehicle().

◆ GetLocation()

TileIndex Order::GetLocation ( const Vehicle v,
bool  airport = false 
) const

Returns a tile somewhat representing the order destination (not suitable for pathfinding).

Parameters
vThe vehicle to get the location for.
airportGet the airport tile and not the station location for aircraft.
Returns
destination of order, or INVALID_TILE if none.

Definition at line 670 of file order_cmd.cpp.

References GetType().

Referenced by VehicleViewWindow::OnClick(), and SetMaxSpeed().

◆ GetMaxSpeed()

uint16 Order::GetMaxSpeed ( ) const
inline

Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.

Returns
maximum speed.

Definition at line 194 of file order_base.h.

References max_speed.

◆ GetRefitCargo()

CargoID Order::GetRefitCargo ( ) const
inline

Get the cargo to to refit to.

Precondition
IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
Returns
the cargo type.

Definition at line 124 of file order_base.h.

References refit_cargo, and SetRefit().

◆ GetTimetabledTravel()

uint16 Order::GetTimetabledTravel ( ) const
inline

Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled.

Definition at line 183 of file order_base.h.

References IsTravelTimetabled(), and travel_time.

Referenced by ChangeTimetable().

◆ GetTimetabledWait()

uint16 Order::GetTimetabledWait ( ) const
inline

Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.

Definition at line 181 of file order_base.h.

References IsWaitTimetabled(), and wait_time.

Referenced by ChangeTimetable().

◆ GetTravelTime()

uint16 Order::GetTravelTime ( ) const
inline

Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).

Definition at line 187 of file order_base.h.

References travel_time.

Referenced by ChangeTimetable().

◆ GetType()

OrderType Order::GetType ( ) const
inline

◆ GetWaitTime()

uint16 Order::GetWaitTime ( ) const
inline

Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).

Definition at line 185 of file order_base.h.

References wait_time.

Referenced by ChangeTimetable().

◆ IsAutoRefit()

bool Order::IsAutoRefit ( ) const
inline

Is this order a auto-refit order.

Precondition
IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
Returns
true if a auto-refit should happen.

Definition at line 117 of file order_base.h.

References CT_AUTO_REFIT.

◆ IsCompletelyTimetabled()

bool Order::IsCompletelyTimetabled ( ) const
inline

Checks if travel_time and wait_time apply to this order and if they are timetabled.

Definition at line 227 of file order_base.h.

References IsTravelTimetabled(), and IsType().

◆ IsGotoOrder()

bool Order::IsGotoOrder ( ) const
inline

Is this a 'goto' order with a real destination?

Returns
True if the type is either #OT_GOTO_WAYPOINT, #OT_GOTO_DEPOT or #OT_GOTO_STATION.

Definition at line 86 of file order_base.h.

References IsType().

◆ IsRefit()

bool Order::IsRefit ( ) const
inline

Is this order a refit order.

Precondition
IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION)
Returns
true if a refit should happen.

Definition at line 110 of file order_base.h.

References CT_AUTO_REFIT, and NUM_CARGO.

Referenced by ReserveConsist().

◆ IsType()

bool Order::IsType ( OrderType  type) const
inline

◆ MakeConditional()

void Order::MakeConditional ( VehicleOrderID  order)

Makes this order an conditional order.

Parameters
orderthe order to jump to.

Definition at line 144 of file order_cmd.cpp.

References type.

Referenced by GetType().

◆ MakeGoToDepot()

void Order::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.

Parameters
destinationthe depot to go to.
orderis this order a 'default' order, or an overridden vehicle order?
non_stop_typehow to get to the depot?
actionwhat to do in the depot?
cargothe cargo type to change to.

Definition at line 91 of file order_cmd.cpp.

References type.

Referenced by GetOrderCmdFromTile(), GetType(), and OrdersWindow::OrderClick_NearestDepot().

◆ MakeGoToStation()

void Order::MakeGoToStation ( StationID  destination)

Makes this order a Go To Station order.

Parameters
destinationthe station to go to.

Definition at line 76 of file order_cmd.cpp.

References type.

Referenced by GetOrderCmdFromTile(), and GetType().

◆ MakeGoToWaypoint()

void Order::MakeGoToWaypoint ( StationID  destination)

Makes this order a Go To Waypoint order.

Parameters
destinationthe waypoint to go to.

Definition at line 105 of file order_cmd.cpp.

References type.

Referenced by GetOrderCmdFromTile(), and GetType().

◆ MakeImplicit()

void Order::MakeImplicit ( StationID  destination)

Makes this order an implicit order.

Parameters
destinationthe station to go to.

Definition at line 155 of file order_cmd.cpp.

References type.

Referenced by GetType().

◆ MakeLoading()

void Order::MakeLoading ( bool  ordered)

Makes this order a Loading order.

Parameters
orderedis this an ordered stop?

Definition at line 116 of file order_cmd.cpp.

References type.

Referenced by GetType().

◆ MapOldOrder()

uint16 Order::MapOldOrder ( ) const

Pack this order into a 16 bits integer as close to the TTD representation as possible.

Returns
the TTD-like packed representation.

Definition at line 209 of file order_cmd.cpp.

References GetType(), and type.

◆ Pack()

uint32 Order::Pack ( ) const

Pack this order into a 32 bits integer, or actually only the type, flags and destination.

Returns
the packed representation.
Note
unpacking is done in the constructor.

Definition at line 199 of file order_cmd.cpp.

References dest, flags, and type.

Referenced by OrdersWindow::OrderClick_NearestDepot().

◆ SetConditionComparator()

void Order::SetConditionComparator ( OrderConditionComparator  condition_comparator)
inline

Set the comparator to use.

Definition at line 164 of file order_base.h.

References SB().

◆ SetConditionSkipToOrder()

void Order::SetConditionSkipToOrder ( VehicleOrderID  order_id)
inline

Get the order to skip to.

Definition at line 166 of file order_base.h.

◆ SetConditionValue()

void Order::SetConditionValue ( uint16  value)
inline

Set the value to base the skip on.

Definition at line 168 of file order_base.h.

References SB().

◆ SetConditionVariable()

void Order::SetConditionVariable ( OrderConditionVariable  condition_variable)
inline

Set variable we have to compare.

Definition at line 162 of file order_base.h.

References SB().

◆ SetDepotActionType()

void Order::SetDepotActionType ( OrderDepotActionFlags  depot_service_type)
inline

Set what we are going to do in the depot.

Definition at line 160 of file order_base.h.

References SB().

Referenced by OrdersWindow::OrderClick_NearestDepot().

◆ SetDepotOrderType()

void Order::SetDepotOrderType ( OrderDepotTypeFlags  depot_order_type)
inline

Set the cause to go to the depot.

Definition at line 158 of file order_base.h.

References SB().

Referenced by GetOrderCmdFromTile().

◆ SetDestination()

void Order::SetDestination ( DestinationID  destination)
inline

Sets the destination of this order.

Parameters
destinationthe new destination of the order.
Precondition
IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).

Definition at line 103 of file order_base.h.

Referenced by ReleaseDisastersTargetingIndustry(), and ReleaseDisastersTargetingVehicle().

◆ SetLoadType()

void Order::SetLoadType ( OrderLoadFlags  load_type)
inline

Set how the consist must be loaded.

Definition at line 150 of file order_base.h.

References SB().

Referenced by GetOrderCmdFromTile().

◆ SetMaxSpeed()

void Order::SetMaxSpeed ( uint16  speed)
inline

Set the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.

Parameters
speedSpeed to be set.

Definition at line 218 of file order_base.h.

References CanLeaveWithCargo(), GetLocation(), and ShouldStopAtStation().

Referenced by ChangeTimetable().

◆ SetNonStopType()

void Order::SetNonStopType ( OrderNonStopFlags  non_stop_type)
inline

Set whether we must stop at stations or not.

Definition at line 154 of file order_base.h.

References SB().

Referenced by ConvertFromOldSavegame(), and GetOrderCmdFromTile().

◆ SetRefit()

void Order::SetRefit ( CargoID  cargo)

Make this depot/station order also a refit order.

Parameters
cargothe cargo type to change to.
Precondition
IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).

Definition at line 166 of file order_cmd.cpp.

References refit_cargo.

Referenced by GetRefitCargo().

◆ SetStopLocation()

void Order::SetStopLocation ( OrderStopLocation  stop_location)
inline

Set where we must stop at the platform.

Definition at line 156 of file order_base.h.

References SB().

Referenced by GetOrderCmdFromTile().

◆ SetTravelTime()

void Order::SetTravelTime ( uint16  time)
inline

Set the time in ticks to take for travelling to the destination.

Parameters
timeTime to set as travel time.

Definition at line 211 of file order_base.h.

Referenced by ChangeTimetable().

◆ SetTravelTimetabled()

void Order::SetTravelTimetabled ( bool  timetabled)
inline

Set if the travel time is explicitly timetabled (unless the order is conditional).

Definition at line 199 of file order_base.h.

References IsType().

Referenced by ChangeTimetable().

◆ SetUnloadType()

void Order::SetUnloadType ( OrderUnloadFlags  unload_type)
inline

Set how the consist must be unloaded.

Definition at line 152 of file order_base.h.

References SB().

◆ SetWaitTime()

void Order::SetWaitTime ( uint16  time)
inline

Set the time in ticks to wait at the destination.

Parameters
timeTime to set as wait time.

Definition at line 205 of file order_base.h.

Referenced by ChangeTimetable().

◆ SetWaitTimetabled()

void Order::SetWaitTimetabled ( bool  timetabled)
inline

Set if the wait time is explicitly timetabled (unless the order is conditional).

Definition at line 197 of file order_base.h.

References IsType().

Referenced by ChangeTimetable().

◆ ShouldStopAtStation()

bool Order::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 settings.

Parameters
vthe vehicle that might be stopping.
stationthe station to stop at.
Returns
true if the vehicle should stop.

Definition at line 2259 of file order_cmd.cpp.

References IsType().

Referenced by SetMaxSpeed().

Friends And Related Function Documentation

◆ GetVehicleDescription

const struct SaveLoad* GetVehicleDescription ( VehicleType  vt)
friend

Saving and loading the current order of vehicles.

The vehicles have a cargo list (and we want that saved).

Parameters
vtthe vehicle type. Can be VEH_END for the common vehicle description data
Returns
the saveload description
Parameters
vtthe vehicle type. Can be VEH_END for the common vehicle description data
Returns
the saveload description

Save and load of vehicles

Save and load of vehicles

Definition at line 574 of file vehicle_sl.cpp.

◆ Load_VEHS

void Load_VEHS ( )
friend

Loading of ancient vehicles.

Definition at line 883 of file vehicle_sl.cpp.


The documentation for this struct was generated from the following files: