Public Member Functions
	Order (uint8_t type, uint8_t flags, DestinationID dest)
bool	IsType (OrderType type) const
	Check whether this order is of the given type.
OrderType	GetType () const
	Get the type of order of this order.
void	Free ()
	'Free' the order
void	MakeGoToStation (StationID destination)
	Makes this order a Go To Station order.
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.
void	MakeGoToWaypoint (StationID destination)
	Makes this order a Go To Waypoint order.
void	MakeLoading (bool ordered)
	Makes this order a Loading order.
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.
void	MakeImplicit (StationID destination)
	Makes this order an implicit order.
bool	IsGotoOrder () const
	Is this a 'goto' order with a real destination?
DestinationID	GetDestination () const
	Gets the destination of this order.
void	SetDestination (DestinationID destination)
	Sets the destination of this order.
bool	IsRefit () const
	Is this order a refit order.
bool	IsAutoRefit () const
	Is this order a auto-refit order.
CargoType	GetRefitCargo () const
	Get the cargo to to refit to.
void	SetRefit (CargoType cargo)
	Make this depot/station order also a refit order.
bool	IsFullLoadOrder () const
	Is this order a OrderLoadType::FullLoad or OrderLoadType::FullLoadAny?
OrderLoadType	GetLoadType () const
	How must the consist be loaded?
OrderUnloadType	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.
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.
uint16_t	GetConditionValue () const
	Get the value to base the skip on.
void	SetLoadType (OrderLoadType load_type)
	Set how the consist must be loaded.
void	SetUnloadType (OrderUnloadType unload_type)
	Set how the consist must be unloaded.
void	SetNonStopType (OrderNonStopFlags non_stop_type)
	Set whether we must stop at stations or not.
void	SetStopLocation (OrderStopLocation stop_location)
	Set where we must stop at the platform.
void	SetDepotOrderType (OrderDepotTypeFlags depot_order_type)
	Set the cause to go to the depot.
void	SetDepotActionType (OrderDepotActionFlags depot_service_type)
	Set what we are going to do in the depot.
void	SetConditionVariable (OrderConditionVariable condition_variable)
	Set variable we have to compare.
void	SetConditionComparator (OrderConditionComparator condition_comparator)
	Set the comparator to use.
void	SetConditionSkipToOrder (VehicleOrderID order_id)
	Get the order to skip to.
void	SetConditionValue (uint16_t value)
	Set the value to base the skip on.
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_t	GetTimetabledWait () const
	Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.
uint16_t	GetTimetabledTravel () const
	Get the time in ticks a vehicle should take to reach the destination or 0 if it's not timetabled.
uint16_t	GetWaitTime () const
	Get the time in ticks a vehicle will probably wait at the destination (timetabled or not).
uint16_t	GetTravelTime () const
	Get the time in ticks a vehicle will probably take to reach the destination (timetabled or not).
uint16_t	GetMaxSpeed () const
	Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
void	SetWaitTimetabled (bool timetabled)
	Set if the wait time is explicitly timetabled (unless the order is conditional).
void	SetTravelTimetabled (bool timetabled)
	Set if the travel time is explicitly timetabled (unless the order is conditional).
void	SetWaitTime (uint16_t time)
	Set the time in ticks to wait at the destination.
void	SetTravelTime (uint16_t time)
	Set the time in ticks to take for travelling to the destination.
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.
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.
bool	CanLoadOrUnload () const
bool	CanLeaveWithCargo (bool has_cargo) const
	A vehicle can leave the current station with cargo if:
TileIndex	GetLocation (const Vehicle *v, bool airport=false) const
	Returns a tile somewhat representing the order destination (not suitable for pathfinding).
bool	IsCompletelyTimetabled () const
	Checks if travel_time and wait_time apply to this order and if they are timetabled.
void	AssignOrder (const Order &other)
	Assign data to an order (from another order) This function makes sure that the index is maintained correctly.
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.
void	ConvertFromOldSavegame ()
	Converts this order from an old savegame's version; it moves all bits to the new location.

Private Attributes
uint8_t	type = 0
	The type of order + non-stop flags.
uint8_t	flags = 0
	Load/unload types, depot order/action types.
