OpenTTD
Functions | Variables
order_cmd.cpp File Reference

Handling of orders. More...

#include "stdafx.h"
#include "debug.h"
#include "cmd_helper.h"
#include "command_func.h"
#include "company_func.h"
#include "news_func.h"
#include "strings_func.h"
#include "timetable.h"
#include "vehicle_func.h"
#include "depot_base.h"
#include "core/pool_func.hpp"
#include "core/random_func.hpp"
#include "aircraft.h"
#include "roadveh.h"
#include "station_base.h"
#include "waypoint_base.h"
#include "company_base.h"
#include "order_backup.h"
#include "cheat_type.h"
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

 assert_compile (sizeof(DestinationID) >=sizeof(DepotID))
 
void InvalidateVehicleOrder (const Vehicle *v, int data)
 Updates the widgets of a vehicle which contains the order-data. More...
 
static bool OrderGoesToStation (const Vehicle *v, const Order *o)
 Checks whether the order goes to a station or not, i.e. More...
 
static void DeleteOrderWarnings (const Vehicle *v)
 Delete all news items regarding defective orders about a vehicle This could kill still valid warnings (for example about void order when just another order gets added), but assume the company will notice the problems, when (s)he's changing the orders.
 
uint GetOrderDistance (const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth)
 Get the distance between two orders of a vehicle. More...
 
CommandCost CmdInsertOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Add an order to the orderlist of a vehicle. More...
 
void InsertOrder (Vehicle *v, Order *new_o, VehicleOrderID sel_ord)
 Insert a new order but skip the validation. More...
 
static CommandCost DecloneOrder (Vehicle *dst, DoCommandFlag flags)
 Declone an order-list. More...
 
CommandCost CmdDeleteOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Delete an order from the orderlist of a vehicle. More...
 
static void CancelLoadingDueToDeletedOrder (Vehicle *v)
 Cancel the current loading order of the vehicle as the order was deleted. More...
 
void DeleteOrder (Vehicle *v, VehicleOrderID sel_ord)
 Delete an order but skip the parameter validation. More...
 
CommandCost CmdSkipToOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Goto order of order-list. More...
 
CommandCost CmdMoveOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Move an order inside the orderlist. More...
 
CommandCost CmdModifyOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Modify an order in the orderlist of a vehicle. More...
 
static bool CheckAircraftOrderDistance (const Aircraft *v_new, const Vehicle *v_order, const Order *first)
 Check if an aircraft has enough range for an order list. More...
 
