script_order.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "../../stdafx.h"
00013 #include "script_order.hpp"
00014 #include "script_vehicle.hpp"
00015 #include "script_cargo.hpp"
00016 #include "script_map.hpp"
00017 #include "../script_instance.hpp"
00018 #include "../../debug.h"
00019 #include "../../vehicle_base.h"
00020 #include "../../roadstop_base.h"
00021 #include "../../depot_base.h"
00022 #include "../../station_base.h"
00023 #include "../../waypoint_base.h"
00024 
00030 static OrderType GetOrderTypeByTile(TileIndex t)
00031 {
00032   if (!::IsValidTile(t)) return OT_END;
00033 
00034   switch (::GetTileType(t)) {
00035     default: break;
00036     case MP_STATION:
00037       if (IsBuoy(t) || IsRailWaypoint(t)) return OT_GOTO_WAYPOINT;
00038       if (IsHangar(t)) return OT_GOTO_DEPOT;
00039       return OT_GOTO_STATION;
00040 
00041     case MP_WATER:   if (::IsShipDepot(t)) return OT_GOTO_DEPOT; break;
00042     case MP_ROAD:    if (::GetRoadTileType(t) == ROAD_TILE_DEPOT) return OT_GOTO_DEPOT; break;
00043     case MP_RAILWAY:
00044       if (IsRailDepot(t)) return OT_GOTO_DEPOT;
00045       break;
00046   }
00047 
00048   return OT_END;
00049 }
00050 
00051 /* static */ bool ScriptOrder::IsValidVehicleOrder(VehicleID vehicle_id, OrderPosition order_position)
00052 {
00053   return ScriptVehicle::IsValidVehicle(vehicle_id) && order_position >= 0 && (order_position < ::Vehicle::Get(vehicle_id)->GetNumManualOrders() || order_position == ORDER_CURRENT);
00054 }
00055 
00061 static const Order *ResolveOrder(VehicleID vehicle_id, ScriptOrder::OrderPosition order_position)
00062 {
00063   const Vehicle *v = ::Vehicle::Get(vehicle_id);
00064   if (order_position == ScriptOrder::ORDER_CURRENT) {
00065     const Order *order = &v->current_order;
00066     if (order->GetType() == OT_GOTO_DEPOT && !(order->GetDepotOrderType() & ODTFB_PART_OF_ORDERS)) return order;
00067     order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00068     if (order_position == ScriptOrder::ORDER_INVALID) return NULL;
00069   }
00070   const Order *order = v->orders.list->GetFirstOrder();
00071   while (order->GetType() == OT_IMPLICIT) order = order->next;
00072   while (order_position > 0) {
00073     order_position = (ScriptOrder::OrderPosition)(order_position - 1);
00074     order = order->next;
00075     while (order->GetType() == OT_IMPLICIT) order = order->next;
00076   }
00077   return order;
00078 }
00079 
00086 static int ScriptOrderPositionToRealOrderPosition(VehicleID vehicle_id, ScriptOrder::OrderPosition order_position)
00087 {
00088   const Vehicle *v = ::Vehicle::Get(vehicle_id);
00089   if (order_position == v->GetNumManualOrders()) return v->GetNumOrders();
00090 
00091   assert(ScriptOrder::IsValidVehicleOrder(vehicle_id, order_position));
00092 
00093   int res = (int)order_position;
00094   const Order *order = v->orders.list->GetFirstOrder();
00095   for (; order->GetType() == OT_IMPLICIT; order = order->next) res++;
00096   while (order_position > 0) {
00097     order_position = (ScriptOrder::OrderPosition)(order_position - 1);
00098     order = order->next;
00099     for (; order->GetType() == OT_IMPLICIT; order = order->next) res++;
00100   }
00101 
00102   return res;
00103 }
00104 
00105 /* static */ bool ScriptOrder::IsGotoStationOrder(VehicleID vehicle_id, OrderPosition order_position)
00106 {
00107   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00108 
00109   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00110   return order != NULL && order->GetType() == OT_GOTO_STATION;
00111 }
00112 
00113 /* static */ bool ScriptOrder::IsGotoDepotOrder(VehicleID vehicle_id, OrderPosition order_position)
00114 {
00115   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00116 
00117   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00118   return order != NULL && order->GetType() == OT_GOTO_DEPOT;
00119 }
00120 
00121 /* static */ bool ScriptOrder::IsGotoWaypointOrder(VehicleID vehicle_id, OrderPosition order_position)
00122 {
00123   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00124 
00125   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00126   return order != NULL && order->GetType() == OT_GOTO_WAYPOINT;
00127 }
00128 
00129 /* static */ bool ScriptOrder::IsConditionalOrder(VehicleID vehicle_id, OrderPosition order_position)
00130 {
00131   if (order_position == ORDER_CURRENT) return false;
00132   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00133 
00134   const Order *order = ::Vehicle::Get(vehicle_id)->GetOrder(ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position));
00135   return order->GetType() == OT_CONDITIONAL;
00136 }
00137 
00138 /* static */ bool ScriptOrder::IsVoidOrder(VehicleID vehicle_id, OrderPosition order_position)
00139 {
00140   if (order_position == ORDER_CURRENT) return false;
00141   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00142 
00143   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00144   return order->GetType() == OT_DUMMY;
00145 }
00146 
00147 /* static */ bool ScriptOrder::IsRefitOrder(VehicleID vehicle_id, OrderPosition order_position)
00148 {
00149   if (!IsValidVehicleOrder(vehicle_id, order_position)) return false;
00150 
00151   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00152   return order != NULL && order->IsRefit();
00153 }
00154 
00155 /* static */ bool ScriptOrder::IsCurrentOrderPartOfOrderList(VehicleID vehicle_id)
00156 {
00157   if (!ScriptVehicle::IsValidVehicle(vehicle_id)) return false;
00158   if (GetOrderCount(vehicle_id) == 0) return false;
00159 
00160   const Order *order = &::Vehicle::Get(vehicle_id)->current_order;
00161   if (order->GetType() != OT_GOTO_DEPOT) return true;
00162   return (order->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0;
00163 }
00164 
00165 /* static */ ScriptOrder::OrderPosition ScriptOrder::ResolveOrderPosition(VehicleID vehicle_id, OrderPosition order_position)
00166 {
00167   if (!ScriptVehicle::IsValidVehicle(vehicle_id)) return ORDER_INVALID;
00168 
00169   if (order_position == ORDER_CURRENT) {
00170     int cur_order_pos = ::Vehicle::Get(vehicle_id)->cur_real_order_index;
00171     const Order *order = ::Vehicle::Get(vehicle_id)->GetOrder(0);
00172     if (order == NULL) return ORDER_INVALID;
00173     int num_implicit_orders = 0;
00174     for (int i = 0; i < cur_order_pos; i++) {
00175       if (order->GetType() == OT_IMPLICIT) num_implicit_orders++;
00176       order = order->next;
00177     }
00178     return (ScriptOrder::OrderPosition)(cur_order_pos - num_implicit_orders);
00179   }
00180   return (order_position >= 0 && order_position < ::Vehicle::Get(vehicle_id)->GetNumManualOrders()) ? order_position : ORDER_INVALID;
00181 }
00182 
00183 
00184 /* static */ bool ScriptOrder::AreOrderFlagsValid(TileIndex destination, ScriptOrderFlags order_flags)
00185 {
00186   OrderType ot = (order_flags & AIOF_GOTO_NEAREST_DEPOT) ? OT_GOTO_DEPOT : ::GetOrderTypeByTile(destination);
00187   switch (ot) {
00188     case OT_GOTO_STATION:
00189       return (order_flags & ~(AIOF_NON_STOP_FLAGS | AIOF_UNLOAD_FLAGS | AIOF_LOAD_FLAGS)) == 0 &&
00190           /* Test the different mutual exclusive flags. */
00191           ((order_flags & AIOF_TRANSFER)      == 0 || (order_flags & AIOF_UNLOAD)    == 0) &&
00192           ((order_flags & AIOF_TRANSFER)      == 0 || (order_flags & AIOF_NO_UNLOAD) == 0) &&
00193           ((order_flags & AIOF_UNLOAD)        == 0 || (order_flags & AIOF_NO_UNLOAD) == 0) &&
00194           ((order_flags & AIOF_UNLOAD)        == 0 || (order_flags & AIOF_NO_UNLOAD) == 0) &&
00195           ((order_flags & AIOF_NO_UNLOAD)     == 0 || (order_flags & AIOF_NO_LOAD)   == 0) &&
00196           ((order_flags & AIOF_FULL_LOAD_ANY) == 0 || (order_flags & AIOF_NO_LOAD)   == 0);
00197 
00198     case OT_GOTO_DEPOT:
00199       return (order_flags & ~(AIOF_NON_STOP_FLAGS | AIOF_DEPOT_FLAGS)) == 0 &&
00200           ((order_flags & AIOF_SERVICE_IF_NEEDED) == 0 || (order_flags & AIOF_STOP_IN_DEPOT) == 0);
00201 
00202     case OT_GOTO_WAYPOINT: return (order_flags & ~(AIOF_NON_STOP_FLAGS)) == 0;
00203     default:               return false;
00204   }
00205 }
00206 
00207 /* static */ bool ScriptOrder::IsValidConditionalOrder(OrderCondition condition, CompareFunction compare)
00208 {
00209   switch (condition) {
00210     case OC_LOAD_PERCENTAGE:
00211     case OC_RELIABILITY:
00212     case OC_MAX_SPEED:
00213     case OC_AGE:
00214     case OC_REMAINING_LIFETIME:
00215       return compare >= CF_EQUALS && compare <= CF_MORE_EQUALS;
00216 
00217     case OC_REQUIRES_SERVICE:
00218       return compare == CF_IS_TRUE || compare == CF_IS_FALSE;
00219 
00220     case OC_UNCONDITIONALLY:
00221       return true;
00222 
00223     default: return false;
00224   }
00225 }
00226 
00227 /* static */ int32 ScriptOrder::GetOrderCount(VehicleID vehicle_id)
00228 {
00229   return ScriptVehicle::IsValidVehicle(vehicle_id) ? ::Vehicle::Get(vehicle_id)->GetNumManualOrders() : -1;
00230 }
00231 
00232 /* static */ TileIndex ScriptOrder::GetOrderDestination(VehicleID vehicle_id, OrderPosition order_position)
00233 {
00234   if (!IsValidVehicleOrder(vehicle_id, order_position)) return INVALID_TILE;
00235 
00236   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00237   if (order == NULL || order->GetType() == OT_CONDITIONAL) return INVALID_TILE;
00238   const Vehicle *v = ::Vehicle::Get(vehicle_id);
00239 
00240   switch (order->GetType()) {
00241     case OT_GOTO_DEPOT: {
00242       /* We don't know where the nearest depot is... (yet) */
00243       if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) return INVALID_TILE;
00244 
00245       if (v->type != VEH_AIRCRAFT) return ::Depot::Get(order->GetDestination())->xy;
00246       /* Aircraft's hangars are referenced by StationID, not DepotID */
00247       const Station *st = ::Station::Get(order->GetDestination());
00248       if (!st->airport.HasHangar()) return INVALID_TILE;
00249       return st->airport.GetHangarTile(0);
00250     }
00251 
00252     case OT_GOTO_STATION: {
00253       const Station *st = ::Station::Get(order->GetDestination());
00254       if (st->train_station.tile != INVALID_TILE) {
00255         TILE_AREA_LOOP(t, st->train_station) {
00256           if (st->TileBelongsToRailStation(t)) return t;
00257         }
00258       } else if (st->dock_tile != INVALID_TILE) {
00259         return st->dock_tile;
00260       } else if (st->bus_stops != NULL) {
00261         return st->bus_stops->xy;
00262       } else if (st->truck_stops != NULL) {
00263         return st->truck_stops->xy;
00264       } else if (st->airport.tile != INVALID_TILE) {
00265         TILE_AREA_LOOP(tile, st->airport) {
00266           if (st->TileBelongsToAirport(tile) && !::IsHangar(tile)) return tile;
00267         }
00268       }
00269       return INVALID_TILE;
00270     }
00271 
00272     case OT_GOTO_WAYPOINT: {
00273       const Waypoint *wp = ::Waypoint::Get(order->GetDestination());
00274       if (wp->train_station.tile != INVALID_TILE) {
00275         TILE_AREA_LOOP(t, wp->train_station) {
00276           if (wp->TileBelongsToRailStation(t)) return t;
00277         }
00278       }
00279       /* If the waypoint has no rail waypoint tiles, it must have a buoy */
00280       return wp->xy;
00281     }
00282     default:               return INVALID_TILE;
00283   }
00284 }
00285 
00286 /* static */ ScriptOrder::ScriptOrderFlags ScriptOrder::GetOrderFlags(VehicleID vehicle_id, OrderPosition order_position)
00287 {
00288   if (!IsValidVehicleOrder(vehicle_id, order_position)) return AIOF_INVALID;
00289 
00290   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00291   if (order == NULL || order->GetType() == OT_CONDITIONAL || order->GetType() == OT_DUMMY) return AIOF_INVALID;
00292 
00293   ScriptOrderFlags order_flags = AIOF_NONE;
00294   order_flags |= (ScriptOrderFlags)order->GetNonStopType();
00295   switch (order->GetType()) {
00296     case OT_GOTO_DEPOT:
00297       if (order->GetDepotOrderType() & ODTFB_SERVICE) order_flags |= AIOF_SERVICE_IF_NEEDED;
00298       if (order->GetDepotActionType() & ODATFB_HALT) order_flags |= AIOF_STOP_IN_DEPOT;
00299       if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) order_flags |= AIOF_GOTO_NEAREST_DEPOT;
00300       break;
00301 
00302     case OT_GOTO_STATION:
00303       order_flags |= (ScriptOrderFlags)(order->GetLoadType()   << 5);
00304       order_flags |= (ScriptOrderFlags)(order->GetUnloadType() << 2);
00305       break;
00306 
00307     default: break;
00308   }
00309 
00310   return order_flags;
00311 }
00312 
00313 /* static */ ScriptOrder::OrderPosition ScriptOrder::GetOrderJumpTo(VehicleID vehicle_id, OrderPosition order_position)
00314 {
00315   if (!IsValidVehicleOrder(vehicle_id, order_position)) return ORDER_INVALID;
00316   if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return ORDER_INVALID;
00317 
00318   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00319   return (OrderPosition)order->GetConditionSkipToOrder();
00320 }
00321 
00322 /* static */ ScriptOrder::OrderCondition ScriptOrder::GetOrderCondition(VehicleID vehicle_id, OrderPosition order_position)
00323 {
00324   if (!IsValidVehicleOrder(vehicle_id, order_position)) return OC_INVALID;
00325   if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return OC_INVALID;
00326 
00327   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00328   return (OrderCondition)order->GetConditionVariable();
00329 }
00330 
00331 /* static */ ScriptOrder::CompareFunction ScriptOrder::GetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position)
00332 {
00333   if (!IsValidVehicleOrder(vehicle_id, order_position)) return CF_INVALID;
00334   if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return CF_INVALID;
00335 
00336   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00337   return (CompareFunction)order->GetConditionComparator();
00338 }
00339 
00340 /* static */ int32 ScriptOrder::GetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position)
00341 {
00342   if (!IsValidVehicleOrder(vehicle_id, order_position)) return -1;
00343   if (order_position == ORDER_CURRENT || !IsConditionalOrder(vehicle_id, order_position)) return -1;
00344 
00345   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00346   int32 value = order->GetConditionValue();
00347   if (order->GetConditionVariable() == OCV_MAX_SPEED) value = value * 16 / 10;
00348   return value;
00349 }
00350 
00351 /* static */ ScriptOrder::StopLocation ScriptOrder::GetStopLocation(VehicleID vehicle_id, OrderPosition order_position)
00352 {
00353   if (!IsValidVehicleOrder(vehicle_id, order_position)) return STOPLOCATION_INVALID;
00354   if (ScriptVehicle::GetVehicleType(vehicle_id) != ScriptVehicle::VT_RAIL) return STOPLOCATION_INVALID;
00355   if (!IsGotoStationOrder(vehicle_id, order_position)) return STOPLOCATION_INVALID;
00356 
00357   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00358   return (ScriptOrder::StopLocation)order->GetStopLocation();
00359 }
00360 
00361 /* static */ CargoID ScriptOrder::GetOrderRefit(VehicleID vehicle_id, OrderPosition order_position)
00362 {
00363   if (!IsValidVehicleOrder(vehicle_id, order_position)) return CT_NO_REFIT;
00364   if (order_position != ORDER_CURRENT && !IsGotoStationOrder(vehicle_id, order_position) && !IsGotoDepotOrder(vehicle_id, order_position)) return CT_NO_REFIT;
00365 
00366   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00367   return order->IsRefit() ? order->GetRefitCargo() : (CargoID)CT_NO_REFIT;
00368 }
00369 
00370 /* static */ bool ScriptOrder::SetOrderJumpTo(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
00371 {
00372   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00373   EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
00374   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to) && jump_to != ORDER_CURRENT);
00375 
00376   return ScriptObject::DoCommand(0, vehicle_id | (order_position << 20), MOF_COND_DESTINATION | (jump_to << 4), CMD_MODIFY_ORDER);
00377 }
00378 
00379 /* static */ bool ScriptOrder::SetOrderCondition(VehicleID vehicle_id, OrderPosition order_position, OrderCondition condition)
00380 {
00381   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00382   EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
00383   EnforcePrecondition(false, condition >= OC_LOAD_PERCENTAGE && condition <= OC_REMAINING_LIFETIME);
00384 
00385   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00386   return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_VARIABLE | (condition << 4), CMD_MODIFY_ORDER);
00387 }
00388 
00389 /* static */ bool ScriptOrder::SetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position, CompareFunction compare)
00390 {
00391   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00392   EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
00393   EnforcePrecondition(false, compare >= CF_EQUALS && compare <= CF_IS_FALSE);
00394 
00395   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00396   return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_COMPARATOR | (compare << 4), CMD_MODIFY_ORDER);
00397 }
00398 
00399 /* static */ bool ScriptOrder::SetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position, int32 value)
00400 {
00401   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00402   EnforcePrecondition(false, order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position));
00403   EnforcePrecondition(false, value >= 0 && value < 2048);
00404   if (GetOrderCondition(vehicle_id, order_position) == OC_MAX_SPEED) value = value * 10 / 16;
00405 
00406   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00407   return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), MOF_COND_VALUE | (value << 4), CMD_MODIFY_ORDER);
00408 }
00409 
00410 /* static */ bool ScriptOrder::SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location)
00411 {
00412   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00413   EnforcePrecondition(false, ScriptVehicle::GetVehicleType(vehicle_id) == ScriptVehicle::VT_RAIL);
00414   EnforcePrecondition(false, IsGotoStationOrder(vehicle_id, order_position));
00415   EnforcePrecondition(false, stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR);
00416 
00417   order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00418 
00419   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00420   uint32 p1 = vehicle_id | (order_pos << 20);
00421   uint32 p2 = MOF_STOP_LOCATION | (stop_location << 4);
00422   return ScriptObject::DoCommand(0, p1, p2, CMD_MODIFY_ORDER);
00423 }
00424 
00425 /* static */ bool ScriptOrder::SetOrderRefit(VehicleID vehicle_id, OrderPosition order_position, CargoID refit_cargo)
00426 {
00427   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00428   EnforcePrecondition(false, IsGotoStationOrder(vehicle_id, order_position) || (IsGotoDepotOrder(vehicle_id, order_position) && refit_cargo != CT_AUTO_REFIT));
00429   EnforcePrecondition(false, ScriptCargo::IsValidCargo(refit_cargo) || refit_cargo == CT_AUTO_REFIT || refit_cargo == CT_NO_REFIT);
00430 
00431   uint32 p1 = vehicle_id;
00432   uint32 p2 = refit_cargo | ScriptOrderPositionToRealOrderPosition(vehicle_id, ScriptOrder::ResolveOrderPosition(vehicle_id, order_position)) << 16;
00433   return ScriptObject::DoCommand(0, p1, p2, CMD_ORDER_REFIT);
00434 }
00435 
00436 /* static */ bool ScriptOrder::AppendOrder(VehicleID vehicle_id, TileIndex destination, ScriptOrderFlags order_flags)
00437 {
00438   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00439   EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));
00440 
00441   return InsertOrder(vehicle_id, (ScriptOrder::OrderPosition)::Vehicle::Get(vehicle_id)->GetNumManualOrders(), destination, order_flags);
00442 }
00443 
00444 /* static */ bool ScriptOrder::AppendConditionalOrder(VehicleID vehicle_id, OrderPosition jump_to)
00445 {
00446   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00447   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to));
00448 
00449   return InsertConditionalOrder(vehicle_id, (ScriptOrder::OrderPosition)::Vehicle::Get(vehicle_id)->GetNumManualOrders(), jump_to);
00450 }
00451 
00452 /* static */ bool ScriptOrder::InsertOrder(VehicleID vehicle_id, OrderPosition order_position, TileIndex destination, ScriptOrder::ScriptOrderFlags order_flags)
00453 {
00454   /* IsValidVehicleOrder is not good enough because it does not allow appending. */
00455   if (order_position == ORDER_CURRENT) order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00456 
00457   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00458   EnforcePrecondition(false, order_position >= 0 && order_position <= ::Vehicle::Get(vehicle_id)->GetNumManualOrders());
00459   EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));
00460 
00461   Order order;
00462   OrderType ot = (order_flags & AIOF_GOTO_NEAREST_DEPOT) ? OT_GOTO_DEPOT : ::GetOrderTypeByTile(destination);
00463   switch (ot) {
00464     case OT_GOTO_DEPOT: {
00465       OrderDepotTypeFlags odtf = (OrderDepotTypeFlags)(ODTFB_PART_OF_ORDERS | ((order_flags & AIOF_SERVICE_IF_NEEDED) ? ODTFB_SERVICE : 0));
00466       OrderDepotActionFlags odaf = (OrderDepotActionFlags)(ODATF_SERVICE_ONLY | ((order_flags & AIOF_STOP_IN_DEPOT) ? ODATFB_HALT : 0));
00467       if (order_flags & AIOF_GOTO_NEAREST_DEPOT) odaf |= ODATFB_NEAREST_DEPOT;
00468       OrderNonStopFlags onsf = (OrderNonStopFlags)((order_flags & AIOF_NON_STOP_INTERMEDIATE) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);
00469       if (order_flags & AIOF_GOTO_NEAREST_DEPOT) {
00470         order.MakeGoToDepot(0, odtf, onsf, odaf);
00471       } else {
00472         /* Check explicitly if the order is to a station (for aircraft) or
00473          * to a depot (other vehicle types). */
00474         if (::Vehicle::Get(vehicle_id)->type == VEH_AIRCRAFT) {
00475           if (!::IsTileType(destination, MP_STATION)) return false;
00476           order.MakeGoToDepot(::GetStationIndex(destination), odtf, onsf, odaf);
00477         } else {
00478           if (::IsTileType(destination, MP_STATION)) return false;
00479           order.MakeGoToDepot(::GetDepotIndex(destination), odtf, onsf, odaf);
00480         }
00481       }
00482       break;
00483     }
00484 
00485     case OT_GOTO_STATION:
00486       order.MakeGoToStation(::GetStationIndex(destination));
00487       order.SetLoadType((OrderLoadFlags)GB(order_flags, 5, 3));
00488       order.SetUnloadType((OrderUnloadFlags)GB(order_flags, 2, 3));
00489       order.SetStopLocation(OSL_PLATFORM_FAR_END);
00490       break;
00491 
00492     case OT_GOTO_WAYPOINT:
00493       order.MakeGoToWaypoint(::GetStationIndex(destination));
00494       break;
00495 
00496     default:
00497       return false;
00498   }
00499 
00500   order.SetNonStopType((OrderNonStopFlags)GB(order_flags, 0, 2));
00501 
00502   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00503   return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), order.Pack(), CMD_INSERT_ORDER);
00504 }
00505 
00506 /* static */ bool ScriptOrder::InsertConditionalOrder(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to)
00507 {
00508   /* IsValidVehicleOrder is not good enough because it does not allow appending. */
00509   if (order_position == ORDER_CURRENT) order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00510 
00511   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00512   EnforcePrecondition(false, order_position >= 0 && order_position <= ::Vehicle::Get(vehicle_id)->GetNumManualOrders());
00513   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, jump_to) && jump_to != ORDER_CURRENT);
00514 
00515   Order order;
00516   order.MakeConditional(jump_to);
00517 
00518   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00519   return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), order.Pack(), CMD_INSERT_ORDER);
00520 }
00521 
00522 /* static */ bool ScriptOrder::RemoveOrder(VehicleID vehicle_id, OrderPosition order_position)
00523 {
00524   order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00525 
00526   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00527 
00528   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00529   return ScriptObject::DoCommand(0, vehicle_id, order_pos, CMD_DELETE_ORDER);
00530 }
00531 
00532 /* static */ bool ScriptOrder::SkipToOrder(VehicleID vehicle_id, OrderPosition next_order)
00533 {
00534   next_order = ScriptOrder::ResolveOrderPosition(vehicle_id, next_order);
00535 
00536   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, next_order));
00537 
00538   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, next_order);
00539   return ScriptObject::DoCommand(0, vehicle_id, order_pos, CMD_SKIP_TO_ORDER);
00540 }
00541 
00550 static void _DoCommandReturnSetOrderFlags(class ScriptInstance *instance)
00551 {
00552   ScriptObject::SetLastCommandRes(ScriptOrder::_SetOrderFlags());
00553   ScriptInstance::DoCommandReturn(instance);
00554 }
00555 
00556 /* static */ bool ScriptOrder::_SetOrderFlags()
00557 {
00558   /* Make sure we don't go into an infinite loop */
00559   int retry = ScriptObject::GetCallbackVariable(3) - 1;
00560   if (retry < 0) {
00561     DEBUG(script, 0, "Possible infinite loop in SetOrderFlags() detected");
00562     return false;
00563   }
00564   ScriptObject::SetCallbackVariable(3, retry);
00565 
00566   VehicleID vehicle_id = (VehicleID)ScriptObject::GetCallbackVariable(0);
00567   OrderPosition order_position = (OrderPosition)ScriptObject::GetCallbackVariable(1);
00568   ScriptOrderFlags order_flags = (ScriptOrderFlags)ScriptObject::GetCallbackVariable(2);
00569 
00570   order_position = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position);
00571 
00572   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position));
00573   EnforcePrecondition(false, AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_position), order_flags));
00574 
00575   const Order *order = ::ResolveOrder(vehicle_id, order_position);
00576   int order_pos = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position);
00577 
00578   ScriptOrderFlags current = GetOrderFlags(vehicle_id, order_position);
00579 
00580   EnforcePrecondition(false, (order_flags & AIOF_GOTO_NEAREST_DEPOT) == (current & AIOF_GOTO_NEAREST_DEPOT));
00581 
00582   if ((current & AIOF_NON_STOP_FLAGS) != (order_flags & AIOF_NON_STOP_FLAGS)) {
00583     return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & AIOF_NON_STOP_FLAGS) << 4 | MOF_NON_STOP, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
00584   }
00585 
00586   switch (order->GetType()) {
00587     case OT_GOTO_DEPOT:
00588       if ((current & AIOF_DEPOT_FLAGS) != (order_flags & AIOF_DEPOT_FLAGS)) {
00589         uint data = DA_ALWAYS_GO;
00590         if (order_flags & AIOF_SERVICE_IF_NEEDED) data = DA_SERVICE;
00591         if (order_flags & AIOF_STOP_IN_DEPOT) data = DA_STOP;
00592         return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (data << 4) | MOF_DEPOT_ACTION, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
00593       }
00594       break;
00595 
00596     case OT_GOTO_STATION:
00597       if ((current & AIOF_UNLOAD_FLAGS) != (order_flags & AIOF_UNLOAD_FLAGS)) {
00598         return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & AIOF_UNLOAD_FLAGS) << 2 | MOF_UNLOAD, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
00599       }
00600       if ((current & AIOF_LOAD_FLAGS) != (order_flags & AIOF_LOAD_FLAGS)) {
00601         return ScriptObject::DoCommand(0, vehicle_id | (order_pos << 20), (order_flags & AIOF_LOAD_FLAGS) >> 1 | MOF_LOAD, CMD_MODIFY_ORDER, NULL, &::_DoCommandReturnSetOrderFlags);
00602       }
00603       break;
00604 
00605     default: break;
00606   }
00607 
00608   assert(GetOrderFlags(vehicle_id, order_position) == order_flags);
00609 
00610   return true;
00611 }
00612 
00613 /* static */ bool ScriptOrder::SetOrderFlags(VehicleID vehicle_id, OrderPosition order_position, ScriptOrder::ScriptOrderFlags order_flags)
00614 {
00615   ScriptObject::SetCallbackVariable(0, vehicle_id);
00616   ScriptObject::SetCallbackVariable(1, order_position);
00617   ScriptObject::SetCallbackVariable(2, order_flags);
00618   /* In case another client(s) change orders at the same time we could
00619    * end in an infinite loop. This stops that from happening ever. */
00620   ScriptObject::SetCallbackVariable(3, 8);
00621   return ScriptOrder::_SetOrderFlags();
00622 }
00623 
00624 /* static */ bool ScriptOrder::MoveOrder(VehicleID vehicle_id, OrderPosition order_position_move, OrderPosition order_position_target)
00625 {
00626   order_position_move   = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position_move);
00627   order_position_target = ScriptOrder::ResolveOrderPosition(vehicle_id, order_position_target);
00628 
00629   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position_move));
00630   EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_position_target));
00631 
00632   int order_pos_move = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position_move);
00633   int order_pos_target = ScriptOrderPositionToRealOrderPosition(vehicle_id, order_position_target);
00634   return ScriptObject::DoCommand(0, vehicle_id, order_pos_move | (order_pos_target << 16), CMD_MOVE_ORDER);
00635 }
00636 
00637 /* static */ bool ScriptOrder::CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
00638 {
00639   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00640   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(main_vehicle_id));
00641 
00642   return ScriptObject::DoCommand(0, vehicle_id | CO_COPY << 30, main_vehicle_id, CMD_CLONE_ORDER);
00643 }
00644 
00645 /* static */ bool ScriptOrder::ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
00646 {
00647   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00648   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(main_vehicle_id));
00649 
00650   return ScriptObject::DoCommand(0, vehicle_id | CO_SHARE << 30, main_vehicle_id, CMD_CLONE_ORDER);
00651 }
00652 
00653 /* static */ bool ScriptOrder::UnshareOrders(VehicleID vehicle_id)
00654 {
00655   EnforcePrecondition(false, ScriptVehicle::IsValidVehicle(vehicle_id));
00656 
00657   return ScriptObject::DoCommand(0, vehicle_id | CO_UNSHARE << 30, 0, CMD_CLONE_ORDER);
00658 }
00659 
00660 /* static */ uint ScriptOrder::GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile)
00661 {
00662   if (vehicle_type == ScriptVehicle::VT_AIR) {
00663     if (ScriptTile::IsStationTile(origin_tile) && ::Station::Get(origin_tile)->airport.tile != INVALID_TILE) origin_tile = ::Station::Get(origin_tile)->airport.tile;
00664     if (ScriptTile::IsStationTile(dest_tile) && ::Station::Get(dest_tile)->airport.tile != INVALID_TILE) dest_tile = ::Station::Get(dest_tile)->airport.tile;
00665 
00666     return ScriptMap::DistanceSquare(origin_tile, dest_tile);
00667   } else {
00668     return ScriptMap::DistanceManhattan(origin_tile, dest_tile);
00669   }
00670 }