From 5c19668fdb3c1b77439bde1968a4075ac02a2b79 Mon Sep 17 00:00:00 2001 From: Charles Pigott Date: Sat, 15 Feb 2020 11:53:31 +0000 Subject: Doc: [Script] Add a note about how wagon connectivity works for scripts --- src/script/api/script_vehicle.hpp | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/script/api') diff --git a/src/script/api/script_vehicle.hpp b/src/script/api/script_vehicle.hpp index 4b8a4687a..3c242d56f 100644 --- a/src/script/api/script_vehicle.hpp +++ b/src/script/api/script_vehicle.hpp @@ -312,6 +312,10 @@ public: * @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 Unlike the GUI, wagons are not automatically attached to trains, + * only to existing free wagons. This means that BuildVehicle can sometimes + * return an ID indicating success, but IsValidVehicle check will + * fail. You should use MoveWagon to attach free wagons to trains. * @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. -- cgit v1.2.3-70-g09d2