From e0529d486100ac37edb7a5a9ec2f8b2f5783ed78 Mon Sep 17 00:00:00 2001 From: planetmaker Date: Tue, 9 Oct 2012 20:59:29 +0000 Subject: (svn r24582) -Fix (r24581): Order distances are not supposed to be compared to map distances --- src/script/api/script_engine.hpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (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 1fef5d612..cd790cbf9 100644 --- a/src/script/api/script_engine.hpp +++ b/src/script/api/script_engine.hpp @@ -257,8 +257,10 @@ 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 square of the maximum distance between two orders for - * the engine or 0 if the distance is unlimited. + * @return The maximum distance between two orders for the engine + * or 0 if the distance is unlimited. + * @note The unit of the order distances is unspecified and should + * not be compared with map distances * @see ScriptOrder::GetOrderDistance */ static uint GetMaximumOrderDistance(EngineID engine_id); -- cgit v1.2.3-70-g09d2