summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorplanetmaker <planetmaker@openttd.org>2012-10-09 20:37:20 +0000
committerplanetmaker <planetmaker@openttd.org>2012-10-09 20:37:20 +0000
commit60335b7b79976d91a28720b2d4e71484e3eabb74 (patch)
tree7446931af85a93f523b2e84b34cf561f3e0b1503
parentde770d75636e218c2d2540a160d7c698015c8de2 (diff)
downloadopenttd-60335b7b79976d91a28720b2d4e71484e3eabb74.tar.xz
(svn r24581) -Doc [FS#5318]: Indicate that the return value for script related order distances is the square of the distance
-rw-r--r--src/script/api/script_engine.hpp4
-rw-r--r--src/script/api/script_order.hpp3
-rw-r--r--src/script/api/script_vehicle.hpp4
3 files changed, 6 insertions, 5 deletions
diff --git a/src/script/api/script_engine.hpp b/src/script/api/script_engine.hpp
index 20938ea66..1fef5d612 100644
--- a/src/script/api/script_engine.hpp
+++ b/src/script/api/script_engine.hpp
@@ -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);
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);
diff --git a/src/script/api/script_vehicle.hpp b/src/script/api/script_vehicle.hpp
index 8206b46d8..de7c01603 100644
--- a/src/script/api/script_vehicle.hpp
+++ b/src/script/api/script_vehicle.hpp
@@ -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);