DestinationID	dest {}
	The destination of the order.
CargoType	refit_cargo = CARGO_NO_REFIT
	Refit CargoType.
uint16_t	wait_time = 0
	How long in ticks to wait at the destination.
uint16_t	travel_time = 0
	How long in ticks the journey to this destination should take.
uint16_t	max_speed = UINT16_MAX
	How fast the vehicle may go on the way to the destination.

Friends
struct	VEHSChunkHandler
	Loading of ancient vehicles.
class	SlVehicleCommon
class	SlVehicleDisaster
template<typename T>
class	SlOrders
SaveLoadTable	GetOrderDescription ()
	Saving and loading of orders.
template<typename Tcont, typename Titer>
EndianBufferWriter< Tcont, Titer > &	operator<< (EndianBufferWriter< Tcont, Titer > &buffer, const Order &data)
class EndianBufferReader &	operator>> (class EndianBufferReader &buffer, Order &order)

Detailed Description

Definition at line 33 of file order_base.h.

Constructor & Destructor Documentation

◆ Order() [1/2]

Order::Order ( )

inline

Definition at line 58 of file order_base.h.

◆ Order() [2/2]

Order::Order	(	uint8_t	type,
		uint8_t	flags,
		DestinationID	dest )

inline

Definition at line 59 of file order_base.h.

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

other the data to copy (except next pointer).

Definition at line 235 of file order_cmd.cpp.

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

Referenced by Vehicle::LoadOldVehicle.

◆ CanLeaveWithCargo()

bool Order::CanLeaveWithCargo ( bool has_cargo ) const

A vehicle can leave the current station with cargo if:

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.
Parameters

has_cargo Whether the vehicle has cargo.

Returns
true iff the vehicle can leave.

Definition at line 2206 of file order_cmd.cpp.

References GetLoadType(), GetUnloadType(), NoLoad, Transfer, and Unload.

Referenced by LinkRefresher::RefreshLinks().

◆ CanLoadOrUnload()

bool Order::CanLoadOrUnload ( ) const

Definition at line 2190 of file order_cmd.cpp.

◆ ConvertFromOldSavegame()

void Order::ConvertFromOldSavegame ( )

Converts this order from an old savegame's version; it moves all bits to the new location.

Definition at line 26 of file order_sl.cpp.

References _savegame_type, _settings_client, FarEnd, flags, FullLoad, FullLoadAny, GetType(), Halt, IsSavegameVersionBefore(), IsType(), LoadIfPossible, NoDestination, NoIntermediate, NoLoad, PartOfOrders, Service, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), SetDepotActionType(), SetDepotOrderType(), SetLoadType(), SetNonStopType(), SetStopLocation(), SetUnloadType(), SGT_TTD, SGT_TTO, SLV_22, Transfer, Unload, and UnloadIfPossible.

◆ Equals()

bool Order::Equals ( const Order & other ) const

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

Parameters

other the second order to compare to.

Returns: true if the type, flags and destination match.

Definition at line 158 of file order_cmd.cpp.

References dest, flags, GetDepotActionType(), GetDepotOrderType(), IsType(), NearestDepot, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and type.

Referenced by ChangeTimetable(), and ProcessOrders().

◆ Free()

void Order::Free ( )

'Free' the order

Note: ONLY use on "current_order" vehicle orders!

Definition at line 47 of file order_cmd.cpp.

References dest, flags, Free(), and type.

Referenced by AircraftEventHandler_AtTerminal(), AircraftEventHandler_InHangar(), Free(), GetOrderCmdFromTile(), ProcessOrders(), and UpdateOrderDest().

◆ GetConditionComparator()

OrderConditionComparator Order::GetConditionComparator ( ) const

inline

What is the comparator to use?

Returns: The comparator for the comparison.

Definition at line 187 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), CmdModifyOrder(), DrawOrderString(), OrdersWindow::OnClick(), and ProcessConditionalOrder().

◆ GetConditionSkipToOrder()

VehicleOrderID Order::GetConditionSkipToOrder ( ) const

inline

Get the order to skip to.

Returns: The sub-order to skip to.

Definition at line 193 of file order_base.h.

