dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: [Script] Add a note about how wagon connectivity works for scripts

Browse Source
This commit is contained in:
Charles Pigott
2020-02-15 11:53:31 +00:00
committed by Niels Martin Hansen
parent 4552b17691
commit 5c19668fdb
3 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/script/api/script_vehicle.hpp
View File

@@ -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.