Archives/OpenTTD-patches
2
0
Fork 0
mirror of https://github.com/JGRennison/OpenTTD-patches.git synced 2024-11-11 13:10:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r24581) -Doc [FS#5318]: Indicate that the return value for script related order distances is the square of the distance

Browse Source
This commit is contained in:
planetmaker 2012-10-09 20:37:20 +00:00
parent de770d7563
commit 60335b7b79
3 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/script/api/script_engine.hpp
View File

@ -257,8 +257,8 @@ public:
* Get the maximum allowed distance between two orders for an engine.
* @param engine_id The engine to get the max distance for.
* @pre IsValidEngine(engine_id).
* @return The maximum distance between two orders for the engine
* or 0 if the distance is unlimited.
* @return The square of the maximum distance between two orders for
* the engine or 0 if the distance is unlimited.
* @see ScriptOrder::GetOrderDistance
*/
static uint GetMaximumOrderDistance(EngineID engine_id);

3
src/script/api/script_order.hpp
View File

@ -588,7 +588,8 @@ public:
* @param vehicle_type The vehicle type to get the distance for.
* @param origin_tile Origin, can be any tile or a tile of a specific station.
* @param dest_tile Destination, ca be any tile or a tile of a specific station.
* @return The distance between the origin and the destination for a vehicle of the given vehicle type.
* @return The square of the distance between the origin and the
* destination for a vehicle of the given vehicle type.
* @see ScriptEngine::GetMaximumOrderDistance and ScriptVehicle::GetMaximumOrderDistance
*/
static uint GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile);

4
src/script/api/script_vehicle.hpp
View File

@ -551,8 +551,8 @@ public:
* Get the maximum allowed distance between two orders for a vehicle.
* @param vehicle_id The vehicle to get the distance for.
* @pre IsValidVehicle(vehicle_id).
* @return The maximum distance between two orders for this vehicle
* or 0 if the distance is unlimited.
* @return The square of the maximum distance between two orders for
* this vehicle or 0 if the distance is unlimited.
* @see ScriptOrder::GetOrderDistance
*/
static uint GetMaximumOrderDistance(VehicleID vehicle_id);