Public Types | Static Public Member Functions

ScriptOrder Class Reference

Class that handles all order related functions. More...

#include <script_order.hpp>

Inheritance diagram for ScriptOrder:
ScriptObject SimpleCountedObject

Public Types

enum  ErrorMessages { ERR_ORDER_BASE = ScriptError::ERR_CAT_ORDER << ScriptError::ERR_CAT_BIT_SIZE, ERR_ORDER_TOO_MANY, ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION }
 

All order related error messages.

More...
enum  ScriptOrderFlags {
  AIOF_NONE = 0, AIOF_NON_STOP_INTERMEDIATE = 1 << 0, AIOF_NON_STOP_DESTINATION = 1 << 1, AIOF_UNLOAD = 1 << 2,
  AIOF_TRANSFER = 1 << 3, AIOF_NO_UNLOAD = 1 << 4, AIOF_FULL_LOAD = 2 << 5, AIOF_FULL_LOAD_ANY = 3 << 5,
  AIOF_NO_LOAD = 1 << 7, AIOF_SERVICE_IF_NEEDED = 1 << 2, AIOF_STOP_IN_DEPOT = 1 << 3, AIOF_GOTO_NEAREST_DEPOT = 1 << 8,
  AIOF_NON_STOP_FLAGS = AIOF_NON_STOP_INTERMEDIATE | AIOF_NON_STOP_DESTINATION, AIOF_UNLOAD_FLAGS = AIOF_TRANSFER | AIOF_UNLOAD | AIOF_NO_UNLOAD, AIOF_LOAD_FLAGS = AIOF_FULL_LOAD | AIOF_FULL_LOAD_ANY | AIOF_NO_LOAD, AIOF_DEPOT_FLAGS = AIOF_SERVICE_IF_NEEDED | AIOF_STOP_IN_DEPOT | AIOF_GOTO_NEAREST_DEPOT,
  AIOF_INVALID = 0xFFFF
}
 

Flags that can be used to modify the behaviour of orders.

More...
enum  OrderCondition {
  OC_LOAD_PERCENTAGE, OC_RELIABILITY, OC_MAX_SPEED, OC_AGE,
  OC_REQUIRES_SERVICE, OC_UNCONDITIONALLY, OC_REMAINING_LIFETIME, OC_INVALID = -1
}
 

All conditions a conditional order can depend on.

More...
enum  CompareFunction {
  CF_EQUALS, CF_NOT_EQUALS, CF_LESS_THAN, CF_LESS_EQUALS,
  CF_MORE_THAN, CF_MORE_EQUALS, CF_IS_TRUE, CF_IS_FALSE,
  CF_INVALID = -1
}
 

Comparators for conditional orders.

More...
enum  OrderPosition { ORDER_CURRENT = 0xFF, ORDER_INVALID = -1 }
 

Index in the list of orders for a vehicle.

More...
enum  StopLocation { STOPLOCATION_NEAR, STOPLOCATION_MIDDLE, STOPLOCATION_FAR, STOPLOCATION_INVALID = -1 }
 

Where to stop trains in a station that's longer than the train.

More...

Static Public Member Functions

static bool IsValidVehicleOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order id is valid for the given vehicle.
static bool IsGotoStationOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order is a goto-station order.
static bool IsGotoDepotOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order is a goto-depot order.
static bool IsGotoWaypointOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order is a goto-waypoint order.
static bool IsConditionalOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order is a conditional order.
static bool IsVoidOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order is a void order.
static bool IsRefitOrder (VehicleID vehicle_id, OrderPosition order_position)
 Checks whether the given order has a valid refit cargo.
static bool IsCurrentOrderPartOfOrderList (VehicleID vehicle_id)
 Checks whether the current order is part of the orderlist.
static OrderPosition ResolveOrderPosition (VehicleID vehicle_id, OrderPosition order_position)
 Resolves the given order index to the correct index for the given vehicle.
static bool AreOrderFlagsValid (TileIndex destination, ScriptOrderFlags order_flags)
 Checks whether the given order flags are valid for the given destination.
static bool IsValidConditionalOrder (OrderCondition condition, CompareFunction compare)
 Checks whether the given combination of condition and compare function is valid.
static int32 GetOrderCount (VehicleID vehicle_id)
 Returns the number of orders for the given vehicle.
static TileIndex GetOrderDestination (VehicleID vehicle_id, OrderPosition order_position)
 Gets the destination of the given order for the given vehicle.
static ScriptOrderFlags GetOrderFlags (VehicleID vehicle_id, OrderPosition order_position)
 Gets the ScriptOrderFlags of the given order for the given vehicle.
