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

src/ai/api/ai_bridge.hpp

@@ -60,10 +60,13 @@ public:
 	static char *GetName(BridgeID bridge_id);
 
 	/**
-	 * Get the maximum speed of a bridge (in km/h).
+	 * Get the maximum speed of a bridge.
 	 * @param bridge_id The bridge to get the maximum speed of.
 	 * @pre IsValidBridge(bridge_id).
 	 * @return The maximum speed the bridge has.
+	 * @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(BridgeID bridge_id);
 

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

src/ai/api/ai_event_types.hpp

@@ -240,7 +240,9 @@ public:
 	/**
 	 * Get the maximum speed of the offered engine.
 	 * @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.
 	 */
 	int32 GetMaxSpeed();
 

src/ai/api/ai_vehicle.cpp

@@ -278,7 +278,7 @@
 {
 	if (!IsValidVehicle(vehicle_id)) return -1;
 
-	return ::GetVehicle(vehicle_id)->GetDisplaySpeed();
+	return ::GetVehicle(vehicle_id)->GetDisplaySpeed() * 16 / 10;
 }
 
 /* static */ AIVehicle::VehicleState AIVehicle::GetState(VehicleID vehicle_id)

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