OpenTTD Source 20261112-master-gbcbec5e63f
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#ifndef ORDER_FUNC_H
11#define ORDER_FUNC_H
12
13#include "order_type.h"
14#include "vehicle_type.h"
15
16/* Functions */
17void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar = false);
18void InvalidateVehicleOrder(const Vehicle *v, int data);
19void CheckOrders(const Vehicle*);
20void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist = false, bool reset_order_indices = true);
21bool ProcessOrders(Vehicle *v);
22bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth = 0, bool pbs_look_ahead = false);
24uint GetOrderDistance(VehicleOrderID prev, VehicleOrderID cur, const Vehicle *v, int conditional_depth = 0);
25
26void DrawOrderString(const Vehicle *v, const Order *order, VehicleOrderID order_index, int y, bool selected, bool timetable, int left, int middle, int right);
27
28static const uint DEF_SERVINT_DAYS_TRAINS = 150;
29static const uint DEF_SERVINT_DAYS_ROADVEH = 150;
30static const uint DEF_SERVINT_DAYS_AIRCRAFT = 100;
31static const uint DEF_SERVINT_DAYS_SHIPS = 360;
32static const uint MIN_SERVINT_DAYS = 30;
33static const uint MAX_SERVINT_DAYS = 800;
34
35static const uint DEF_SERVINT_MINUTES_TRAINS = 5;
36static const uint DEF_SERVINT_MINUTES_ROADVEH = 5;
37static const uint DEF_SERVINT_MINUTES_AIRCRAFT = 3;
38static const uint DEF_SERVINT_MINUTES_SHIPS = 12;
39static const uint MIN_SERVINT_MINUTES = 1;
40static const uint MAX_SERVINT_MINUTES = 30;
41
42static const uint DEF_SERVINT_PERCENT = 50;
43static const uint MIN_SERVINT_PERCENT = 5;
44static const uint MAX_SERVINT_PERCENT = 90;
45
46uint16_t GetServiceIntervalClamped(int interval, bool ispercent);
47
48#endif /* ORDER_FUNC_H */
uint16_t GetServiceIntervalClamped(int interval, bool ispercent)
Clamp the service interval to the correct min/max.
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist=false, bool reset_order_indices=true)
Delete all orders from a vehicle.
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.
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar=false)
Removes an order from all vehicles.
void DrawOrderString(const Vehicle *v, const Order *order, VehicleOrderID order_index, int y, bool selected, bool timetable, int left, int middle, int right)
Draws an order in order or timetable GUI.
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
uint GetOrderDistance(VehicleOrderID prev, VehicleOrderID cur, const Vehicle *v, int conditional_depth=0)
Get the distance between two orders of a vehicle.
void CheckOrders(const Vehicle *)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Types related to orders.
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related).
Definition order_type.h:18
OrderType
Order types.
Definition order_type.h:50
If you change this, keep in mind that it is also saved in 2 other places:
Definition order_base.h:33
Vehicle data structure.
Types related to vehicles.