static OrderPosition GetOrderJumpTo (VehicleID vehicle_id, OrderPosition order_position)
 Gets the OrderPosition to jump to if the check succeeds of the given order for the given vehicle.
static OrderCondition GetOrderCondition (VehicleID vehicle_id, OrderPosition order_position)
 Gets the OrderCondition of the given order for the given vehicle.
static CompareFunction GetOrderCompareFunction (VehicleID vehicle_id, OrderPosition order_position)
 Gets the CompareFunction of the given order for the given vehicle.
static int32 GetOrderCompareValue (VehicleID vehicle_id, OrderPosition order_position)
 Gets the value to compare against of the given order for the given vehicle.
static StopLocation GetStopLocation (VehicleID vehicle_id, OrderPosition order_position)
 Gets the stoplocation of the given order for the given train.
static CargoID GetOrderRefit (VehicleID vehicle_id, OrderPosition order_position)
 Gets the refit cargo type of the given order for the given vehicle.
static bool SetOrderJumpTo (VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
 Sets the OrderPosition to jump to if the check succeeds of the given order for the given vehicle.
static bool SetOrderCondition (VehicleID vehicle_id, OrderPosition order_position, OrderCondition condition)
 Sets the OrderCondition of the given order for the given vehicle.
static bool SetOrderCompareFunction (VehicleID vehicle_id, OrderPosition order_position, CompareFunction compare)
 Sets the CompareFunction of the given order for the given vehicle.
static bool SetOrderCompareValue (VehicleID vehicle_id, OrderPosition order_position, int32 value)
 Sets the value to compare against of the given order for the given vehicle.
static bool SetStopLocation (VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location)
 Sets the stoplocation of the given order for the given train.
static bool SetOrderRefit (VehicleID vehicle_id, OrderPosition order_position, CargoID refit_cargo)
 Sets the refit cargo type of the given order for the given vehicle.
static bool AppendOrder (VehicleID vehicle_id, TileIndex destination, ScriptOrderFlags order_flags)
 Appends an order to the end of the vehicle's order list.
static bool AppendConditionalOrder (VehicleID vehicle_id, OrderPosition jump_to)
 Appends a conditional order to the end of the vehicle's order list.
static bool InsertOrder (VehicleID vehicle_id, OrderPosition order_position, TileIndex destination, ScriptOrderFlags order_flags)
 Inserts an order before the given order_position into the vehicle's order list.
static bool InsertConditionalOrder (VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
 Appends a conditional order before the given order_position into the vehicle's order list.
static bool RemoveOrder (VehicleID vehicle_id, OrderPosition order_position)
 Removes an order from the vehicle's order list.
static bool _SetOrderFlags ()
 Internal function to help SetOrderFlags.
static bool SetOrderFlags (VehicleID vehicle_id, OrderPosition order_position, ScriptOrderFlags order_flags)
 Changes the order flags of the given order.
static bool MoveOrder (VehicleID vehicle_id, OrderPosition order_position_move, OrderPosition order_position_target)
 Move an order inside the orderlist.
static bool SkipToOrder (VehicleID vehicle_id, OrderPosition next_order)
 Make a vehicle execute next_order instead of its current order.
static bool CopyOrders (VehicleID vehicle_id, VehicleID main_vehicle_id)
 Copies the orders from another vehicle.
static bool ShareOrders (VehicleID vehicle_id, VehicleID main_vehicle_id)
 Shares the orders between two vehicles.
static bool UnshareOrders (VehicleID vehicle_id)
 Removes the given vehicle from a shared orders list.

Detailed Description

Class that handles all order related functions.

ai

Definition at line 21 of file script_order.hpp.


Member Enumeration Documentation

Comparators for conditional orders.

Enumerator:
CF_EQUALS 

Skip if both values are equal.

CF_NOT_EQUALS 

Skip if both values are not equal.

CF_LESS_THAN 

Skip if the value is less than the limit.

CF_LESS_EQUALS 

Skip if the value is less or equal to the limit.

CF_MORE_THAN 

Skip if the value is more than the limit.

CF_MORE_EQUALS 

Skip if the value is more or equal to the limit.

CF_IS_TRUE 

Skip if the variable is true.

CF_IS_FALSE 

Skip if the variable is false.

CF_INVALID 

Invalid compare function, do not use.

Definition at line 101 of file script_order.hpp.

All order related error messages.

Enumerator:
ERR_ORDER_BASE 

Base for all order related errors.

ERR_ORDER_TOO_MANY 

No more space for orders.

ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION 

Destination of new order is to far away from the previous order.

Definition at line 26 of file script_order.hpp.

All conditions a conditional order can depend on.

Enumerator:
OC_LOAD_PERCENTAGE 

Skip based on the amount of load, value is in tons.

OC_RELIABILITY 

Skip based on the reliability, value is percent (0..100).

OC_MAX_SPEED 

Skip based on the maximum speed, value is in OpenTTD's internal speed unit, see ScriptEngine::GetMaxSpeed.

OC_AGE 

Skip based on the age, value is in years.

OC_REQUIRES_SERVICE 

Skip when the vehicle requires service, no value.

OC_UNCONDITIONALLY 

Always skip, no compare function, no value.

OC_REMAINING_LIFETIME 

Skip based on the remaining lifetime.

OC_INVALID 

An invalid condition, do not use.

Definition at line 86 of file script_order.hpp.

Index in the list of orders for a vehicle.

The first order has index 0, the second order index 1, etc. The current order can be queried by using ORDER_CURRENT. Do not use ORDER_INVALID yourself, it's used as return value by for example ResolveOrderPosition.

Note:
Automatic orders are hidden from AIs, so OrderPosition 0 will always be the first manual order.
Enumerator:
ORDER_CURRENT 

Constant that gets resolved to the current order.

ORDER_INVALID 

An invalid order.

Definition at line 121 of file script_order.hpp.

Flags that can be used to modify the behaviour of orders.

Enumerator:
AIOF_NONE 

Just go to the station/depot, stop unload if possible and load if needed.

AIOF_NON_STOP_INTERMEDIATE 

Do not stop at the stations that are passed when going to the destination.

Only for trains and road vehicles.

AIOF_NON_STOP_DESTINATION 

Do not stop at the destionation station.

Only for trains and road vehicles.

AIOF_UNLOAD 

Always unload the vehicle; only for stations.

Cannot be set when AIOF_TRANSFER or AIOF_NO_UNLOAD is set.

AIOF_TRANSFER 

Transfer instead of deliver the goods; only for stations.

Cannot be set when AIOF_UNLOAD or AIOF_NO_UNLOAD is set.

AIOF_NO_UNLOAD 

Never unload the vehicle; only for stations.

Cannot be set when AIOF_UNLOAD, AIOF_TRANSFER or AIOF_NO_LOAD is set.

AIOF_FULL_LOAD 

Wait till the vehicle is fully loaded; only for stations.

Cannot be set when AIOF_NO_LOAD is set.

AIOF_FULL_LOAD_ANY 

Wait till at least one cargo of the vehicle is fully loaded; only for stations.

Cannot be set when AIOF_NO_LOAD is set.

AIOF_NO_LOAD 

Do not load any cargo; only for stations.

Cannot be set when AIOF_NO_UNLOAD, AIOF_FULL_LOAD or AIOF_FULL_LOAD_ANY is set.

AIOF_SERVICE_IF_NEEDED 

Service the vehicle when needed, otherwise skip this order; only for depots.

AIOF_STOP_IN_DEPOT 

Stop in the depot instead of only go there for servicing; only for depots.

AIOF_GOTO_NEAREST_DEPOT 

Go to nearest depot.

AIOF_NON_STOP_FLAGS 

All flags related to non-stop settings.

AIOF_UNLOAD_FLAGS 

All flags related to unloading.

AIOF_LOAD_FLAGS 

All flags related to loading.

AIOF_DEPOT_FLAGS 

All flags related to depots.

AIOF_INVALID 

For marking invalid order flags.

Definition at line 40 of file script_order.hpp.

Where to stop trains in a station that's longer than the train.

Enumerator:
STOPLOCATION_NEAR 

Stop the train as soon as it's completely in the station.

STOPLOCATION_MIDDLE 

Stop the train in the middle of the station.

STOPLOCATION_FAR 

Stop the train at the far end of the station.

STOPLOCATION_INVALID 

An invalid stop location.

Definition at line 127 of file script_order.hpp.


Member Function Documentation

bool ScriptOrder::AppendConditionalOrder ( VehicleID  vehicle_id,
OrderPosition  jump_to 
) [static]

Appends a conditional order to the end of the vehicle's order list.

Parameters:
vehicle_id The vehicle to append the order to.
jump_to The OrderPosition to jump to if the condition is true.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
IsValidVehicleOrder(vehicle_id, jump_to).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
ScriptOrder::ERR_ORDER_TOO_MANY 
Returns:
True if and only if the order was appended.

Definition at line 443 of file script_order.cpp.

References EnforcePrecondition, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), InsertConditionalOrder(), ScriptVehicle::IsValidVehicle(), and IsValidVehicleOrder().

bool ScriptOrder::AppendOrder ( VehicleID  vehicle_id,
TileIndex  destination,
ScriptOrderFlags  order_flags 
) [static]

Appends an order to the end of the vehicle's order list.

Parameters:
vehicle_id The vehicle to append the order to.
destination The destination of the order.
order_flags The flags given to the order.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
AreOrderFlagsValid(destination, order_flags).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
ScriptOrder::ERR_ORDER_TOO_MANY 
ScriptOrder::ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION 
Returns:
True if and only if the order was appended.

Definition at line 435 of file script_order.cpp.

References AreOrderFlagsValid(), EnforcePrecondition, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), InsertOrder(), and ScriptVehicle::IsValidVehicle().

