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
8 /** @file script_order.cpp Implementation of ScriptOrder. */
9
10 #include "../../stdafx.h"
11 #include "script_order.hpp"
12 #include "script_cargo.hpp"
13 #include "script_map.hpp"
14 #include "../script_instance.hpp"
15 #include "../../debug.h"
16 #include "../../vehicle_base.h"
17 #include "../../roadstop_base.h"
18 #include "../../depot_base.h"
19 #include "../../station_base.h"
20 #include "../../waypoint_base.h"
21
22 #include "../../safeguards.h"
23
24 /**
25 * Gets the order type given a tile
26 * @param t the tile to get the order from
27 * @return the order type, or OT_END when there is no order
28 */
GetOrderTypeByTile(TileIndex t)29 static OrderType GetOrderTypeByTile(TileIndex t)
30 {
31 if (!::IsValidTile(t)) return OT_END;
32
33 switch (::GetTileType(t)) {
34 default: break;
35 case MP_STATION:
36 if (IsBuoy(t) || IsRailWaypoint(t)) return OT_GOTO_WAYPOINT;
37 if (IsHangar(t)) return OT_GOTO_DEPOT;
38 return OT_GOTO_STATION;
39
40 case MP_WATER: if (::IsShipDepot(t)) return OT_GOTO_DEPOT; break;
41 case MP_ROAD: if (::GetRoadTileType(t) == ROAD_TILE_DEPOT) return OT_GOTO_DEPOT; break;
42 case MP_RAILWAY:
43 if (IsRailDepot(t)) return OT_GOTO_DEPOT;
44 break;
45 }
46
47 return OT_END;
48 }
49
IsValidVehicleOrder(VehicleID vehicle_id,OrderPosition order_position)50 /* static */ bool ScriptOrder::IsValidVehicleOrder(VehicleID vehicle_id, OrderPosition order_position)
51 {
52 return ScriptVehicle::IsValidVehicle(vehicle_id) && order_position >= 0 && (order_position < ::Vehicle::Get(vehicle_id)->GetNumManualOrders() || order_position == ORDER_CURRENT);
53 }
54
55 /**
56 * Get the current order the vehicle is executing. If the current order is in
57 * the order list, return the order from the orderlist. If the current order
58 * was a manual order, return the current order.
59 */
ResolveOrder(VehicleID vehicle_id,ScriptOrder::OrderPosition order_position)60 static const Order *ResolveOrder(VehicleID vehicle_id, ScriptOrder::OrderPosition order_position)
61 {
62 const Vehicle *v = ::Vehicle::Get(vehicle_id);
63 if (order_position == ScriptOrder::ORDER_CURRENT) {
64 const Order *order = &v->current_order;
65 if (order->GetType() == OT_GOTO_DEPOT && !(order->GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) return order;
66 order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
67 if (order_position == ScriptOrder::ORDER_INVALID) return nullptr;
68 }
69 const Order *order = v->GetFirstOrder();
70 while (order->GetType() == OT_IMPLICIT) order = order->next;
71 while (order_position > 0) {
72 order_position = (ScriptOrder::OrderPosition)(order_position - 1);
73 order = order->next;
74 while (order->GetType() == OT_IMPLICIT) order = order->next;
75 }
76 return order;
77 }
78
79 /**
80 * Convert an ScriptOrder::OrderPosition (which is the manual order index) to an order index
81 * as expected by the OpenTTD commands.
82 * @param order_position The OrderPosition to convert.
83 * @return An OpenTTD-internal index for the same order.
84 */
ScriptOrderPositionToRealOrderPosition(VehicleID vehicle_id,ScriptOrder::OrderPosition order_position)85 static int ScriptOrderPositionToRealOrderPosition(VehicleID vehicle_id, ScriptOrder::OrderPosition order_position)
86 {
87 const Vehicle *v = ::Vehicle::Get(vehicle_id);
88 if (order_position == v->GetNumManualOrders()) return v->GetNumOrders();
89
90 assert(ScriptOrder::IsValidVehicleOrder(vehicle_id, order_position));
91
92 int res = (int)order_position;
93 const Order *order = v->orders.list->GetFirstOrder();
94 for (; order->GetType() == OT_IMPLICIT; order = order->next) res++;
95 while (order_position > 0) {
96 order_position = (ScriptOrder::OrderPosition)(order_position - 1);
97 order = order->next;
98 for (; order->GetType() == OT_IMPLICIT; order = order->next) res++;
99 }
100
101 return res;
102 }
103
IsGotoStationOrder(VehicleID vehicle_id,OrderPosition order_position)104 /* static */ bool ScriptOrder::IsGotoStationOrder(VehicleID vehicle_id, OrderPosition order_position)
105 {
106 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
107
108 const Order *order = ::ResolveOrder(vehicle_id, order_position);
109 return order != nullptr && order->GetType() == OT_GOTO_STATION;
110 }
111
IsGotoDepotOrder(VehicleID vehicle_id,OrderPosition order_position)112 /* static */ bool ScriptOrder::IsGotoDepotOrder(VehicleID vehicle_id, OrderPosition order_position)
113 {
114 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
115
116 const Order *order = ::ResolveOrder(vehicle_id, order_position);
117 return order != nullptr && order->GetType() == OT_GOTO_DEPOT;
118 }
119
IsGotoWaypointOrder(VehicleID vehicle_id,OrderPosition order_position)120 /* static */ bool ScriptOrder::IsGotoWaypointOrder(VehicleID vehicle_id, OrderPosition order_position)
121 {
122 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
123
124 const Order *order = ::ResolveOrder(vehicle_id, order_position);
125 return order != nullptr && order->GetType() == OT_GOTO_WAYPOINT;
126 }
127
IsConditionalOrder(VehicleID vehicle_id,OrderPosition order_position)128 /* static */ bool ScriptOrder::IsConditionalOrder(VehicleID vehicle_id, OrderPosition order_position)
129 {
130 if (order_position == ORDER_CURRENT) return false;
131 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
132
133 const Order *order = ::Vehicle::Get(vehicle_id)->GetOrder(ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position));
134 return order->GetType() == OT_CONDITIONAL;
135 }
136
IsVoidOrder(VehicleID vehicle_id,OrderPosition order_position)137 /* static */ bool ScriptOrder::IsVoidOrder(VehicleID vehicle_id, OrderPosition order_position)
138 {
139 if (order_position == ORDER_CURRENT) return false;
140 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
141
142 const Order *order = ::ResolveOrder(vehicle_id, order_position);
143 return order->GetType() == OT_DUMMY;
144 }
145
IsRefitOrder(VehicleID vehicle_id,OrderPosition order_position)146 /* static */ bool ScriptOrder::IsRefitOrder(VehicleID vehicle_id, OrderPosition order_position)
147 {
148 if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
149
150 const Order *order = ::ResolveOrder(vehicle_id, order_position);
151 return order != nullptr && order->IsRefit();
152 }
153
IsCurrentOrderPartOfOrderList(VehicleID vehicle_id)154 /* static */ bool ScriptOrder::IsCurrentOrderPartOfOrderList(VehicleID vehicle_id)
155 {
156 if (!ScriptVehicle::IsValidVehicle(vehicle_id)) return false;
157 if (GetOrderCount(vehicle_id) == 0) return false;
158
159 const Order *order = &::Vehicle::Get(vehicle_id)->current_order;
160 if (order->GetType() != OT_GOTO_DEPOT) return true;
161 return (order->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0;
162 }
163
ResolveOrderPosition(VehicleID vehicle_id,OrderPosition order_position)164 /* static */ ScriptOrder::OrderPosition ScriptOrder::ResolveOrderPosition(VehicleID vehicle_id, OrderPosition order_position)
165 {
166 if (!ScriptVehicle::IsValidVehicle(vehicle_id)) return ORDER_INVALID;
167
168 int num_manual_orders = ::Vehicle::Get(vehicle_id)->GetNumManualOrders();
169 if (num_manual_orders == 0) return ORDER_INVALID;
170
171 if (order_position == ORDER_CURRENT) {
172 int cur_order_pos = ::Vehicle::Get(vehicle_id)->cur_real_order_index;
173 const Order *order = ::Vehicle::Get(vehicle_id)->GetFirstOrder();
174 int num_implicit_orders = 0;
175 for (int i = 0; i < cur_order_pos; i++) {
176 if (order->GetType() == OT_IMPLICIT) num_implicit_orders++;
177 order = order->next;
178 }
179 int real_order_pos = cur_order_pos - num_implicit_orders;
180 assert(real_order_pos < num_manual_orders);
181 return (ScriptOrder::OrderPosition)real_order_pos;
182 }
183 return (order_position >= 0 && order_position < num_manual_orders) ? order_position : ORDER_INVALID;
184 }
185
186
AreOrderFlagsValid(TileIndex destination,ScriptOrderFlags order_flags)187 /* static */ bool ScriptOrder::AreOrderFlagsValid(TileIndex destination, ScriptOrderFlags order_flags)
188 {
189 OrderType ot = (order_flags & OF_GOTO_NEAREST_DEPOT) ? OT_GOTO_DEPOT : ::GetOrderTypeByTile(destination);
190 switch (ot) {
191 case OT_GOTO_STATION:
192 return (order_flags & ~(OF_NON_STOP_FLAGS | OF_UNLOAD_FLAGS | OF_LOAD_FLAGS)) == 0 &&
193 /* Test the different mutual exclusive flags. */
194 ((order_flags & OF_TRANSFER) == 0 || (order_flags & OF_UNLOAD) == 0) &&
195 ((order_flags & OF_TRANSFER) == 0 || (order_flags & OF_NO_UNLOAD) == 0) &&
196 ((order_flags & OF_UNLOAD) == 0 || (order_flags & OF_NO_UNLOAD) == 0) &&
197 ((order_flags & OF_UNLOAD) == 0 || (order_flags & OF_NO_UNLOAD) == 0) &&
198 ((order_flags & OF_NO_UNLOAD) == 0 || (order_flags & OF_NO_LOAD) == 0) &&
199 ((order_flags & OF_FULL_LOAD_ANY) == 0 || (order_flags & OF_NO_LOAD) == 0);
200
201 case OT_GOTO_DEPOT:
202 return (order_flags & ~(OF_NON_STOP_FLAGS | OF_DEPOT_FLAGS)) == 0 &&
203 ((order_flags & OF_SERVICE_IF_NEEDED) == 0 || (order_flags & OF_STOP_IN_DEPOT) == 0);
204
205 case OT_GOTO_WAYPOINT: return (order_flags & ~(OF_NON_STOP_FLAGS)) == 0;
206 default: return false;
207 }
208 }
209
IsValidConditionalOrder(OrderCondition condition,CompareFunction compare)210 /* static */ bool ScriptOrder::IsValidConditionalOrder(OrderCondition condition, CompareFunction compare)
211 {
212 switch (condition) {
213 case OC_LOAD_PERCENTAGE:
214 case OC_RELIABILITY:
215 case OC_MAX_RELIABILITY:
216 case OC_MAX_SPEED:
217 case OC_AGE:
218 case OC_REMAINING_LIFETIME:
219 return compare >= CF_EQUALS && compare <= CF_MORE_EQUALS;
220
221 case OC_REQUIRES_SERVICE:
222 return compare == CF_IS_TRUE || compare == CF_IS_FALSE;
223
224 case OC_UNCONDITIONALLY:
225 return true;
226
227 default: return false;
228 }
229 }
230
GetOrderCount(VehicleID vehicle_id)231 /* static */ int32 ScriptOrder::GetOrderCount(VehicleID vehicle_id)
232 {
233 return ScriptVehicle::IsValidVehicle(vehicle_id) ? ::Vehicle::Get(vehicle_id)->GetNumManualOrders() : -1;
234 }
235
GetOrderDestination(VehicleID vehicle_id,OrderPosition order_position)236 /* static */ TileIndex ScriptOrder::GetOrderDestination(VehicleID vehicle_id, OrderPosition order_position)
237 {
238 if (!IsValidVehicleOrder(vehicle_id, order_position)) return INVALID_TILE;
239
240 const Order *order = ::ResolveOrder(vehicle_id, order_position);
241 if (order == nullptr || order->GetType() == OT_CONDITIONAL) return INVALID_TILE;
242 const Vehicle *v = ::Vehicle::Get(vehicle_id);
243
244 switch (order->GetType()) {
245 case OT_GOTO_DEPOT: {
246 /* We don't know where the nearest depot is... (yet) */
247 if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) return INVALID_TILE;
248
249 if (v->type != VEH_AIRCRAFT) return ::Depot::Get(order->GetDestination())->xy;
250 /* Aircraft's hangars are referenced by StationID, not DepotID */
251 const Station *st = ::Station::Get(order->GetDestination());
252 if (!st->airport.HasHangar()) return INVALID_TILE;
253 return st->airport.GetHangarTile(0);
254 }
255
256 case OT_GOTO_STATION: {
257 const Station *st = ::Station::Get(order->GetDestination());
258 if (st->train_station.tile != INVALID_TILE) {
259 for (TileIndex t : st->train_station) {
260 if (st->TileBelongsToRailStation(t)) return t;
261 }
262 } else if (st->ship_station.tile != INVALID_TILE) {
263 for (TileIndex t : st->ship_station) {
264 if (IsTileType(t, MP_STATION) && (IsDock(t) || IsOilRig(t)) && GetStationIndex(t) == st->index) return t;
265 }
266 } else if (st->bus_stops != nullptr) {
267 return st->bus_stops->xy;
268 } else if (st->truck_stops != nullptr) {
269 return st->truck_stops->xy;
270 } else if (st->airport.tile != INVALID_TILE) {
271 for (TileIndex tile : st->airport) {
272 if (st->TileBelongsToAirport(tile) && !::IsHangar(tile)) return tile;
273 }
274 }
275 return INVALID_TILE;
276 }
277
278 case OT_GOTO_WAYPOINT: {
279 const Waypoint *wp = ::Waypoint::Get(order->GetDestination());
280 if (wp->train_station.tile != INVALID_TILE) {
281 for (TileIndex t : wp->train_station) {
282 if (wp->TileBelongsToRailStation(t)) return t;
283 }
284 }
285 /* If the waypoint has no rail waypoint tiles, it must have a buoy */
286 return wp->xy;
287 }
288 default: return INVALID_TILE;
289 }
290 }
291
GetOrderFlags(VehicleID vehicle_id,OrderPosition order_position)292 /* static */ ScriptOrder::ScriptOrderFlags ScriptOrder::GetOrderFlags(VehicleID vehicle_id, OrderPosition order_position)
293 {
294 if (!IsValidVehicleOrder(vehicle_id, order_position)) return OF_INVALID;
295
296 const Order *order = ::ResolveOrder(vehicle_id, order_position);
297 if (order == nullptr || order->GetType() == OT_CONDITIONAL || order->GetType() == OT_DUMMY) return OF_INVALID;
298
299 ScriptOrderFlags order_flags = OF_NONE;
300 order_flags |= (ScriptOrderFlags)order->GetNonStopType();
301 switch (order->GetType()) {
302 case OT_GOTO_DEPOT:
303 if (order->GetDepotOrderType() & ODTFB_SERVICE) order_flags |= OF_SERVICE_IF_NEEDED;
304 if (order->GetDepotActionType() & ODATFB_HALT) order_flags |= OF_STOP_IN_DEPOT;
305 if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) order_flags |= OF_GOTO_NEAREST_DEPOT;
306 break;
307
308 case OT_GOTO_STATION:
309 order_flags |= (ScriptOrderFlags)(order->GetLoadType() << 5);
310 order_flags |= (ScriptOrderFlags)(order->GetUnloadType() << 2);
311 break;
312
313 default: break;
314 }
315
316 return order_flags;
317 }
318
GetOrderJumpTo(VehicleID vehicle_id,OrderPosition order_position)319 /* static */ ScriptOrder::OrderPosition ScriptOrder::GetOrderJumpTo(VehicleID vehicle_id, OrderPosition order_position)
320 {
321 if (!IsValidVehicleOrder(vehicle_id, order_position)) return ORDER_INVALID;
322 if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return ORDER_INVALID;
323
324 const Order *order = ::ResolveOrder(vehicle_id, order_position);
325 return (OrderPosition)order->GetConditionSkipToOrder();
326 }
327
GetOrderCondition(VehicleID vehicle_id,OrderPosition order_position)328 /* static */ ScriptOrder::OrderCondition ScriptOrder::GetOrderCondition(VehicleID vehicle_id, OrderPosition order_position)
329 {
330 if (!IsValidVehicleOrder(vehicle_id, order_position)) return OC_INVALID;
331 if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return OC_INVALID;
332
333 const Order *order = ::ResolveOrder(vehicle_id, order_position);
334 return (OrderCondition)order->GetConditionVariable();
335 }
336
GetOrderCompareFunction(VehicleID vehicle_id,OrderPosition order_position)337 /* static */ ScriptOrder::CompareFunction ScriptOrder::GetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position)
338 {
339 if (!IsValidVehicleOrder(vehicle_id, order_position)) return CF_INVALID;
340 if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return CF_INVALID;
341
342 const Order *order = ::ResolveOrder(vehicle_id, order_position);
343 return (CompareFunction)order->GetConditionComparator();
344 }
345
GetOrderCompareValue(VehicleID vehicle_id,OrderPosition order_position)346 /* static */ int32 ScriptOrder::GetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position)
347 {
348 if (!IsValidVehicleOrder(vehicle_id, order_position)) return -1;
349 if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return -1;
350
351 const Order *order = ::ResolveOrder(vehicle_id, order_position);
352 int32 value = order->GetConditionValue();
353 if (order->GetConditionVariable() == OCV_MAX_SPEED) value = value * 16 / 10;
354 return value;
355 }
356
GetStopLocation(VehicleID vehicle_id,OrderPosition order_position)357 /* static */ ScriptOrder::StopLocation ScriptOrder::GetStopLocation(VehicleID vehicle_id, OrderPosition order_position)
358 {
359 if (!IsValidVehicleOrder(vehicle_id, order_position)) return STOPLOCATION_INVALID;
360 if (ScriptVehicle::GetVehicleType(vehicle_id) != ScriptVehicle::VT_RAIL) return STOPLOCATION_INVALID;
361 if (!IsGotoStationOrder(vehicle_id, order_position)) return STOPLOCATION_INVALID;
362
363 const Order *order = ::ResolveOrder(vehicle_id, order_position);
364 return (ScriptOrder::StopLocation)order->GetStopLocation();
365 }
366
GetOrderRefit(VehicleID vehicle_id,OrderPosition order_position)367 /* static */ CargoID ScriptOrder::GetOrderRefit(VehicleID vehicle_id, OrderPosition order_position)
368 {
369 if (!IsValidVehicleOrder(vehicle_id, order_position)) return CT_NO_REFIT;
370 if (order_position != ORDER_CURRENT && !IsGotoStationOrder(vehicle_id, order_position) && !IsGotoDepotOrder(vehicle_id, order_position)) return CT_NO_REFIT;
371
372 const Order *order = ::ResolveOrder(vehicle_id, order_position);
373 return order->IsRefit() ? order->GetRefitCargo() : (CargoID)CT_NO_REFIT;
374 }
375
SetOrderJumpTo(VehicleID vehicle_id,OrderPosition order_position,OrderPosition jump_to)376 /* static */ bool ScriptOrder::SetOrderJumpTo(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
377 {
378 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
379 EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
380 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to) && jump_to != ORDER_CURRENT);
381
382 return ScriptObject::DoCommand(0, vehicle_id | (order_position << 20), MOF_COND_DESTINATION | (jump_to << 4), CMD_MODIFY_ORDER);
383 }
384
SetOrderCondition(VehicleID vehicle_id,OrderPosition order_position,OrderCondition condition)385 /* static */ bool ScriptOrder::SetOrderCondition(VehicleID vehicle_id, OrderPosition order_position, OrderCondition condition)
386 {
387 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
388 EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
389 EnforcePrecondition(false, condition >= OC_LOAD_PERCENTAGE && condition <= OC_REMAINING_LIFETIME);
390
391 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
392 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_VARIABLE | (condition << 4), CMD_MODIFY_ORDER);
393 }
394
SetOrderCompareFunction(VehicleID vehicle_id,OrderPosition order_position,CompareFunction compare)395 /* static */ bool ScriptOrder::SetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position, CompareFunction compare)
396 {
397 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
398 EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
399 EnforcePrecondition(false, compare >= CF_EQUALS && compare <= CF_IS_FALSE);
400
401 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
402 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_COMPARATOR | (compare << 4), CMD_MODIFY_ORDER);
403 }
404
SetOrderCompareValue(VehicleID vehicle_id,OrderPosition order_position,int32 value)405 /* static */ bool ScriptOrder::SetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position, int32 value)
406 {
407 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
408 EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
409 EnforcePrecondition(false, value >= 0 && value < 2048);
410 if (GetOrderCondition(vehicle_id, order_position) == OC_MAX_SPEED) value = value * 10 / 16;
411
412 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
413 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_VALUE | (value << 4), CMD_MODIFY_ORDER);
414 }
415
SetStopLocation(VehicleID vehicle_id,OrderPosition order_position,StopLocation stop_location)416 /* static */ bool ScriptOrder::SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location)
417 {
418 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
419 EnforcePrecondition(false, ScriptVehicle::GetVehicleType(vehicle_id) == ScriptVehicle::VT_RAIL);
420 EnforcePrecondition(false, IsGotoStationOrder(vehicle_id, order_position));
421 EnforcePrecondition(false, stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR);
422
423 order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
424
425 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
426 uint32 p1 = vehicle_id | (order_pos << 20);
427 uint32 p2 = MOF_STOP_LOCATION | (stop_location << 4);
428 return ScriptObject::DoCommand(0, p1, p2, CMD_MODIFY_ORDER);
429 }
430
SetOrderRefit(VehicleID vehicle_id,OrderPosition order_position,CargoID refit_cargo)431 /* static */ bool ScriptOrder::SetOrderRefit(VehicleID vehicle_id, OrderPosition order_position, CargoID refit_cargo)
432 {
433 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
434 EnforcePrecondition(false, IsGotoStationOrder(vehicle_id, order_position) || (IsGotoDepotOrder(vehicle_id, order_position) && refit_cargo != CT_AUTO_REFIT));
435 EnforcePrecondition(false, ScriptCargo::IsValidCargo(refit_cargo) || refit_cargo == CT_AUTO_REFIT || refit_cargo == CT_NO_REFIT);
436
437 uint32 p1 = vehicle_id;
438 uint32 p2 = refit_cargo | ScriptOrderPositionToRealOrderPosition(vehicle_id, ScriptOrder::ResolveOrderPosition(vehicle_id, order_position)) << 16;
439 return ScriptObject::DoCommand(0, p1, p2, CMD_ORDER_REFIT);
440 }
441
AppendOrder(VehicleID vehicle_id,TileIndex destination,ScriptOrderFlags order_flags)442 /* static */ bool ScriptOrder::AppendOrder(VehicleID vehicle_id, TileIndex destination, ScriptOrderFlags order_flags)
443 {
444 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
445 EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));
446
447 return InsertOrder(vehicle_id, (ScriptOrder::OrderPosition)::Vehicle::Get(vehicle_id)->GetNumManualOrders(), destination, order_flags);
448 }
449
AppendConditionalOrder(VehicleID vehicle_id,OrderPosition jump_to)450 /* static */ bool ScriptOrder::AppendConditionalOrder(VehicleID vehicle_id, OrderPosition jump_to)
451 {
452 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
453 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to));
454
455 return InsertConditionalOrder(vehicle_id, (ScriptOrder::OrderPosition)::Vehicle::Get(vehicle_id)->GetNumManualOrders(), jump_to);
456 }
457
InsertOrder(VehicleID vehicle_id,OrderPosition order_position,TileIndex destination,ScriptOrder::ScriptOrderFlags order_flags)458 /* static */ bool ScriptOrder::InsertOrder(VehicleID vehicle_id, OrderPosition order_position, TileIndex destination, ScriptOrder::ScriptOrderFlags order_flags)
459 {
460 /* IsValidVehicleOrder is not good enough because it does not allow appending. */
461 if (order_position == ORDER_CURRENT) order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
462
463 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
464 EnforcePrecondition(false, order_position >= 0 && order_position <= ::Vehicle::Get(vehicle_id)->GetNumManualOrders());
465 EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));
466
467 Order order;
468 OrderType ot = (order_flags & OF_GOTO_NEAREST_DEPOT) ? OT_GOTO_DEPOT : ::GetOrderTypeByTile(destination);
469 switch (ot) {
470 case OT_GOTO_DEPOT: {
471 OrderDepotTypeFlags odtf = (OrderDepotTypeFlags)(ODTFB_PART_OF_ORDERS | ((order_flags & OF_SERVICE_IF_NEEDED) ? ODTFB_SERVICE : 0));
472 OrderDepotActionFlags odaf = (OrderDepotActionFlags)(ODATF_SERVICE_ONLY | ((order_flags & OF_STOP_IN_DEPOT) ? ODATFB_HALT : 0));
473 if (order_flags & OF_GOTO_NEAREST_DEPOT) odaf |= ODATFB_NEAREST_DEPOT;
474 OrderNonStopFlags onsf = (OrderNonStopFlags)((order_flags & OF_NON_STOP_INTERMEDIATE) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);
475 if (order_flags & OF_GOTO_NEAREST_DEPOT) {
476 order.MakeGoToDepot(0, odtf, onsf, odaf);
477 } else {
478 /* Check explicitly if the order is to a station (for aircraft) or
479 * to a depot (other vehicle types). */
480 if (::Vehicle::Get(vehicle_id)->type == VEH_AIRCRAFT) {
481 if (!::IsTileType(destination, MP_STATION)) return false;
482 order.MakeGoToDepot(::GetStationIndex(destination), odtf, onsf, odaf);
483 } else {
484 if (::IsTileType(destination, MP_STATION)) return false;
485 order.MakeGoToDepot(::GetDepotIndex(destination), odtf, onsf, odaf);
486 }
487 }
488 break;
489 }
490
491 case OT_GOTO_STATION:
492 order.MakeGoToStation(::GetStationIndex(destination));
493 order.SetLoadType((OrderLoadFlags)GB(order_flags, 5, 3));
494 order.SetUnloadType((OrderUnloadFlags)GB(order_flags, 2, 3));
495 order.SetStopLocation(OSL_PLATFORM_FAR_END);
496 break;
497
498 case OT_GOTO_WAYPOINT:
499 order.MakeGoToWaypoint(::GetStationIndex(destination));
500 break;
501
502 default:
503 return false;
504 }
505
506 order.SetNonStopType((OrderNonStopFlags)GB(order_flags, 0, 2));
507
508 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
509 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), order.Pack(), CMD_INSERT_ORDER);
510 }
511
InsertConditionalOrder(VehicleID vehicle_id,OrderPosition order_position,OrderPosition jump_to)512 /* static */ bool ScriptOrder::InsertConditionalOrder(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
513 {
514 /* IsValidVehicleOrder is not good enough because it does not allow appending. */
515 if (order_position == ORDER_CURRENT) order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
516
517 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
518 EnforcePrecondition(false, order_position >= 0 && order_position <= ::Vehicle::Get(vehicle_id)->GetNumManualOrders());
519 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to) && jump_to != ORDER_CURRENT);
520
521 Order order;
522 order.MakeConditional(jump_to);
523
524 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
525 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), order.Pack(), CMD_INSERT_ORDER);
526 }
527
RemoveOrder(VehicleID vehicle_id,OrderPosition order_position)528 /* static */ bool ScriptOrder::RemoveOrder(VehicleID vehicle_id, OrderPosition order_position)
529 {
530 order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
531
532 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
533
534 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
535 return ScriptObject::DoCommand(0, vehicle_id, order_pos, CMD_DELETE_ORDER);
536 }
537
SkipToOrder(VehicleID vehicle_id,OrderPosition next_order)538 /* static */ bool ScriptOrder::SkipToOrder(VehicleID vehicle_id, OrderPosition next_order)
539 {
540 next_order = ScriptOrder::ResolveOrderPosition(vehicle_id, next_order);
541
542 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, next_order));
543
544 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, next_order);
545 return ScriptObject::DoCommand(0, vehicle_id, order_pos, CMD_SKIP_TO_ORDER);
546 }
547
548 /**
549 * Callback handler as SetOrderFlags possibly needs multiple DoCommand calls
550 * to be able to set all order flags correctly. As we need to wait till the
551 * command has completed before we know the next bits to change we need to
552 * call the function multiple times. Each time it'll reduce the difference
553 * between the wanted and the current order.
554 * @param instance The script instance we are doing the callback for.
555 */
_DoCommandReturnSetOrderFlags(class ScriptInstance * instance)556 static void _DoCommandReturnSetOrderFlags(class ScriptInstance *instance)
557 {
558 ScriptObject::SetLastCommandRes(ScriptOrder::_SetOrderFlags());
559 ScriptInstance::DoCommandReturn(instance);
560 }
561
_SetOrderFlags()562 /* static */ bool ScriptOrder::_SetOrderFlags()
563 {
564 /* Make sure we don't go into an infinite loop */
565 int retry = ScriptObject::GetCallbackVariable(3) - 1;
566 if (retry < 0) {
567 Debug(script, 0, "Possible infinite loop in SetOrderFlags() detected");
568 return false;
569 }
570 ScriptObject::SetCallbackVariable(3, retry);
571
572 VehicleID vehicle_id = (VehicleID)ScriptObject::GetCallbackVariable(0);
573 OrderPosition order_position = (OrderPosition)ScriptObject::GetCallbackVariable(1);
574 ScriptOrderFlags order_flags = (ScriptOrderFlags)ScriptObject::GetCallbackVariable(2);
575
576 order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
577
578 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
579 EnforcePrecondition(false, AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_position), order_flags));
580
581 const Order *order = ::ResolveOrder(vehicle_id, order_position);
582 int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
583
584 ScriptOrderFlags current = GetOrderFlags(vehicle_id, order_position);
585
586 EnforcePrecondition(false, (order_flags & OF_GOTO_NEAREST_DEPOT) == (current & OF_GOTO_NEAREST_DEPOT));
587
588 if ((current & OF_NON_STOP_FLAGS) != (order_flags & OF_NON_STOP_FLAGS)) {
589 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & OF_NON_STOP_FLAGS) << 4 | MOF_NON_STOP, CMD_MODIFY_ORDER, nullptr, &::_DoCommandReturnSetOrderFlags);
590 }
591
592 switch (order->GetType()) {
593 case OT_GOTO_DEPOT:
594 if ((current & OF_DEPOT_FLAGS) != (order_flags & OF_DEPOT_FLAGS)) {
595 uint data = DA_ALWAYS_GO;
596 if (order_flags & OF_SERVICE_IF_NEEDED) data = DA_SERVICE;
597 if (order_flags & OF_STOP_IN_DEPOT) data = DA_STOP;
598 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (data << 4) | MOF_DEPOT_ACTION, CMD_MODIFY_ORDER, nullptr, &::_DoCommandReturnSetOrderFlags);
599 }
600 break;
601
602 case OT_GOTO_STATION:
603 if ((current & OF_UNLOAD_FLAGS) != (order_flags & OF_UNLOAD_FLAGS)) {
604 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & OF_UNLOAD_FLAGS) << 2 | MOF_UNLOAD, CMD_MODIFY_ORDER, nullptr, &::_DoCommandReturnSetOrderFlags);
605 }
606 if ((current & OF_LOAD_FLAGS) != (order_flags & OF_LOAD_FLAGS)) {
607 return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & OF_LOAD_FLAGS) >> 1 | MOF_LOAD, CMD_MODIFY_ORDER, nullptr, &::_DoCommandReturnSetOrderFlags);
608 }
609 break;
610
611 default: break;
612 }
613
614 assert(GetOrderFlags(vehicle_id, order_position) == order_flags);
615
616 return true;
617 }
618
SetOrderFlags(VehicleID vehicle_id,OrderPosition order_position,ScriptOrder::ScriptOrderFlags order_flags)619 /* static */ bool ScriptOrder::SetOrderFlags(VehicleID vehicle_id, OrderPosition order_position, ScriptOrder::ScriptOrderFlags order_flags)
620 {
621 ScriptObject::SetCallbackVariable(0, vehicle_id);
622 ScriptObject::SetCallbackVariable(1, order_position);
623 ScriptObject::SetCallbackVariable(2, order_flags);
624 /* In case another client(s) change orders at the same time we could
625 * end in an infinite loop. This stops that from happening ever. */
626 ScriptObject::SetCallbackVariable(3, 8);
627 return ScriptOrder::_SetOrderFlags();
628 }
629
MoveOrder(VehicleID vehicle_id,OrderPosition order_position_move,OrderPosition order_position_target)630 /* static */ bool ScriptOrder::MoveOrder(VehicleID vehicle_id, OrderPosition order_position_move, OrderPosition order_position_target)
631 {
632 order_position_move = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position_move);
633 order_position_target = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position_target);
634
635 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position_move));
636 EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position_target));
637 EnforcePrecondition(false, order_position_move != order_position_target);
638
639 int order_pos_move = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position_move);
640 int order_pos_target = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position_target);
641 return ScriptObject::DoCommand(0, vehicle_id, order_pos_move | (order_pos_target << 16), CMD_MOVE_ORDER);
642 }
643
CopyOrders(VehicleID vehicle_id,VehicleID main_vehicle_id)644 /* static */ bool ScriptOrder::CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
645 {
646 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
647 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(main_vehicle_id));
648
649 return ScriptObject::DoCommand(0, vehicle_id | CO_COPY << 30, main_vehicle_id, CMD_CLONE_ORDER);
650 }
651
ShareOrders(VehicleID vehicle_id,VehicleID main_vehicle_id)652 /* static */ bool ScriptOrder::ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
653 {
654 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
655 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(main_vehicle_id));
656
657 return ScriptObject::DoCommand(0, vehicle_id | CO_SHARE << 30, main_vehicle_id, CMD_CLONE_ORDER);
658 }
659
UnshareOrders(VehicleID vehicle_id)660 /* static */ bool ScriptOrder::UnshareOrders(VehicleID vehicle_id)
661 {
662 EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
663
664 return ScriptObject::DoCommand(0, vehicle_id | CO_UNSHARE << 30, 0, CMD_CLONE_ORDER);
665 }
666
GetOrderDistance(ScriptVehicle::VehicleType vehicle_type,TileIndex origin_tile,TileIndex dest_tile)667 /* static */ uint ScriptOrder::GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile)
668 {
669 if (vehicle_type == ScriptVehicle::VT_AIR) {
670 if (ScriptTile::IsStationTile(origin_tile)) {
671 Station *orig_station = ::Station::GetByTile(origin_tile);
672 if (orig_station != nullptr && orig_station->airport.tile != INVALID_TILE) origin_tile = orig_station->airport.tile;
673 }
674 if (ScriptTile::IsStationTile(dest_tile)) {
675 Station *dest_station = ::Station::GetByTile(dest_tile);
676 if (dest_station != nullptr && dest_station->airport.tile != INVALID_TILE) dest_tile = dest_station->airport.tile;
677 }
678
679 return ScriptMap::DistanceSquare(origin_tile, dest_tile);
680 } else {
681 return ScriptMap::DistanceManhattan(origin_tile, dest_tile);
682 }
683 }
684