Referenced by CmdInsertOrder(), DrawOrderString(), OrderList::GetNextDecisionNode(), and ProcessConditionalOrder().

◆ GetConditionValue()

uint16_t Order::GetConditionValue ( ) const

inline

Get the value to base the skip on.

Returns: The value to compare the variable against.

Definition at line 199 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), CmdModifyOrder(), DrawOrderString(), OrdersWindow::GetWidgetString(), OrdersWindow::OnClick(), and ProcessConditionalOrder().

◆ GetConditionVariable()

OrderConditionVariable Order::GetConditionVariable ( ) const

inline

What variable do we have to compare?

Returns: The variable of the comparison.

Definition at line 181 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), CmdModifyOrder(), DrawOrderString(), OrderList::GetNextDecisionNode(), OrdersWindow::GetWidgetString(), OrdersWindow::OnClick(), OrdersWindow::OnQueryTextFinished(), and ProcessConditionalOrder().

◆ GetDepotActionType()

OrderDepotActionFlags Order::GetDepotActionType ( ) const

inline

What are we going to do when in the depot.

Returns: What to do in the depot.

Definition at line 175 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), CmdModifyOrder(), CmdOrderRefit(), DrawOrderString(), Equals(), FindNearestHangar(), OrderList::GetNextDecisionNode(), OrdersWindow::GetWidgetString(), Vehicle::HasUnbunchingOrder(), PreviousOrderIsUnbunching(), OrderBackup::RemoveOrder(), RemoveOrderFromAllVehicles(), UpdateOrderDest(), and VehicleEnterDepot().

◆ GetDepotOrderType()

OrderDepotTypeFlags Order::GetDepotOrderType ( ) const

inline

What caused us going to the depot?

Returns: The reason to go to the depot.

Definition at line 169 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), CmdModifyOrder(), CmdOrderRefit(), Equals(), OrdersWindow::GetWidgetString(), MapOldOrder(), OrdersWindow::OrderClick_Service(), ProcessOrders(), ShouldStopAtStation(), VehicleOrderSaver::SwitchToNextOrder(), UpdateAirplanesOnNewStation(), UpdateOrderDest(), and VehicleEnterDepot().

◆ 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 99 of file order_base.h.

Referenced by AircraftController(), AircraftEventHandler(), AircraftEventHandler_AtTerminal(), AircraftEventHandler_InHangar(), AircraftNextAirportPos_and_Order(), Vehicle::BeginLoading(), CheckIfTrainNeedsService(), CheckNextTrainTile(), CheckShipStayInDepot(), CmdInsertOrder(), DrawOrderString(), FindNearestHangar(), GetLocation(), GetTrainStopLocation(), Vehicle::HandleLoading(), Vehicle::LoadOldVehicle, MapOldOrder(), OrderGoesToStation(), CYapfCostRailT< Types >::PfCalcCost(), ProcessOrders(), OrderBackup::RemoveOrder(), RemoveOrderFromAllVehicles(), UpdateAirplanesOnNewStation(), UpdateOrderDest(), UpdateWaypointOrder(), UpdateWaypointOrder(), and VehicleEnterDepot().

◆ GetLoadType()

OrderLoadType Order::GetLoadType ( ) const

inline

How must the consist be loaded?

Returns: The way to load the vehicle.

Definition at line 145 of file order_base.h.

References GB().

Referenced by CalcPercentVehicleFilled(), CanLeaveWithCargo(), CmdInsertOrder(), CmdModifyOrder(), CmdOrderRefit(), DrawOrderString(), IsFullLoadOrder(), LoadUnloadVehicle(), MapOldOrder(), OrdersWindow::OnClick(), OrdersWindow::OrderClick_FullLoad(), and VehicleResolverObject::ResolveReal().

◆ GetLocation()

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

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

Parameters

v	The vehicle to get the location for.
airport	Get the airport tile and not the station location for aircraft.

Returns: destination of order, or INVALID_TILE if none.

Definition at line 562 of file order_cmd.cpp.

References Station::airport, SpecializedStation< Station, false >::Get(), GetDestination(), GetType(), INVALID_TILE, OrthogonalTileArea::tile, BaseVehicle::type, VEH_AIRCRAFT, and BaseStation::xy.

