(svn r9501) [NoAI] -Add: document that you can't assign orders to a vehicle build in test-mode noai
authortruelight
Tue, 27 Mar 2007 11:56:05 +0000
branchnoai
changeset 9563 2c0a7ea15d4c
parent 9562 2f4087d63527
child 9564 cd02879048c9
(svn r9501) [NoAI] -Add: document that you can't assign orders to a vehicle build in test-mode
src/ai/api/ai_vehicle.hpp
--- a/src/ai/api/ai_vehicle.hpp	Tue Mar 27 11:55:16 2007 +0000
+++ b/src/ai/api/ai_vehicle.hpp	Tue Mar 27 11:56:05 2007 +0000
@@ -56,6 +56,9 @@
 	 * @return the VehicleID of the new vehicle, or an invalid VehicleID when
 	 *   it failed. Check the return value using IsValidVehicle. In test-mode
 	 *   0 is returned if it was successful; any other value indicates failure.
+	 * @note in test-mode it means you can't assign orders yet to this vehicle,
+	 *   as the vehicle isn't really built yet. Build it for real first before
+	 *   assigning orders.
 	 */
 	VehicleID BuildVehicle(TileIndex depot, EngineID engine_id);