bool ScriptOrder::AreOrderFlagsValid ( TileIndex  destination,
ScriptOrderFlags  order_flags 
) [static]

Checks whether the given order flags are valid for the given destination.

Parameters:
destination The destination of the order.
order_flags The flags given to the order.
Returns:
True if and only if the order_flags are valid for the given location.

Definition at line 183 of file script_order.cpp.

References AIOF_DEPOT_FLAGS, AIOF_LOAD_FLAGS, AIOF_NO_LOAD, AIOF_NO_UNLOAD, AIOF_NON_STOP_FLAGS, AIOF_SERVICE_IF_NEEDED, AIOF_TRANSFER, AIOF_UNLOAD, AIOF_UNLOAD_FLAGS, and GetOrderTypeByTile().

Referenced by _SetOrderFlags(), AppendOrder(), and InsertOrder().

bool ScriptOrder::CopyOrders ( VehicleID  vehicle_id,
VehicleID  main_vehicle_id 
) [static]

Copies the orders from another vehicle.

The orders of the main vehicle are going to be the orders of the changed vehicle.

Parameters:
vehicle_id The vehicle to copy the orders to.
main_vehicle_id The vehicle to copy the orders from.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
ScriptVehicle::IsValidVehicle(main_vehicle_id).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
ScriptOrder::ERR_ORDER_TOO_MANY 
Returns:
True if and only if the copying succeeded.