CommandCost CmdCloneOrder (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Clone/share/copy an order-list of another vehicle. More...
 
CommandCost CmdOrderRefit (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Add/remove refit orders from an order. More...
 
void CheckOrders (const Vehicle *v)
 Check the orders of a vehicle, to see if there are invalid orders and stuff. More...
 
void RemoveOrderFromAllVehicles (OrderType type, DestinationID destination)
 Removes an order from all vehicles. More...
 
void DeleteVehicleOrders (Vehicle *v, bool keep_orderlist, bool reset_order_indices)
 Delete all orders from a vehicle. More...
 
uint16 GetServiceIntervalClamped (uint interval, bool ispercent)
 Clamp the service interval to the correct min/max. More...
 
static bool CheckForValidOrders (const Vehicle *v)
 Check if a vehicle has any valid orders. More...
 
static bool OrderConditionCompare (OrderConditionComparator occ, int variable, int value)
 Compare the variable and value based on the given comparator.
 
VehicleOrderID ProcessConditionalOrder (const Order *order, const Vehicle *v)
 Process a conditional order and determine the next order. More...
 
bool UpdateOrderDest (Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
 Update the vehicle's destination tile from an order. More...
 
bool ProcessOrders (Vehicle *v)
 Handle the orders of a vehicle and determine the next place to go to if needed. More...
 

Variables

OrderPool _order_pool ("Order")
 
OrderListPool _orderlist_pool ("OrderList")
 

Detailed Description

Handling of orders.

Definition in file order_cmd.cpp.

Function Documentation

◆ CancelLoadingDueToDeletedOrder()

static void CancelLoadingDueToDeletedOrder ( Vehicle v)
static

Cancel the current loading order of the vehicle as the order was deleted.

Parameters
vthe vehicle

Definition at line 1065 of file order_cmd.cpp.

◆ CheckAircraftOrderDistance()

static bool CheckAircraftOrderDistance ( const Aircraft v_new,
const Vehicle v_order,
const Order first 
)
static

Check if an aircraft has enough range for an order list.

Parameters
v_newAircraft to check.
v_orderVehicle currently holding the order list.
firstFirst order in the source order list.
Returns
True if the aircraft has enough range for the orders, false otherwise.

Definition at line 1527 of file order_cmd.cpp.

References AircraftCache::cached_max_range, and Order::next.

◆ CheckForValidOrders()

static bool CheckForValidOrders ( const Vehicle v)
static

Check if a vehicle has any valid orders.

Returns
false if there are no valid orders
Note
Conditional orders are not considered valid destination orders

Definition at line 1967 of file order_cmd.cpp.

◆ CheckOrders()

void CheckOrders ( const Vehicle v)

Check the orders of a vehicle, to see if there are invalid orders and stuff.

Definition at line 1762 of file order_cmd.cpp.

References _local_company, _settings_client, Vehicle::day_counter, Vehicle::FirstShared(), ClientSettings::gui, INVALID_STRING_ID, GUISettings::order_review_system, Vehicle::owner, Vehicle::vehstatus, VS_CRASHED, and VS_STOPPED.

Referenced by Aircraft::OnNewDay().

◆ CmdCloneOrder()

CommandCost CmdCloneOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Clone/share/copy an order-list of another vehicle.

Parameters
tileunused
flagsoperation to perform
p1various bitstuffed elements
  • p1 = (bit 0-19) - destination vehicle to clone orders to
  • p1 = (bit 30-31) - action to perform
p2source vehicle to clone orders from, if any (none for CO_UNSHARE)
textunused
Returns
the cost of this operation or an error

Definition at line 1560 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::IsPrimaryVehicle(), and Vehicle::owner.

◆ CmdDeleteOrder()

CommandCost CmdDeleteOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Delete an order from the orderlist of a vehicle.

Parameters
tileunused
flagsoperation to perform
p1the ID of the vehicle
p2the order to delete (max 255)
textunused
Returns
the cost of this operation or an error

Definition at line 1040 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, DC_EXEC, DecloneOrder(), DeleteOrder(), CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::GetNumOrders(), Vehicle::GetOrder(), Vehicle::IsPrimaryVehicle(), and Vehicle::owner.

◆ CmdInsertOrder()

CommandCost CmdInsertOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Add an order to the orderlist of a vehicle.

Parameters
tileunused
flagsoperation to perform
p1various bitstuffed elements
  • p1 = (bit 0 - 19) - ID of the vehicle
  • p1 = (bit 24 - 31) - the selected order (if any). If the last order is given, the order will be inserted before that one the maximum vehicle order id is 254.
p2packed order to insert
textunused
Returns
the cost of this operation or an error

Definition at line 728 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Order::GetType(), Vehicle::IsPrimaryVehicle(), and Vehicle::owner.

◆ CmdModifyOrder()

CommandCost CmdModifyOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Modify an order in the orderlist of a vehicle.

Parameters
tileunused
flagsoperation to perform
p1various bitstuffed elements
  • p1 = (bit 0 - 19) - ID of the vehicle
  • p1 = (bit 24 - 31) - the selected order (if any). If the last order is given, the order will be inserted before that one the maximum vehicle order id is 254.
p2various bitstuffed elements
  • p2 = (bit 0 - 3) - what data to modify (
See also
ModifyOrderFlags)
  • p2 = (bit 4 - 15) - the data to modify
Parameters
textunused
Returns
the cost of this operation or an error

Definition at line 1291 of file order_cmd.cpp.

References GB().

◆ CmdMoveOrder()

CommandCost CmdMoveOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Move an order inside the orderlist.

Parameters
tileunused
flagsoperation to perform
p1the ID of the vehicle
p2order to move and target bit 0-15 : the order to move bit 16-31 : the target order
textunused
Returns
the cost of this operation or an error
Note
The target order will move one place down in the orderlist if you move the order upwards else it'll move it one place down

Definition at line 1187 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, BaseConsist::cur_implicit_order_index, BaseConsist::cur_real_order_index, DC_EXEC, DeleteOrderWarnings(), CommandCost::Failed(), Vehicle::FirstShared(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::GetNumOrders(), Vehicle::GetOrder(), Vehicle::IsPrimaryVehicle(), Vehicle::list, OrderList::MoveOrder(), Vehicle::NextShared(), Vehicle::orders, and Vehicle::owner.

◆ CmdOrderRefit()

CommandCost CmdOrderRefit ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Add/remove refit orders from an order.

Parameters
tileNot used
flagsoperation to perform
p1VehicleIndex of the vehicle having the order
p2bitmask
  • bit 0-7 CargoID
  • bit 16-23 number of order to modify
textunused
Returns
the cost of this operation or an error

Definition at line 1711 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, CT_AUTO_REFIT, CT_NO_REFIT, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::GetOrder(), Vehicle::IsPrimaryVehicle(), Order::IsType(), NUM_CARGO, and Vehicle::owner.

◆ CmdSkipToOrder()

CommandCost CmdSkipToOrder ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Goto order of order-list.

Parameters
tileunused
flagsoperation to perform
p1The ID of the vehicle which order is skipped
p2the selected order to which we want to skip
textunused
Returns
the cost of this operation or an error

Definition at line 1146 of file order_cmd.cpp.

References CheckOwnership(), CMD_ERROR, BaseConsist::cur_implicit_order_index, Vehicle::current_order, DC_EXEC, CommandCost::Failed(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetIfValid(), Vehicle::GetNumOrders(), Vehicle::IsPrimaryVehicle(), Order::IsType(), and Vehicle::owner.

◆ DecloneOrder()

static CommandCost DecloneOrder ( Vehicle dst,
DoCommandFlag  flags 
)
static

Declone an order-list.

Parameters
*dstdelete the orders of this vehicle
flagsexecution flags

Definition at line 1021 of file order_cmd.cpp.

References DC_EXEC, DeleteVehicleOrders(), GetWindowClassForVehicleType(), InvalidateVehicleOrder(), InvalidateWindowClassesData(), BaseVehicle::type, and VIWD_REMOVE_ALL_ORDERS.

Referenced by CmdDeleteOrder().

◆ DeleteOrder()

void DeleteOrder ( Vehicle v,
VehicleOrderID  sel_ord 
)

Delete an order but skip the parameter validation.

Parameters
vThe vehicle to delete the order from.
sel_ordThe id of the order to be deleted.

Definition at line 1081 of file order_cmd.cpp.

References OrderList::DeleteOrderAt(), DeleteOrderWarnings(), Vehicle::FirstShared(), Vehicle::list, Vehicle::NextShared(), and Vehicle::orders.

Referenced by CmdDeleteOrder().

◆ DeleteVehicleOrders()

void DeleteVehicleOrders ( Vehicle v,
bool  keep_orderlist,
bool  reset_order_indices 
)

Delete all orders from a vehicle.

Parameters
vVehicle whose orders to reset
keep_orderlistIf true, do not free the order list, only empty it.
reset_order_indicesIf true, reset cur_implicit_order_index and cur_real_order_index and cancel the current full load order (if the vehicle is loading). If false, you have to make sure the order indices are valid after your messing with them!

Definition at line 1925 of file order_cmd.cpp.

References BaseConsist::cur_implicit_order_index, BaseConsist::cur_real_order_index, Vehicle::current_order, DeleteOrderWarnings(), OrderList::FreeChain(), Vehicle::IsOrderListShared(), Order::IsType(), Vehicle::list, Vehicle::orders, and Vehicle::RemoveFromShared().

Referenced by CmdSellRailWagon(), and DecloneOrder().

◆ GetOrderDistance()

uint GetOrderDistance ( const Order prev,
const Order cur,
const Vehicle v,
int  conditional_depth 
)

Get the distance between two orders of a vehicle.

Conditional orders are resolved and the bigger distance of the two order branches is returned.

Parameters
prevOrigin order.
curDestination order.
vThe vehicle to get the distance for.
conditional_depthInternal param for resolving conditional orders.
Returns
Maximum distance between the two orders.

Definition at line 697 of file order_cmd.cpp.

References Order::IsType().

◆ GetServiceIntervalClamped()

uint16 GetServiceIntervalClamped ( uint  interval,
bool  ispercent 
)

Clamp the service interval to the correct min/max.

The actual min/max values depend on whether it's in percent or days.

Parameters
intervalproposed service interval
company_idthe owner of the vehicle
Returns
Clamped service interval

Definition at line 1954 of file order_cmd.cpp.

References Clamp().

Referenced by CmdChangeServiceInt(), VehicleDetailsWindow::OnClick(), and VehicleDetailsWindow::OnDropdownSelect().

◆ InsertOrder()

void InsertOrder ( Vehicle v,
Order new_o,
VehicleOrderID  sel_ord 
)

Insert a new order but skip the validation.

Parameters
vThe vehicle to insert the order to.
new_oThe new order.
sel_ordThe position the order should be inserted at.

Definition at line 953 of file order_cmd.cpp.

References DeleteOrderWarnings(), Vehicle::FirstShared(), OrderList::InsertOrderAt(), Vehicle::list, Vehicle::NextShared(), and Vehicle::orders.

◆ InvalidateVehicleOrder()

void InvalidateVehicleOrder ( const Vehicle v,
int  data 
)

◆ OrderGoesToStation()

static bool OrderGoesToStation ( const Vehicle v,
const Order o 
)
inlinestatic

Checks whether the order goes to a station or not, i.e.

whether the destination is a station

Parameters
vthe vehicle to check for
othe order to check
Returns
true if the destination is a station

Definition at line 643 of file order_cmd.cpp.

References Order::IsType().

◆ ProcessConditionalOrder()

VehicleOrderID ProcessConditionalOrder ( const Order order,
const Vehicle v 
)

Process a conditional order and determine the next order.

Parameters
orderthe order the vehicle currently has
vthe vehicle to update
Returns
index of next order to jump to, or INVALID_VEH_ORDER_ID to use the next order

Definition at line 2010 of file order_cmd.cpp.

References Order::GetType().

◆ ProcessOrders()

bool ProcessOrders ( Vehicle v)

Handle the orders of a vehicle and determine the next place to go to if needed.

Parameters
vthe vehicle to do this for.
Returns
true if the vehicle is eligible for reversing (basically only when leaving a station).

Reversing because of order change is allowed only just after leaving a station (and the difficulty setting to allowed, of course) this can be detected because only after OT_LEAVESTATION, current_order will be reset to nothing. (That also happens if no order, but in that case it won't hit the point in code where may_reverse is checked)

Definition at line 2160 of file order_cmd.cpp.

References Vehicle::current_order, and Order::GetType().

◆ RemoveOrderFromAllVehicles()

void RemoveOrderFromAllVehicles ( OrderType  type,
DestinationID  destination 
)

Removes an order from all vehicles.

Triggers when, say, a station is removed.

Parameters
typeThe type of the order (OT_GOTO_[STATION|DEPOT|WAYPOINT]).
destinationThe destination. Can be a StationID, DepotID or WaypointID.

Definition at line 1837 of file order_cmd.cpp.

References Vehicle::current_order, FOR_ALL_VEHICLES, Order::IsType(), BaseVehicle::type, and VEH_AIRCRAFT.

Referenced by Depot::~Depot().

◆ UpdateOrderDest()

bool UpdateOrderDest ( Vehicle v,
const Order order,
int  conditional_depth,
bool  pbs_look_ahead 
)

Update the vehicle's destination tile from an order.

Parameters
orderthe order the vehicle currently has
vthe vehicle to update
conditional_depththe depth (amount of steps) to go with conditional orders. This to prevent infinite loops.
pbs_look_aheadWhether we are forecasting orders for pbs reservations in advance. If true, the order indices must not be modified.

Definition at line 2039 of file order_cmd.cpp.

References Vehicle::current_order, Vehicle::dest_tile, Order::Free(), Vehicle::GetNumOrders(), and Order::GetType().