From dee2f39f99c4bab5aedfbe5824722b57aa9da1d3 Mon Sep 17 00:00:00 2001 From: frosch Date: Wed, 10 Oct 2012 19:11:22 +0000 Subject: (svn r24584) -Doc: [Script] Improve API documentation. --- src/script/api/script_engine.hpp | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src/script/api/script_engine.hpp') diff --git a/src/script/api/script_engine.hpp b/src/script/api/script_engine.hpp index cd790cbf9..c5525baa2 100644 --- a/src/script/api/script_engine.hpp +++ b/src/script/api/script_engine.hpp @@ -255,6 +255,9 @@ public: /** * Get the maximum allowed distance between two orders for an engine. + * The distance returned is a vehicle-type specific distance indepenent from other + * map distances, you may use the result of this function to compare it + * with the result of ScriptOrder::GetOrderDistance. * @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 -- cgit v1.2.3-70-g09d2