Definition at line 636 of file script_order.cpp.

References CMD_CLONE_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, and ScriptVehicle::IsValidVehicle().

ScriptOrder::CompareFunction ScriptOrder::GetOrderCompareFunction ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the CompareFunction of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the compare function for.
order_position The order to get the compare function for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
Returns:
The CompareFunction of the order.

Definition at line 330 of file script_order.cpp.

References Order::GetConditionComparator(), IsConditionalOrder(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

int32 ScriptOrder::GetOrderCompareValue ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the value to compare against of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the value for.
order_position The order to get the value for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
Returns:
The value to compare against of the order.

Definition at line 339 of file script_order.cpp.

References Order::GetConditionValue(), Order::GetConditionVariable(), IsConditionalOrder(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

ScriptOrder::OrderCondition ScriptOrder::GetOrderCondition ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the OrderCondition of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the condition type for.
order_position The order to get the condition type for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
Returns:
The OrderCondition of the order.

Definition at line 321 of file script_order.cpp.

References Order::GetConditionVariable(), IsConditionalOrder(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

Referenced by SetOrderCompareValue().

int32 ScriptOrder::GetOrderCount ( VehicleID  vehicle_id  )  [static]

Returns the number of orders for the given vehicle.

Parameters:
vehicle_id The vehicle to get the order count of.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
Returns:
The number of orders for the given vehicle or a negative value when the vehicle does not exist.

Definition at line 226 of file script_order.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), and ScriptVehicle::IsValidVehicle().

Referenced by IsCurrentOrderPartOfOrderList().

TileIndex ScriptOrder::GetOrderDestination ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the destination of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the destination for.
order_position The order to get the destination for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position).
Note:
Giving ORDER_CURRENT as order_position will give the order that is currently being executed by the vehicle. This is not necessarily the current order as given by ResolveOrderPosition (the current index in the order list) as manual or autoservicing depot orders do not show up in the orderlist, but they can be the current order of a vehicle.
Returns:
The destination tile of the order.

Definition at line 231 of file script_order.cpp.

References Station::airport, Station::bus_stops, Station::dock_tile, SpecializedStation< Waypoint, true >::Get(), SpecializedStation< Station, false >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Order::GetDepotActionType(), Order::GetDestination(), Order::GetType(), INVALID_TILE, IsHangar(), IsValidVehicleOrder(), ResolveOrder(), TileArea::tile, TILE_AREA_LOOP, Waypoint::TileBelongsToRailStation(), Station::TileBelongsToRailStation(), BaseStation::train_station, Station::truck_stops, BaseVehicle::type, VEH_AIRCRAFT, BaseStation::xy, and RoadStop::xy.

Referenced by _SetOrderFlags().

ScriptOrder::ScriptOrderFlags ScriptOrder::GetOrderFlags ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the ScriptOrderFlags of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the destination for.
order_position The order to get the destination for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position == ORDER_CURRENT || (!IsConditionalOrder(vehicle_id, order_position) && !IsVoidOrder(vehicle_id, order_position)).
Note:
Giving ORDER_CURRENT as order_position will give the order that is currently being executed by the vehicle. This is not necessarily the current order as given by ResolveOrderPosition (the current index in the order list) as manual or autoservicing depot orders do not show up in the orderlist, but they can be the current order of a vehicle.
Returns:
The ScriptOrderFlags of the order.

Definition at line 285 of file script_order.cpp.

References AIOF_GOTO_NEAREST_DEPOT, AIOF_INVALID, AIOF_SERVICE_IF_NEEDED, AIOF_STOP_IN_DEPOT, Order::GetDepotActionType(), Order::GetDepotOrderType(), Order::GetLoadType(), Order::GetNonStopType(), Order::GetType(), Order::GetUnloadType(), IsValidVehicleOrder(), and ResolveOrder().

Referenced by _SetOrderFlags().

ScriptOrder::OrderPosition ScriptOrder::GetOrderJumpTo ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the OrderPosition to jump to if the check succeeds of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the OrderPosition for.
order_position The order to get the OrderPosition for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
Returns:
The target of the conditional jump.

Definition at line 312 of file script_order.cpp.

References Order::GetConditionSkipToOrder(), IsConditionalOrder(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

CargoID ScriptOrder::GetOrderRefit ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the refit cargo type of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to get the refit cargo for.
order_position The order to get the refit cargo for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position == ORDER_CURRENT || IsGotoStationOrder(vehicle_id, order_position) || IsGotoDepotOrder(vehicle_id, order_position).
Note:
Giving ORDER_CURRENT as order_position will give the order that is currently being executed by the vehicle. This is not necessarily the current order as given by ResolveOrderPosition (the current index in the order list) as manual or autoservicing depot orders do not show up in the orderlist, but they can be the current order of a vehicle.
Returns:
The refit cargo of the order or CT_NO_REFIT if no refit is set.

Definition at line 360 of file script_order.cpp.

References CT_NO_REFIT, Order::GetRefitCargo(), IsGotoDepotOrder(), IsGotoStationOrder(), Order::IsRefit(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

ScriptOrder::StopLocation ScriptOrder::GetStopLocation ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Gets the stoplocation of the given order for the given train.

Parameters:
vehicle_id The vehicle to get the value for.
order_position The order to get the value for.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
ScriptVehicle::GetVehicleType(vehicle_id) == ScriptVehicle::VT_RAIL.
IsGotoStationOrder(vehicle_id, order_position).
Returns:
The relative position where the train will stop inside a station.

Definition at line 350 of file script_order.cpp.

References Order::GetStopLocation(), ScriptVehicle::GetVehicleType(), IsGotoStationOrder(), IsValidVehicleOrder(), ResolveOrder(), and ScriptVehicle::VT_RAIL.

bool ScriptOrder::InsertConditionalOrder ( VehicleID  vehicle_id,
OrderPosition  order_position,
OrderPosition  jump_to 
) [static]

Appends a conditional order before the given order_position into the vehicle's order list.

Parameters:
vehicle_id The vehicle to add the order to.
order_position The order to place the new order before.
jump_to The OrderPosition to jump to if the condition is true.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
IsValidVehicleOrder(vehicle_id, jump_to).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
ScriptOrder::ERR_ORDER_TOO_MANY 
Returns:
True if and only if the order was inserted.

Definition at line 505 of file script_order.cpp.

References ScriptObject::DoCommand(), EnforcePrecondition, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), ScriptVehicle::IsValidVehicle(), IsValidVehicleOrder(), Order::MakeConditional(), ORDER_CURRENT, Order::Pack(), ResolveOrderPosition(), and ScriptOrderPositionToRealOrderPosition().

Referenced by AppendConditionalOrder().

bool ScriptOrder::InsertOrder ( VehicleID  vehicle_id,
OrderPosition  order_position,
TileIndex  destination,
ScriptOrder::ScriptOrderFlags  order_flags 
) [static]

Inserts an order before the given order_position into the vehicle's order list.

Parameters:
vehicle_id The vehicle to add the order to.
order_position The order to place the new order before.
destination The destination of the order.
order_flags The flags given to the order.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
AreOrderFlagsValid(destination, order_flags).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
ScriptOrder::ERR_ORDER_TOO_MANY 
ScriptOrder::ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION 
Returns:
True if and only if the order was inserted.

Definition at line 451 of file script_order.cpp.

References AIOF_GOTO_NEAREST_DEPOT, AIOF_NON_STOP_INTERMEDIATE, AIOF_SERVICE_IF_NEEDED, AIOF_STOP_IN_DEPOT, AreOrderFlagsValid(), ScriptObject::DoCommand(), EnforcePrecondition, GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetDepotIndex(), GetOrderTypeByTile(), GetStationIndex(), IsTileType(), ScriptVehicle::IsValidVehicle(), Order::MakeGoToDepot(), Order::MakeGoToStation(), Order::MakeGoToWaypoint(), MP_STATION, ODATF_SERVICE_ONLY, ODATFB_HALT, ODTFB_PART_OF_ORDERS, ODTFB_SERVICE, ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, ORDER_CURRENT, OSL_PLATFORM_FAR_END, Order::Pack(), ResolveOrderPosition(), ScriptOrderPositionToRealOrderPosition(), Order::SetLoadType(), Order::SetNonStopType(), Order::SetStopLocation(), Order::SetUnloadType(), and VEH_AIRCRAFT.

Referenced by AppendOrder().

bool ScriptOrder::IsConditionalOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order is a conditional order.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
order_position != ORDER_CURRENT && IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is a conditional order.

Definition at line 128 of file script_order.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Order::GetType(), IsValidVehicleOrder(), ORDER_CURRENT, and ScriptOrderPositionToRealOrderPosition().

Referenced by GetOrderCompareFunction(), GetOrderCompareValue(), GetOrderCondition(), GetOrderJumpTo(), SetOrderCompareFunction(), SetOrderCompareValue(), SetOrderCondition(), and SetOrderJumpTo().

bool ScriptOrder::IsCurrentOrderPartOfOrderList ( VehicleID  vehicle_id  )  [static]

Checks whether the current order is part of the orderlist.

Parameters:
vehicle_id The vehicle to check.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
Returns:
True if and only if the current order is part of the order list.
Note:
If the order is a non-'non-stop' order, and the vehicle is currently (un)loading at a station that is not the final destination, this function will still return true.

Definition at line 154 of file script_order.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Order::GetDepotOrderType(), GetOrderCount(), Order::GetType(), and ScriptVehicle::IsValidVehicle().

bool ScriptOrder::IsGotoDepotOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order is a goto-depot order.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is a goto-depot order.

Definition at line 112 of file script_order.cpp.

References Order::GetType(), IsValidVehicleOrder(), and ResolveOrder().

Referenced by GetOrderRefit(), and SetOrderRefit().

bool ScriptOrder::IsGotoStationOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order is a goto-station order.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is a goto-station order.

Definition at line 104 of file script_order.cpp.

References Order::GetType(), IsValidVehicleOrder(), and ResolveOrder().

Referenced by GetOrderRefit(), GetStopLocation(), SetOrderRefit(), and SetStopLocation().

bool ScriptOrder::IsGotoWaypointOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order is a goto-waypoint order.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is a goto-waypoint order.

Definition at line 120 of file script_order.cpp.

References Order::GetType(), IsValidVehicleOrder(), and ResolveOrder().

bool ScriptOrder::IsRefitOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order has a valid refit cargo.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
order_position != ORDER_CURRENT && IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is has a valid refit cargo.

Definition at line 146 of file script_order.cpp.

References Order::IsRefit(), IsValidVehicleOrder(), and ResolveOrder().

bool ScriptOrder::IsValidConditionalOrder ( OrderCondition  condition,
CompareFunction  compare 
) [static]

Checks whether the given combination of condition and compare function is valid.

Parameters:
condition The condition to check.
compare The compare function to check.
Returns:
True if and only if the combination of condition and compare function is valid.

Definition at line 206 of file script_order.cpp.

References CF_EQUALS, CF_IS_TRUE, OC_AGE, OC_LOAD_PERCENTAGE, OC_MAX_SPEED, OC_RELIABILITY, OC_REMAINING_LIFETIME, OC_REQUIRES_SERVICE, and OC_UNCONDITIONALLY.

bool ScriptOrder::IsValidVehicleOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]
bool ScriptOrder::IsVoidOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Checks whether the given order is a void order.

A void order is an order that used to be a goto station, depot or waypoint order but its destination got removed. In OpenTTD these orders as shown as "(Invalid Order)" in the order list of a vehicle.

Parameters:
vehicle_id The vehicle to check.
order_position The order index to check.
Precondition:
order_position != ORDER_CURRENT && IsValidVehicleOrder(vehicle_id, order_position).
Returns:
True if and only if the order is a void order.

Definition at line 137 of file script_order.cpp.

References Order::GetType(), IsValidVehicleOrder(), ORDER_CURRENT, and ResolveOrder().

bool ScriptOrder::MoveOrder ( VehicleID  vehicle_id,
OrderPosition  order_position_move,
OrderPosition  order_position_target 
) [static]

Move an order inside the orderlist.

Parameters:
vehicle_id The vehicle to move the orders.
order_position_move The order to move.
order_position_target The target order
Precondition:
IsValidVehicleOrder(vehicle_id, order_position_move).
IsValidVehicleOrder(vehicle_id, order_position_target).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
Returns:
True if and only if the order was moved.
Note:
If the order is moved to a lower place (e.g. from 7 to 2) the target order is moved upwards (e.g. 3). If the order is moved to a higher place (e.g. from 7 to 9) the target will be moved downwards (e.g. 8).

Definition at line 623 of file script_order.cpp.

References CMD_MOVE_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsValidVehicleOrder(), ResolveOrderPosition(), and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::RemoveOrder ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Removes an order from the vehicle's order list.

Parameters:
vehicle_id The vehicle to remove the order from.
order_position The order to remove from the order list.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
Returns:
True if and only if the order was removed.

Definition at line 521 of file script_order.cpp.

References CMD_DELETE_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsValidVehicleOrder(), ResolveOrderPosition(), and ScriptOrderPositionToRealOrderPosition().

ScriptOrder::OrderPosition ScriptOrder::ResolveOrderPosition ( VehicleID  vehicle_id,
OrderPosition  order_position 
) [static]

Resolves the given order index to the correct index for the given vehicle.

If the order index was ORDER_CURRENT it will be resolved to the index of the current order (as shown in the order list). If the order with the given index does not exist it will return ORDER_INVALID.

Parameters:
vehicle_id The vehicle to check the order index for.
order_position The order index to resolve.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
Returns:
The resolved order index.

Definition at line 164 of file script_order.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), ScriptVehicle::IsValidVehicle(), ORDER_CURRENT, and ORDER_INVALID.

