(svn r24584) -Doc: [Script] Improve API documentation.

2012-10-10 19:11:22 +00:00
parent dda3709c7e
commit dee2f39f99
4 changed files with 13 additions and 3 deletions
--- 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