OpenTTD Source: src/order_func.h File Reference

OpenTTD Source 14.1

Functions | Variables
order_func.h File Reference
`#include "order_type.h"`
`#include "vehicle_type.h"`
`#include "company_type.h"`

Go to the source code of this file.

## Functions
void | RemoveOrderFromAllVehicles (OrderType type, DestinationID destination, bool hangar=false)
| Removes an order from all vehicles. More...
void | InvalidateVehicleOrder (const Vehicle *v, int data)
| Updates the widgets of a vehicle which contains the order-data. More...
void | CheckOrders (const Vehicle *)
| Check the orders of a vehicle, to see if there are invalid orders and stuff. More...
void | DeleteVehicleOrders (Vehicle *v, bool keep_orderlist=false, bool reset_order_indices=true)
| Delete all orders from a vehicle. More...
bool | ProcessOrders (Vehicle *v)
| Handle the orders of a vehicle and determine the next place to go to if needed. More...
bool | UpdateOrderDest (Vehicle *v, const Order *order, int conditional_depth=0, bool pbs_look_ahead=false)
| Update the vehicle's destination tile from an order. More...
VehicleOrderID | ProcessConditionalOrder (const Order *order, const Vehicle *v)
| Process a conditional order and determine the next order. More...
uint | GetOrderDistance (const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth=0)
| Get the distance between two orders of a vehicle. More...
void | DrawOrderString (const Vehicle *v, const Order *order, int order_index, int y, bool selected, bool timetable, int left, int middle, int right)
| Draws an order in order or timetable GUI. More...
uint16_t | GetServiceIntervalClamped (int interval, bool ispercent)
| Clamp the service interval to the correct min/max. More...

## Variables
static const uint | DEF_SERVINT_DAYS_TRAINS = 150
static const uint | DEF_SERVINT_DAYS_ROADVEH = 150
static const uint | DEF_SERVINT_DAYS_AIRCRAFT = 100
static const uint | DEF_SERVINT_DAYS_SHIPS = 360
static const uint | MIN_SERVINT_DAYS = 30
static const uint | MAX_SERVINT_DAYS = 800
static const uint | DEF_SERVINT_MINUTES_TRAINS = 5
static const uint | DEF_SERVINT_MINUTES_ROADVEH = 5
static const uint | DEF_SERVINT_MINUTES_AIRCRAFT = 3
static const uint | DEF_SERVINT_MINUTES_SHIPS = 12
static const uint | MIN_SERVINT_MINUTES = 1
static const uint | MAX_SERVINT_MINUTES = 30
static const uint | DEF_SERVINT_PERCENT = 50
static const uint | MIN_SERVINT_PERCENT = 5
static const uint | MAX_SERVINT_PERCENT = 90

## Detailed Description

Functions related to orders.

Definition in file order_func.h.

## Function Documentation

## ◆ CheckOrders()

void CheckOrders | ( | const Vehicle * | v | ) |

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

Definition at line 1719 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::Orders(), Vehicle::owner, Vehicle::vehstatus, VS_CRASHED, and VS_STOPPED.

Referenced by Aircraft::OnNewEconomyDay().

## ◆ DeleteVehicleOrders()

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

Delete all orders from a vehicle.

Parameters

  v | Vehicle whose orders to reset
  keep_orderlist | If true, do not free the order list, only empty it.
  reset_order_indices | If 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 1877 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::orders, Vehicle::RemoveFromShared(), and BaseConsist::ResetDepotUnbunching().

Referenced by CmdSellRailWagon(), and DecloneOrder().

## ◆ DrawOrderString()

void DrawOrderString | ( | const Vehicle * | v,
|  | const Order * | order,
|  | int | order_index,
|  | int | y,
|  | bool | selected,
|  | bool | timetable,
|  | int | left,
|  | int | middle,
|  | int | right
| ) |  |

Draws an order in order or timetable GUI.

Parameters

  v | Vehicle the order belongs to
  order | The order to draw
  order_index | Index of the order in the orders of the vehicle
  y | Y position for drawing
  selected | True, if the order is selected
  timetable | True, when drawing in the timetable GUI
  left | Left border for text drawing
  middle | X position between order index and order text
  right | Right border for text drawing

Definition at line 222 of file order_gui.cpp.

## ◆ 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

  prev | Origin order.
  cur | Destination order.
  v | The vehicle to get the distance for.
  conditional_depth | Internal param for resolving conditional orders.

Returns
  Maximum distance between the two orders.

Definition at line 685 of file order_cmd.cpp.

References Order::IsType().

## ◆ GetServiceIntervalClamped()

uint16_t GetServiceIntervalClamped | ( | int | interval,
|  | bool | ispercent
| ) |  |

Clamp the service interval to the correct min/max.

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

Parameters

  interval | The proposed service interval.
  ispercent | Whether the interval is a percent.

Returns
  The service interval clamped to use the chosen units.

Definition at line 1909 of file order_cmd.cpp.

## ◆ InvalidateVehicleOrder()

void InvalidateVehicleOrder | ( | const Vehicle * | v,
|  | int | data
| ) |  |

Updates the widgets of a vehicle which contains the order-data.

Definition at line 251 of file order_cmd.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, InvalidateWindowData(), SetWindowDirty(), WC_VEHICLE_ORDERS, WC_VEHICLE_TIMETABLE, and WC_VEHICLE_VIEW.

Referenced by CmdMoveOrder(), DecloneOrder(), and Vehicle::IncrementRealOrderIndex().

## ◆ ProcessConditionalOrder()

VehicleOrderID ProcessConditionalOrder | ( | const Order * | order,
|  | const Vehicle * | v
| ) |  |

Process a conditional order and determine the next order.

Parameters

  order | the order the vehicle currently has
  v | the vehicle to update

Returns
  index of next order to jump to, or INVALID_VEH_ORDER_ID to use the next order

Definition at line 1976 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

  v | the 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 2135 of file order_cmd.cpp.

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

## ◆ RemoveOrderFromAllVehicles()

void RemoveOrderFromAllVehicles | ( | OrderType | type,
|  | DestinationID | destination,
|  | bool | hangar
| ) |  |

Removes an order from all vehicles.

Triggers when, say, a station is removed.

Parameters

  type | The type of the order (OT_GOTO_[STATION|DEPOT|WAYPOINT]).
  destination | The destination. Can be a StationID, DepotID or WaypointID.
  hangar | Only used for airports in the destination. When false, remove airport and hangar orders. When true, remove either airport or hangar order.

Definition at line 1795 of file order_cmd.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Iterate(), 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

  order | the order the vehicle currently has
  v | the vehicle to update
  conditional_depth | the depth (amount of steps) to go with conditional orders. This to prevent infinite loops.
  pbs_look_ahead | Whether we are forecasting orders for pbs reservations in advance. If true, the order indices must not be modified.

Definition at line 2006 of file order_cmd.cpp.

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