mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r24366) -Doc: Improve description of ScriptVehicle::GetCargoLoad.

release/1.3
frosch 2012-07-01 21:16:47 +00:00
parent 66d14c50f1
commit a6244ed0dc
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -506,12 +506,12 @@ public:
static int GetLength(VehicleID vehicle_id); static int GetLength(VehicleID vehicle_id);
/** /**
* Get the amount of a specific cargo the given vehicle transports. * Get the amount of a specific cargo the given vehicle is transporting.
* @param vehicle_id The vehicle to get the load amount of. * @param vehicle_id The vehicle to get the load amount of.
* @param cargo The cargo to get the load amount for. * @param cargo The cargo to get the loaded amount for.
* @pre IsValidVehicle(vehicle_id). * @pre IsValidVehicle(vehicle_id).
* @pre ScriptCargo::IsValidCargo(cargo). * @pre ScriptCargo::IsValidCargo(cargo).
* @return The amount of the given cargo the vehicle currently transports. * @return The amount of the given cargo the vehicle is currently transporting.
*/ */
static int32 GetCargoLoad(VehicleID vehicle_id, CargoID cargo); static int32 GetCargoLoad(VehicleID vehicle_id, CargoID cargo);