(svn r24582) -Fix (r24581): Order distances are not supposed to be compared to map distances

This commit is contained in:
planetmaker
2012-10-09 20:59:29 +00:00
parent 60335b7b79
commit e0529d4861
3 changed files with 12 additions and 6 deletions

View File

@@ -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);