Referenced by OrdersWindow::OnClick(), VehicleViewWindow::OnClick(), and VehicleViewWindow::UpdateButtons().

◆ GetMaxSpeed()

uint16_t 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 306 of file order_base.h.

Referenced by CmdChangeTimetable(), CmdInsertOrder(), TimetableWindow::OnClick(), CYapfCostRailT< Types >::PfCalcCost(), CYapfCostRoadT< Types >::PfCalcCost(), and ShipAccelerate().

◆ GetNonStopType()

OrderNonStopFlags Order::GetNonStopType ( ) const

inline

At which stations must we stop?

Returns: Which stations to stop at.

Definition at line 157 of file order_base.h.

References GB().

Referenced by TimetableWindow::BuildArrivalDepartureList(), CanDetermineTimeTaken(), CmdChangeTimetable(), CmdInsertOrder(), CmdModifyOrder(), DrawOrderString(), IsCompletelyTimetabled(), MapOldOrder(), OrdersWindow::OnClick(), TimetableWindow::OnPaint(), OrdersWindow::OrderClick_Nonstop(), ProcessOrders(), ShouldStopAtStation(), and VehicleTimetableSorter().

◆ GetRefitCargo()

CargoType 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 127 of file order_base.h.

Referenced by CmdInsertOrder(), DrawOrderString(), GetIncompatibleRefitOrderIdForAutoreplace(), LoadUnloadVehicle(), LinkRefresher::RefreshLinks(), ReserveConsist(), and VehicleEnterDepot().

◆ GetStopLocation()

OrderStopLocation Order::GetStopLocation ( ) const

inline

Where must we stop at the platform?

Returns: Where at the platform to stop.

Definition at line 163 of file order_base.h.

References GB().

Referenced by CmdInsertOrder(), DrawOrderString(), GetTrainStopLocation(), and OrdersWindow::OnClick().

◆ GetTimetabledTravel()

uint16_t Order::GetTimetabledTravel ( ) const

inline

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

Returns: The travel time when explicitly timetabled, otherwise 0.

Definition at line 287 of file order_base.h.

References IsTravelTimetabled().

Referenced by ChangeTimetable(), UpdateOrderDest(), and UpdateVehicleTimetable().

◆ GetTimetabledWait()

uint16_t Order::GetTimetabledWait ( ) const

inline

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

Returns: The wait time when explicitly timetabled, otherwise 0.

Definition at line 282 of file order_base.h.

References IsWaitTimetabled().