Referenced by _SetOrderFlags(), InsertConditionalOrder(), InsertOrder(), MoveOrder(), RemoveOrder(), ResolveOrder(), SetOrderRefit(), SetStopLocation(), and SkipToOrder().

bool ScriptOrder::SetOrderCompareFunction ( VehicleID  vehicle_id,
OrderPosition  order_position,
CompareFunction  compare 
) [static]

Sets the CompareFunction of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to set the compare function for.
order_position The order to set the compare function for.
compare The new compare function of the order.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
compare >= CF_EQUALS && compare <= CF_IS_FALSE.
Returns:
Whether the order has been/can be changed.

Definition at line 388 of file script_order.cpp.

References CF_EQUALS, CF_IS_FALSE, CMD_MODIFY_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsConditionalOrder(), IsValidVehicleOrder(), MOF_COND_COMPARATOR, ORDER_CURRENT, and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::SetOrderCompareValue ( VehicleID  vehicle_id,
OrderPosition  order_position,
int32  value 
) [static]

Sets the value to compare against of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to set the value for.
order_position The order to set the value for.
value The value to compare against.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
value >= 0 && value < 2048.
Returns:
Whether the order has been/can be changed.

Definition at line 398 of file script_order.cpp.

References CMD_MODIFY_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, GetOrderCondition(), IsConditionalOrder(), IsValidVehicleOrder(), MOF_COND_VALUE, OC_MAX_SPEED, ORDER_CURRENT, and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::SetOrderCondition ( VehicleID  vehicle_id,
OrderPosition  order_position,
OrderCondition  condition 
) [static]

