diff options
Diffstat (limited to 'src/script/api/script_order.hpp')
-rw-r--r-- | src/script/api/script_order.hpp | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/script/api/script_order.hpp b/src/script/api/script_order.hpp index 017ee3c91..eb301f50a 100644 --- a/src/script/api/script_order.hpp +++ b/src/script/api/script_order.hpp @@ -17,7 +17,7 @@ /** * Class that handles all order related functions. - * @api ai + * @api ai game */ class ScriptOrder : public ScriptObject { public: @@ -358,6 +358,7 @@ public: * @pre IsValidVehicleOrder(vehicle_id, jump_to). * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). * @return Whether the order has been/can be changed. + * @api -game */ static bool SetOrderJumpTo(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to); @@ -370,6 +371,7 @@ public: * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). * @pre condition >= OC_LOAD_PERCENTAGE && condition <= OC_UNCONDITIONALLY. * @return Whether the order has been/can be changed. + * @api -game */ static bool SetOrderCondition(VehicleID vehicle_id, OrderPosition order_position, OrderCondition condition); @@ -382,6 +384,7 @@ public: * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). * @pre compare >= CF_EQUALS && compare <= CF_IS_FALSE. * @return Whether the order has been/can be changed. + * @api -game */ static bool SetOrderCompareFunction(VehicleID vehicle_id, OrderPosition order_position, CompareFunction compare); @@ -394,6 +397,7 @@ public: * @pre order_position != ORDER_CURRENT && IsConditionalOrder(vehicle_id, order_position). * @pre value >= 0 && value < 2048. * @return Whether the order has been/can be changed. + * @api -game */ static bool SetOrderCompareValue(VehicleID vehicle_id, OrderPosition order_position, int32 value); @@ -407,6 +411,7 @@ public: * @pre IsGotoStationOrder(vehicle_id, order_position). * @pre stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR * @return Whether the order has been/can be changed. + * @api -game */ static bool SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location); @@ -419,6 +424,7 @@ public: * @pre IsGotoStationOrder(vehicle_id, order_position) || (IsGotoDepotOrder(vehicle_id, order_position) && refit_cargo != CT_AUTO_REFIT). * @pre ScriptCargo::IsValidCargo(refit_cargo) || refit_cargo == CT_AUTO_REFIT || refit_cargo == CT_NO_REFIT * @return Whether the order has been/can be changed. + * @api -game */ static bool SetOrderRefit(VehicleID vehicle_id, OrderPosition order_position, CargoID refit_cargo); @@ -433,6 +439,7 @@ public: * @exception ScriptOrder::ERR_ORDER_TOO_MANY * @exception ScriptOrder::ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION * @return True if and only if the order was appended. + * @api -game */ static bool AppendOrder(VehicleID vehicle_id, TileIndex destination, ScriptOrderFlags order_flags); @@ -445,6 +452,7 @@ public: * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @exception ScriptOrder::ERR_ORDER_TOO_MANY * @return True if and only if the order was appended. + * @api -game */ static bool AppendConditionalOrder(VehicleID vehicle_id, OrderPosition jump_to); @@ -460,6 +468,7 @@ public: * @exception ScriptOrder::ERR_ORDER_TOO_MANY * @exception ScriptOrder::ERR_ORDER_TOO_FAR_AWAY_FROM_PREVIOUS_DESTINATION * @return True if and only if the order was inserted. + * @api -game */ static bool InsertOrder(VehicleID vehicle_id, OrderPosition order_position, TileIndex destination, ScriptOrderFlags order_flags); @@ -473,6 +482,7 @@ public: * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @exception ScriptOrder::ERR_ORDER_TOO_MANY * @return True if and only if the order was inserted. + * @api -game */ static bool InsertConditionalOrder(VehicleID vehicle_id, OrderPosition order_position, OrderPosition jump_to); @@ -483,6 +493,7 @@ public: * @pre IsValidVehicleOrder(vehicle_id, order_position). * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return True if and only if the order was removed. + * @api -game */ static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position); @@ -502,6 +513,7 @@ public: * @pre (order_flags & AIOF_GOTO_NEAREST_DEPOT) == (GetOrderFlags(vehicle_id, order_position) & AIOF_GOTO_NEAREST_DEPOT). * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return True if and only if the order was changed. + * @api -game */ static bool SetOrderFlags(VehicleID vehicle_id, OrderPosition order_position, ScriptOrderFlags order_flags); @@ -518,6 +530,7 @@ public: * the target order is moved upwards (e.g. 3). If the order is moved * to a higher place (e.g. from 7 to 9) the target will be moved * downwards (e.g. 8). + * @api -game */ static bool MoveOrder(VehicleID vehicle_id, OrderPosition order_position_move, OrderPosition order_position_target); @@ -528,6 +541,7 @@ public: * @pre IsValidVehicleOrder(vehicle_id, next_order). * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return True if and only the current order was changed. + * @api -game */ static bool SkipToOrder(VehicleID vehicle_id, OrderPosition next_order); @@ -542,6 +556,7 @@ public: * @exception ScriptOrder::ERR_ORDER_TOO_MANY * @exception ScriptOrder::ERR_ORDER_AIRCRAFT_NOT_ENOUGH_RANGE * @return True if and only if the copying succeeded. + * @api -game */ static bool CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id); @@ -555,6 +570,7 @@ public: * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @exception ScriptOrder::ERR_ORDER_AIRCRAFT_NOT_ENOUGH_RANGE * @return True if and only if the sharing succeeded. + * @api -game */ static bool ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id); @@ -563,6 +579,7 @@ public: * @param vehicle_id The vehicle to remove from the shared order list. * @pre ScriptVehicle::IsValidVehicle(vehicle_id). * @return True if and only if the unsharing succeeded. + * @api -game */ static bool UnshareOrders(VehicleID vehicle_id); |