dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r24581) -Doc [FS#5318]: Indicate that the return value for script related order distances is the square of the distance

Browse Source
This commit is contained in:
planetmaker
2012-10-09 20:37:20 +00:00
parent de770d7563
commit 60335b7b79
3 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/script/api/script_engine.hpp
View File

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