diff options
author | planetmaker <planetmaker@openttd.org> | 2012-10-09 20:37:20 +0000 |
---|---|---|
committer | planetmaker <planetmaker@openttd.org> | 2012-10-09 20:37:20 +0000 |
commit | 60335b7b79976d91a28720b2d4e71484e3eabb74 (patch) | |
tree | 7446931af85a93f523b2e84b34cf561f3e0b1503 /src/script/api/script_order.hpp | |
parent | de770d75636e218c2d2540a160d7c698015c8de2 (diff) | |
download | openttd-60335b7b79976d91a28720b2d4e71484e3eabb74.tar.xz |
(svn r24581) -Doc [FS#5318]: Indicate that the return value for script related order distances is the square of the distance
Diffstat (limited to 'src/script/api/script_order.hpp')
-rw-r--r-- | src/script/api/script_order.hpp | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/script/api/script_order.hpp b/src/script/api/script_order.hpp index 63607fb2c..cf925a128 100644 --- a/src/script/api/script_order.hpp +++ b/src/script/api/script_order.hpp @@ -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); |