Referenced by ChangeTimetable(), LoadUnloadVehicle(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().

◆ GetTravelTime()

uint16_t Order::GetTravelTime ( ) const

inline

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

Returns: The raw travel time.

Definition at line 299 of file order_base.h.

Referenced by ChangeTimetable(), CmdChangeTimetable(), CmdInsertOrder(), and TimetableWindow::OnClick().

◆ GetType()

OrderType Order::GetType ( ) const

inline

Get the type of order of this order.

Returns: the order type.

Definition at line 72 of file order_base.h.

References GB().

Referenced by AircraftEventHandler_AtTerminal(), CheckNextTrainTile(), CmdChangeTimetable(), CmdInsertOrder(), CmdModifyOrder(), ConvertFromOldSavegame(), DrawOrderString(), GetLocation(), IsType(), MapOldOrder(), ProcessConditionalOrder(), ProcessOrders(), OrderBackup::RemoveOrder(), RemoveOrderFromAllVehicles(), ReverseTrainDirection(), VehicleOrderSaver::SwitchToNextOrder(), and UpdateOrderDest().

◆ GetUnloadType()

OrderUnloadType Order::GetUnloadType ( ) const

inline

How must the consist be unloaded?

Returns: The way to unload the vehicle.

Definition at line 151 of file order_base.h.

References GB().

Referenced by CanLeaveWithCargo(), CmdInsertOrder(), CmdModifyOrder(), DrawOrderString(), LoadUnloadVehicle(), MapOldOrder(), OrdersWindow::OnClick(), OrdersWindow::OrderClick_Unload(), PrepareUnload(), and VehicleResolverObject::ResolveReal().

◆ GetWaitTime()

uint16_t Order::GetWaitTime ( ) const

inline

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

Returns: The raw wait time.

Definition at line 293 of file order_base.h.

Referenced by ChangeTimetable(), CmdChangeTimetable(), CmdInsertOrder(), DrawOrderString(), TimetableWindow::OnClick(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().

◆ 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 120 of file order_base.h.

References CARGO_AUTO_REFIT.

Referenced by DrawOrderString(), and LinkRefresher::RefreshLinks().

◆ IsCompletelyTimetabled()

bool Order::IsCompletelyTimetabled ( ) const

inline

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

Returns: true iff the travel and wait time are timetabled whenever possible.

Definition at line 349 of file order_base.h.

References GetNonStopType(), IsTravelTimetabled(), IsType(), IsWaitTimetabled(), and NoDestination.

◆ IsFullLoadOrder()

bool Order::IsFullLoadOrder ( ) const

inline

Is this order a OrderLoadType::FullLoad or OrderLoadType::FullLoadAny?

Returns: true iff the order is a full load or full load any order.

Definition at line 135 of file order_base.h.

References FullLoad, FullLoadAny, GetLoadType(), and type.

Referenced by CalcPercentVehicleFilled(), CancelLoadingDueToDeletedOrder(), HandleStationRefit(), Vehicle::HasFullLoadOrder(), LoadUnloadVehicle(), and MapOldOrder().

◆ 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 89 of file order_base.h.

References IsType().

Referenced by DrawOrderString().

◆ 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 113 of file order_base.h.

References CARGO_AUTO_REFIT, and NUM_CARGO.

Referenced by DrawOrderString(), GetIncompatibleRefitOrderIdForAutoreplace(), OrderList::GetNextDecisionNode(), LoadUnloadVehicle(), LinkRefresher::RefreshLinks(), ReserveConsist(), and VehicleEnterDepot().

◆ IsTravelTimetabled()

bool Order::IsTravelTimetabled ( ) const

inline

Does this order have an explicit travel time set?

Returns: true iff the travel time has been set.

Definition at line 276 of file order_base.h.

References HasBit(), and IsType().

Referenced by CanDetermineTimeTaken(), CmdChangeTimetable(), GetTimetabledTravel(), IsCompletelyTimetabled(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().

◆ IsType()

bool Order::IsType ( OrderType type ) const

inline

Check whether this order is of the given type.

Parameters

type	the type to check against.

Returns: true if the order matches.

Definition at line 66 of file order_base.h.

References GetType(), and type.

Referenced by AfterLoadGame(), AircraftEntersTerminal(), AircraftEventHandler(), AircraftEventHandler_AtTerminal(), AircraftEventHandler_EndLanding(), AircraftEventHandler_HeliEndLanding(), AircraftEventHandler_InHangar(), AircraftNextAirportPos_and_Order(), Vehicle::BeginLoading(), TimetableWindow::BuildArrivalDepartureList(), CalcPercentVehicleFilled(), CancelLoadingDueToDeletedOrder(), CanDetermineTimeTaken(), CheckIfTrainNeedsService(), CheckShipStayInDepot(), CheckTrainStayInDepot(), CheckVehicleBreakdown(), CmdBuildSingleSignal(), CmdBulkChangeTimetable(), CmdChangeTimetable(), CmdModifyOrder(), CmdOrderRefit(), CmdRefitVehicle(), CmdReverseTrainDirection(), CmdSkipToOrder(), CmdTurnRoadVeh(), ConvertFromOldSavegame(), DeleteOrder(), DeleteVehicleOrders(), DrawOrderString(), Equals(), FindNearestHangar(), OrderList::GetNextDecisionNode(), GetTrainStopLocation(), OrdersWindow::GetWidgetString(), Vehicle::HandleLoading(), Vehicle::HasConditionalOrder(), Vehicle::HasDepotOrder(), Vehicle::HasFullLoadOrder(), Vehicle::HasUnbunchingOrder(), IsCompletelyTimetabled(), IsGotoOrder(), IsTravelTimetabled(), IsWaitTimetabled(), LoadUnloadVehicle(), MapAircraftMovementAction(), OrdersWindow::OnClick(), TimetableWindow::OnPaint(), OrdersWindow::OnPlaceObject(), OrderGoesToStation(), CYapfCostRailT< Types >::PfCalcCost(), PreviousOrderIsUnbunching(), ProcessOrders(), LinkRefresher::RefreshLinks(), RemoveOrderFromAllVehicles(), RemoveRoadStop(), VehicleResolverObject::ResolveReal(), SetTravelTimetabled(), SetWaitTimetabled(), ShouldStopAtStation(), UnpackOldOrder(), UpdateAirplanesOnNewStation(), UpdateOldAircraft(), UpdateOrderDest(), UpdateVehicleTimetable(), UpdateWaypointOrder(), UpdateWaypointOrder(), VehicleEnterDepot(), and VehicleTimetableSorter().

◆ IsWaitTimetabled()

bool Order::IsWaitTimetabled ( ) const

inline

Does this order have an explicit wait time set?

Returns: true iff the wait time has been set.

Definition at line 270 of file order_base.h.

References HasBit(), and IsType().

Referenced by CanDetermineTimeTaken(), CmdChangeTimetable(), DrawOrderString(), GetTimetabledWait(), IsCompletelyTimetabled(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().

◆ MakeConditional()

void Order::MakeConditional ( VehicleOrderID order )

Makes this order an conditional order.

Parameters

order the order to jump to.

Definition at line 126 of file order_cmd.cpp.

References dest, flags, and type.

Referenced by OrdersWindow::OnClick().

◆ MakeDummy()

void Order::MakeDummy ( )

Makes this order a Dummy order.

Definition at line 116 of file order_cmd.cpp.

References flags, and type.

Referenced by CheckIfTrainNeedsService(), RemoveOrderFromAllVehicles(), UnpackOldOrder(), UpdateAirplanesOnNewStation(), and VehicleEnterDepot().

◆ MakeGoToDepot()

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

Parameters

destination	the depot to go to.
order	is this order a 'default' order, or an overridden vehicle order?
non_stop_type	how to get to the depot?
action	what to do in the depot?
cargo	the cargo type to change to.

Definition at line 73 of file order_cmd.cpp.

References dest, SetDepotActionType(), SetDepotOrderType(), SetNonStopType(), SetRefit(), and type.

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

◆ MakeGoToStation()

void Order::MakeGoToStation ( StationID destination )

Makes this order a Go To Station order.

Parameters

destination the station to go to.

Definition at line 58 of file order_cmd.cpp.

References dest, flags, and type.

Referenced by GetOrderCmdFromTile().

◆ MakeGoToWaypoint()

void Order::MakeGoToWaypoint ( StationID destination )

Makes this order a Go To Waypoint order.

Parameters

destination the waypoint to go to.

Definition at line 87 of file order_cmd.cpp.

References dest, flags, and type.

Referenced by GetOrderCmdFromTile(), and UpdateWaypointOrder().

◆ MakeImplicit()

void Order::MakeImplicit ( StationID destination )

Makes this order an implicit order.

Parameters

destination the station to go to.

Definition at line 137 of file order_cmd.cpp.

References dest, and type.

Referenced by Vehicle::BeginLoading().

◆ MakeLeaveStation()

void Order::MakeLeaveStation ( )

Makes this order a Leave Station order.

Definition at line 107 of file order_cmd.cpp.

References flags, and type.

◆ MakeLoading()

void Order::MakeLoading ( bool ordered )

Makes this order a Loading order.

Parameters

ordered is this an ordered stop?

Definition at line 98 of file order_cmd.cpp.

References flags, and type.

◆ MapOldOrder()

uint16_t 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 180 of file order_cmd.cpp.

References GB(), GetDepotOrderType(), GetDestination(), GetLoadType(), GetNonStopType(), GetType(), GetUnloadType(), IsFullLoadOrder(), NoIntermediate, NoLoad, NoUnload, PartOfOrders, SetBit(), and Unload.

◆ SetConditionComparator()

void Order::SetConditionComparator ( OrderConditionComparator condition_comparator )

inline

Set the comparator to use.

Parameters

condition_comparator The new comparator to compare with.

Definition at line 247 of file order_base.h.

References SB(), and to_underlying().

Referenced by CmdModifyOrder().

void Order::SetDestination ( DestinationID destination )

inline

Sets the destination of this order.

Parameters

destination the new destination of the order.

Precondition: IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).

Definition at line 106 of file order_base.h.

Referenced by UpdateOrderDest(), and UpdateWaypointOrder().

◆ SetLoadType()

void Order::SetLoadType ( OrderLoadType load_type )

inline

Set how the consist must be loaded.

Parameters

load_type The new load type, i.e. whether to load.

Definition at line 205 of file order_base.h.

References SB(), and to_underlying().

Referenced by CancelLoadingDueToDeletedOrder(), CmdModifyOrder(), ConvertFromOldSavegame(), and GetOrderCmdFromTile().

◆ SetMaxSpeed()

void Order::SetMaxSpeed ( uint16_t speed )

inline

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

Parameters

speed Speed to be set.

Definition at line 337 of file order_base.h.

Referenced by ChangeTimetable().

◆ SetNonStopType()

void Order::SetNonStopType ( OrderNonStopFlags non_stop_type )

inline

Set whether we must stop at stations or not.

Parameters

non_stop_type The new non stop type, i.e. where to stop.

Definition at line 217 of file order_base.h.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), and SB().

Referenced by CancelLoadingDueToDeletedOrder(), CmdModifyOrder(), ConvertFromOldSavegame(), GetOrderCmdFromTile(), and MakeGoToDepot().

◆ SetRefit()

void Order::SetRefit ( CargoType cargo )

Make this depot/station order also a refit order.

Parameters

cargo the cargo type to change to.

Precondition: IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION).

Definition at line 148 of file order_cmd.cpp.

References refit_cargo.

Referenced by CmdModifyOrder(), CmdOrderRefit(), and MakeGoToDepot().

◆ SetStopLocation()

void Order::SetStopLocation ( OrderStopLocation stop_location )

inline

Set where we must stop at the platform.

Parameters

stop_location The location to stop at.

Definition at line 223 of file order_base.h.

References SB(), and to_underlying().

Referenced by CmdModifyOrder(), ConvertFromOldSavegame(), and GetOrderCmdFromTile().

◆ SetTravelTime()

void Order::SetTravelTime ( uint16_t time )

inline

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

Parameters

time	Time to set as travel time.

Definition at line 330 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).

