OpenTTD
order_type.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_TYPE_H
11 #define ORDER_TYPE_H
12 
13 #include "core/enum_type.hpp"
14 
15 typedef byte VehicleOrderID;
16 typedef uint32 OrderID;
17 typedef uint16 OrderListID;
18 typedef uint16 DestinationID;
19 
24 
26 static const OrderID INVALID_ORDER = 0xFFFFFF;
27 
32 static const uint IMPLICIT_ORDER_ONLY_CAP = 32;
33 
35 enum OrderType : byte {
36  OT_BEGIN = 0,
37  OT_NOTHING = 0,
38  OT_GOTO_STATION = 1,
39  OT_GOTO_DEPOT = 2,
40  OT_LOADING = 3,
41  OT_LEAVESTATION = 4,
42  OT_DUMMY = 5,
43  OT_GOTO_WAYPOINT = 6,
44  OT_CONDITIONAL = 7,
45  OT_IMPLICIT = 8,
46  OT_END
47 };
48 
54  OUFB_UNLOAD = 1 << 0,
55  OUFB_TRANSFER = 1 << 1,
56  OUFB_NO_UNLOAD = 1 << 2,
57 };
58 
64  OLFB_FULL_LOAD = 1 << 1,
67 };
68 
77  ONSF_END
78 };
79 
87  OSL_END
88 };
89 
95  ODTFB_SERVICE = 1 << 0,
97 };
98 
104  ODATFB_HALT = 1 << 0,
106 };
108 
109 
121  OCV_END
122 };
123 
136  OCC_END
137 };
138 
139 
153  MOF_END
154 };
155 template <> struct EnumPropsT<ModifyOrderFlags> : MakeEnumPropsT<ModifyOrderFlags, byte, MOF_NON_STOP, MOF_END, MOF_END, 4> {};
156 
164  DA_END
165 };
166 
174  MTF_END
175 };
176 template <> struct EnumPropsT<ModifyTimetableFlags> : MakeEnumPropsT<ModifyTimetableFlags, byte, MTF_WAIT_TIME, MTF_END, MTF_END, 2> {};
177 
178 
181  CO_SHARE = 0,
182  CO_COPY = 1,
183  CO_UNSHARE = 2
184 };
185 
186 struct Order;
187 struct OrderList;
188 
189 #endif /* ORDER_TYPE_H */
OrderConditionVariable
Variables (of a vehicle) to &#39;cause&#39; skipping on.
Definition: order_type.h:112
Helper template class that makes basic properties of given enumeration type visible from outsize...
Definition: enum_type.hpp:62
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Set max travel speed.
Definition: order_type.h:173
Passes an OrderUnloadType.
Definition: order_type.h:146
Set wait time.
Definition: order_type.h:171
Skip if both values are equal.
Definition: order_type.h:128
Load as long as there is cargo that fits in the train.
Definition: order_type.h:63
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition: order_type.h:21
Selects the OrderDepotAction.
Definition: order_type.h:148
Skip if the variable is true.
Definition: order_type.h:134
Skip based on the reliability.
Definition: order_type.h:114
Stop at the middle of the platform.
Definition: order_type.h:85
A comparator changes.
Definition: order_type.h:150
Unload all cargo that the station accepts.
Definition: order_type.h:53
Only service the vehicle.
Definition: order_type.h:103
OrderNonStopFlags
Non-stop order flags.
Definition: order_type.h:72
Skip if the value is more or equal to the limit.
Definition: order_type.h:133
ModifyTimetableFlags
Enumeration for the data to set in CmdChangeTimetable.
Definition: order_type.h:170
Skip based on the age.
Definition: order_type.h:116
Type (helpers) for enums.
The vehicle will stop at any station it passes except the destination.
Definition: order_type.h:75
Stop at the near end of the platform.
Definition: order_type.h:84
Set travel time.
Definition: order_type.h:172
Stop at the far end of the platform.
Definition: order_type.h:86
The vehicle will stop at any station it passes and the destination.
Definition: order_type.h:73
Passes an OrderStopLocation.
Definition: order_type.h:145
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition: order_base.h:250
The vehicle will not stop at any stations it passes including the destination.
Definition: order_type.h:76
Do not load anything.
Definition: order_type.h:66
Manually initiated order.
Definition: order_type.h:94
Skip if the value is less or equal to the limit.
Definition: order_type.h:131
Change the destination of a conditional order.
Definition: order_type.h:152
Informative template class exposing basic enumeration properties used by several other templates belo...
Definition: enum_type.hpp:48
Always skip.
Definition: order_type.h:118
OrderDepotActionFlags
Actions that can be performed when the vehicle enters the depot.
Definition: order_type.h:102
OrderConditionComparator
Comparator for the skip reasoning.
Definition: order_type.h:127
Always go to the depot.
Definition: order_type.h:161
Service the vehicle and then halt it.
Definition: order_type.h:104
Service only if needed.
Definition: order_type.h:162
The value to set the condition to.
Definition: order_type.h:151
Skip based on the remaining lifetime.
Definition: order_type.h:119
Skip if the value is less than the limit.
Definition: order_type.h:130
Transfer all cargo onto the platform.
Definition: order_type.h:55
Skip when the vehicle requires service.
Definition: order_type.h:117
OrderUnloadFlags
Flags related to the unloading order.
Definition: order_type.h:52
A conditional variable changes.
Definition: order_type.h:149
OrderStopLocation
Where to stop the trains.
Definition: order_type.h:83
Passes an OrderNonStopFlags.
Definition: order_type.h:144
static const OrderID INVALID_ORDER
Invalid order (sentinel)
Definition: order_type.h:26
Skip if both values are not equal.
Definition: order_type.h:129
OrderLoadFlags
Flags related to the loading order.
Definition: order_type.h:62
OrderDepotAction
Depot action to switch to when doing a MOF_DEPOT_ACTION.
Definition: order_type.h:160
Send the vehicle to the nearest depot.
Definition: order_type.h:105
Full load all cargoes of the consist.
Definition: order_type.h:64
Skip based on the amount of load.
Definition: order_type.h:113
OrderType
Order types.
Definition: order_type.h:35
Totally no unloading will be done.
Definition: order_type.h:56
The vehicle will not stop at any stations it passes except the destination.
Definition: order_type.h:74
Skip based on the maximum speed.
Definition: order_type.h:115
Passes an OrderLoadType.
Definition: order_type.h:147
ModifyOrderFlags
Enumeration for the data to set in CmdModifyOrder.
Definition: order_type.h:143
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
Force unloading all cargo onto the platform, possibly not getting paid.
Definition: order_type.h:54
static const VehicleOrderID MAX_VEH_ORDER_ID
Last valid VehicleOrderID.
Definition: order_type.h:23
This depot order is because of a regular order.
Definition: order_type.h:96
Go to the depot and stop there.
Definition: order_type.h:163
Skip if the value is more than the limit.
Definition: order_type.h:132
Full load a single cargo of the consist.
Definition: order_type.h:65
This depot order is because of the servicing limit.
Definition: order_type.h:95
Skip if the variable is false.
Definition: order_type.h:135
Skip based on the maximum reliability.
Definition: order_type.h:120
CloneOptions
Clone actions.
Definition: order_type.h:180
static const uint IMPLICIT_ORDER_ONLY_CAP
Maximum number of orders in implicit-only lists before we start searching harder for duplicates...
Definition: order_type.h:32
OrderDepotTypeFlags
Reasons that could cause us to go to the depot.
Definition: order_type.h:93