Sets the OrderCondition of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to set the condition type for.
order_position The order to set the condition type for.
condition The condition to compare on.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
condition >= OC_LOAD_PERCENTAGE && condition <= OC_UNCONDITIONALLY.
Returns:
Whether the order has been/can be changed.

Definition at line 378 of file script_order.cpp.

References CMD_MODIFY_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsConditionalOrder(), IsValidVehicleOrder(), MOF_COND_VARIABLE, OC_LOAD_PERCENTAGE, OC_REMAINING_LIFETIME, ORDER_CURRENT, and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::SetOrderFlags ( VehicleID  vehicle_id,
OrderPosition  order_position,
ScriptOrder::ScriptOrderFlags  order_flags 
) [static]

Changes the order flags of the given order.

Parameters:
vehicle_id The vehicle to change the order of.
order_position The order to change.
order_flags The new flags given to the order.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_position), order_flags).
(order_flags & AIOF_GOTO_NEAREST_DEPOT) == (GetOrderFlags(vehicle_id, order_position) & AIOF_GOTO_NEAREST_DEPOT).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
Returns:
True if and only if the order was changed.

Definition at line 612 of file script_order.cpp.

References _SetOrderFlags(), and ScriptObject::SetCallbackVariable().

bool ScriptOrder::SetOrderJumpTo ( VehicleID  vehicle_id,
OrderPosition  order_position,
OrderPosition  jump_to 
) [static]

