(svn r15307) -Fix: AIVehicle::GetCurrentSpeed() should also use km-ish/h instead of mph. (Documentation by Rubidium)

2009-02-01 16:21:18 +00:00
parent 9c2ba4f96a
commit be395d0f3d
5 changed files with 14 additions and 5 deletions
--- 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);