Parameters

timetabled Whether the conditional order's travel time is explicitly timetabled.

Definition at line 318 of file order_base.h.

References AssignBit(), and IsType().

Referenced by ChangeTimetable(), and RemoveOrderFromAllVehicles().

◆ SetUnloadType()

void Order::SetUnloadType ( OrderUnloadType unload_type )

inline

Set how the consist must be unloaded.

Parameters

unload_type The new unload type, i.e. whether to unload.

Definition at line 211 of file order_base.h.

References SB(), and to_underlying().

Referenced by CmdModifyOrder(), and ConvertFromOldSavegame().

◆ SetWaitTime()

void Order::SetWaitTime ( uint16_t time )

inline

Set the time in ticks to wait at the destination.

Parameters

time	Time to set as wait time.

Definition at line 324 of file order_base.h.

Referenced by ChangeTimetable(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().

◆ SetWaitTimetabled()

void Order::SetWaitTimetabled ( bool timetabled )

inline

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

Parameters

timetabled Whether the conditional order's wait time is explicitly timetabled.

Definition at line 312 of file order_base.h.

References AssignBit(), and IsType().

Referenced by ChangeTimetable(), and RemoveOrderFromAllVehicles().

◆ 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

v	the vehicle that might be stopping.
station	the station to stop at.

Returns: true if the vehicle should stop.

Definition at line 2180 of file order_cmd.cpp.

References dest, GetDepotOrderType(), GetNonStopType(), IsType(), Vehicle::last_station_visited, NoDestination, NoIntermediate, PartOfOrders, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CheckNextTrainTile(), and Vehicle::ShowVisualEffect().

◆ GetOrderDescription

SaveLoadTable GetOrderDescription ( )

friend

Saving and loading of orders.

Definition at line 144 of file order_sl.cpp.

References GetOrderDescription, SL_MAX_VERSION, SL_MIN_VERSION, SLE_CONDVARNAME, SLE_VARNAME, SLV_172, SLV_36, SLV_67, and SLV_69.

Referenced by GetOrderDescription.

◆ operator<<

template<typename Tcont, typename Titer>

EndianBufferWriter< Tcont, Titer > & operator<<	(	EndianBufferWriter< Tcont, Titer > &	buffer,
		const Order &	data )

friend

Definition at line 24 of file order_cmd.h.

◆ operator>>

class EndianBufferReader & operator>>	(	class EndianBufferReader &	buffer,
		Order &	order )

friend

Definition at line 41 of file order_cmd.h.

◆ SlOrders

template<typename T>

friend class SlOrders

friend

Definition at line 41 of file order_base.h.

◆ SlVehicleCommon

friend class SlVehicleCommon

friend

Definition at line 38 of file order_base.h.

◆ SlVehicleDisaster

friend class SlVehicleDisaster

friend

Definition at line 39 of file order_base.h.

◆ VEHSChunkHandler

friend struct VEHSChunkHandler

friend

uint8_t Order::type = 0

private

The type of order + non-stop flags.

Definition at line 47 of file order_base.h.

Referenced by AssignOrder(), Equals(), Free(), IsFullLoadOrder(), IsType(), VEHSChunkHandler::Load(), MakeConditional(), MakeDummy(), MakeGoToDepot(), MakeGoToStation(), MakeGoToWaypoint(), MakeImplicit(), MakeLeaveStation(), and MakeLoading().

◆ wait_time

uint16_t Order::wait_time = 0

private

How long in ticks to wait at the destination.

Definition at line 53 of file order_base.h.

Referenced by AssignOrder().

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

src/order_base.h
src/order_cmd.cpp
src/saveload/order_sl.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Order() [1/2]

◆ Order() [2/2]

Member Function Documentation

◆ AssignOrder()

◆ CanLeaveWithCargo()

◆ CanLoadOrUnload()

◆ ConvertFromOldSavegame()

◆ Equals()

◆ Free()

◆ GetConditionComparator()

◆ GetConditionSkipToOrder()

◆ GetConditionValue()

◆ GetConditionVariable()

◆ GetDepotActionType()

◆ GetDepotOrderType()

◆ GetDestination()

◆ GetLoadType()

◆ GetLocation()

◆ GetMaxSpeed()

◆ GetNonStopType()

◆ GetRefitCargo()

◆ GetStopLocation()

◆ GetTimetabledTravel()

◆ GetTimetabledWait()

◆ GetTravelTime()

◆ GetType()

◆ GetUnloadType()

◆ GetWaitTime()

◆ IsAutoRefit()

◆ IsCompletelyTimetabled()

◆ IsFullLoadOrder()

◆ IsGotoOrder()

◆ IsRefit()

◆ IsTravelTimetabled()

◆ IsType()

◆ IsWaitTimetabled()

◆ MakeConditional()

◆ MakeDummy()

◆ MakeGoToDepot()

◆ MakeGoToStation()

◆ MakeGoToWaypoint()

◆ MakeImplicit()

◆ MakeLeaveStation()

◆ MakeLoading()

◆ MapOldOrder()

◆ SetConditionComparator()

◆ SetConditionSkipToOrder()

◆ SetConditionValue()

◆ SetConditionVariable()

◆ SetDepotActionType()

◆ SetDepotOrderType()

◆ SetDestination()

◆ SetLoadType()

◆ SetMaxSpeed()

◆ SetNonStopType()

◆ SetRefit()

◆ SetStopLocation()

◆ SetTravelTime()

◆ SetTravelTimetabled()

◆ SetUnloadType()

◆ SetWaitTime()

◆ SetWaitTimetabled()

◆ ShouldStopAtStation()

Friends And Related Symbol Documentation

◆ GetOrderDescription

◆ operator<<

◆ operator>>

◆ SlOrders

◆ SlVehicleCommon

◆ SlVehicleDisaster

◆ VEHSChunkHandler

Field Documentation

◆ dest

◆ flags

◆ max_speed