Sets the OrderPosition to jump to if the check succeeds of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to set the OrderPosition for.
order_position The order to set the OrderPosition for.
jump_to The order to jump to if the check succeeds.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
IsValidVehicleOrder(vehicle_id, jump_to).
order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position).
Returns:
Whether the order has been/can be changed.

Definition at line 369 of file script_order.cpp.

References CMD_MODIFY_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsConditionalOrder(), IsValidVehicleOrder(), MOF_COND_DESTINATION, and ORDER_CURRENT.

bool ScriptOrder::SetOrderRefit ( VehicleID  vehicle_id,
OrderPosition  order_position,
CargoID  refit_cargo 
) [static]

Sets the refit cargo type of the given order for the given vehicle.

Parameters:
vehicle_id The vehicle to set the refit cargo for.
order_position The order to set the refit cargo for.
refit_cargo The cargo to refit to. The refit can be cleared by passing CT_NO_REFIT.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
IsGotoStationOrder(vehicle_id, order_position) || (IsGotoDepotOrder(vehicle_id, order_position) && refit_cargo != CT_AUTO_REFIT).
ScriptCargo::IsValidCargo(refit_cargo) || refit_cargo == CT_AUTO_REFIT || refit_cargo == CT_NO_REFIT
Returns:
Whether the order has been/can be changed.

