OpenTTD Source: src/order_func.h Source File

OpenTTD Source 14.0-beta1

order_func.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef ORDER_FUNC_H
11 #define ORDER_FUNC_H
12
13 #include "order_type.h"
14 #include "vehicle_type.h"
15 #include "company_type.h"
16
17 /* Functions */
18 void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar = false);
19 void InvalidateVehicleOrder(const Vehicle *v, int data);
20 void CheckOrders(const Vehicle*);
21 void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist = false, bool reset_order_indices = true);
22 bool ProcessOrders(Vehicle *v);
23 bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth = 0, bool pbs_look_ahead = false);
24 VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v);
25 uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth = 0);
26
27 void DrawOrderString(const Vehicle *v, const Order *order, int order_index, int y, bool selected, bool timetable, int left, int middle, int right);
28
29 static const uint DEF_SERVINT_DAYS_TRAINS = 150;
30 static const uint DEF_SERVINT_DAYS_ROADVEH = 150;
31 static const uint DEF_SERVINT_DAYS_AIRCRAFT = 100;
32 static const uint DEF_SERVINT_DAYS_SHIPS = 360;
33 static const uint MIN_SERVINT_DAYS = 30;
34 static const uint MAX_SERVINT_DAYS = 800;
35
36 static const uint DEF_SERVINT_MINUTES_TRAINS = 5;
37 static const uint DEF_SERVINT_MINUTES_ROADVEH = 5;
38 static const uint DEF_SERVINT_MINUTES_AIRCRAFT = 3;
39 static const uint DEF_SERVINT_MINUTES_SHIPS = 12;
40 static const uint MIN_SERVINT_MINUTES = 1;
41 static const uint MAX_SERVINT_MINUTES = 30;
42
43 static const uint DEF_SERVINT_PERCENT = 50;
44 static const uint MIN_SERVINT_PERCENT = 5;
45 static const uint MAX_SERVINT_PERCENT = 90;
46
47 uint16_t GetServiceIntervalClamped(int interval, bool ispercent);
48
49 #endif /* ORDER_FUNC_H */
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
GetServiceIntervalClamped
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
Definition: order_cmd.cpp:1906
CheckOrders
void CheckOrders(const Vehicle *)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Definition: order_cmd.cpp:1716
RemoveOrderFromAllVehicles
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar=false)
Removes an order from all vehicles.
Definition: order_cmd.cpp:1792
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
UpdateOrderDest
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.
Definition: order_cmd.cpp:2003
ProcessConditionalOrder
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
Definition: order_cmd.cpp:1973
ProcessOrders
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
Definition: order_cmd.cpp:2132
DeleteVehicleOrders
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist=false, bool reset_order_indices=true)
Delete all orders from a vehicle.
Definition: order_cmd.cpp:1874
vehicle_type.h
OrderType
OrderType
Order types.
Definition: order_type.h:35
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.
Definition: order_gui.cpp:220
InvalidateVehicleOrder
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
Definition: order_cmd.cpp:251
order_type.h
Order
Definition: order_base.h:36
company_type.h
GetOrderDistance
uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth=0)
Get the distance between two orders of a vehicle.
Definition: order_cmd.cpp:685