summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_vehicle.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/ai/api/ai_vehicle.hpp')
-rw-r--r--src/ai/api/ai_vehicle.hpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/ai/api/ai_vehicle.hpp b/src/ai/api/ai_vehicle.hpp
index f0be433da..961a451d3 100644
--- a/src/ai/api/ai_vehicle.hpp
+++ b/src/ai/api/ai_vehicle.hpp
@@ -205,7 +205,9 @@ public:
* @param vehicle_id The vehicle to get the age of.
* @pre IsValidVehicle(vehicle_id).
* @return The current speed of the vehicle.
- * @note 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 GetCurrentSpeed(VehicleID vehicle_id);