Definition at line 424 of file script_order.cpp.

References CMD_ORDER_REFIT, CT_AUTO_REFIT, CT_NO_REFIT, ScriptObject::DoCommand(), EnforcePrecondition, IsGotoDepotOrder(), IsGotoStationOrder(), ScriptCargo::IsValidCargo(), IsValidVehicleOrder(), ResolveOrderPosition(), and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::SetStopLocation ( VehicleID  vehicle_id,
OrderPosition  order_position,
StopLocation  stop_location 
) [static]

Sets the stoplocation of the given order for the given train.

Parameters:
vehicle_id The vehicle to get the value for.
order_position The order to get the value for.
stop_location The relative position where a train will stop inside a station.
Precondition:
IsValidVehicleOrder(vehicle_id, order_position).
ScriptVehicle::GetVehicleType(vehicle_id) == ScriptVehicle::VT_RAIL.
IsGotoStationOrder(vehicle_id, order_position).
stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR
Returns:
Whether the order has been/can be changed.

Definition at line 409 of file script_order.cpp.

References CMD_MODIFY_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, ScriptVehicle::GetVehicleType(), IsGotoStationOrder(), IsValidVehicleOrder(), MOF_STOP_LOCATION, ResolveOrderPosition(), ScriptOrderPositionToRealOrderPosition(), STOPLOCATION_FAR, STOPLOCATION_NEAR, and ScriptVehicle::VT_RAIL.

bool ScriptOrder::ShareOrders ( VehicleID  vehicle_id,
VehicleID  main_vehicle_id 
) [static]

Shares the orders between two vehicles.

The orders of the main vehicle are going to be the orders of the changed vehicle.

Parameters:
vehicle_id The vehicle to add to the shared order list.
main_vehicle_id The vehicle to share the orders with.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
ScriptVehicle::IsValidVehicle(main_vehicle_id).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
Returns:
True if and only if the sharing succeeded.

Definition at line 644 of file script_order.cpp.

References CMD_CLONE_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, and ScriptVehicle::IsValidVehicle().

bool ScriptOrder::SkipToOrder ( VehicleID  vehicle_id,
OrderPosition  next_order 
) [static]

Make a vehicle execute next_order instead of its current order.

Parameters:
vehicle_id The vehicle that should skip some orders.
next_order The order the vehicle should skip to.
Precondition:
IsValidVehicleOrder(vehicle_id, next_order).
Exceptions:
ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY 
Returns:
True if and only the current order was changed.

Definition at line 531 of file script_order.cpp.

References CMD_SKIP_TO_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, IsValidVehicleOrder(), ResolveOrderPosition(), and ScriptOrderPositionToRealOrderPosition().

bool ScriptOrder::UnshareOrders ( VehicleID  vehicle_id  )  [static]

Removes the given vehicle from a shared orders list.

Parameters:
vehicle_id The vehicle to remove from the shared order list.
Precondition:
ScriptVehicle::IsValidVehicle(vehicle_id).
Returns:
True if and only if the unsharing succeeded.

Definition at line 652 of file script_order.cpp.

References CMD_CLONE_ORDER, ScriptObject::DoCommand(), EnforcePrecondition, and ScriptVehicle::IsValidVehicle().


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