summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_engine.hpp
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2009-02-01 16:21:18 +0000
committerfrosch <frosch@openttd.org>2009-02-01 16:21:18 +0000
commit317220c2e4f9d0866553635872cae952616169dc (patch)
tree3e031958b4536d4964ee63d7681995cc7d84008a /src/ai/api/ai_engine.hpp
parentc28c4c1986a9a25cbf67ed84c6ba3d51447bbb6f (diff)
downloadopenttd-317220c2e4f9d0866553635872cae952616169dc.tar.xz
(svn r15307) -Fix: AIVehicle::GetCurrentSpeed() should also use km-ish/h instead of mph. (Documentation by Rubidium)
Diffstat (limited to 'src/ai/api/ai_engine.hpp')
-rw-r--r--src/ai/api/ai_engine.hpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/ai/api/ai_engine.hpp b/src/ai/api/ai_engine.hpp
index 7e49558a1..6fe865327 100644
--- a/src/ai/api/ai_engine.hpp
+++ b/src/ai/api/ai_engine.hpp
@@ -91,7 +91,9 @@ public:
* @param engine_id The engine to get the maximum speed of.
* @pre IsValidEngine(engine_id).
* @return The maximum speed the engine has.
- * @note The speed is in km/h.
+ * @note The speed is in OpenTTD's internal speed unit.
+ * This is mph / 1.6, which is roughly km/h.
+ * To get km/h multiply this number by 1.00584.
*/
static int32 GetMaxSpeed(EngineID engine_id);