diff options
| author | frosch <frosch@openttd.org> | 2012-10-10 19:11:22 +0000 |
|---|---|---|
| committer | frosch <frosch@openttd.org> | 2012-10-10 19:11:22 +0000 |
| commit | dee2f39f99c4bab5aedfbe5824722b57aa9da1d3 (patch) | |
| tree | 188bfda3954ac4f1587ba3c87c03e326064b89db /src/script/api/script_engine.hpp | |
| parent | dda3709c7ec8af0221bedafdbdde7a89097992ce (diff) | |
| download | openttd-dee2f39f99c4bab5aedfbe5824722b57aa9da1d3.tar.xz | |
(svn r24584) -Doc: [Script] Improve API documentation.
Diffstat (limited to 'src/script/api/script_engine.hpp')
| -rw-r--r-- | src/script/api/script_engine.hpp | 3 |
1 files changed, 3 insertions, 0 deletions
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 |