Mercurial > hg > openttd
changeset 19463:130908738f14 draft
(svn r24366) -Doc: Improve description of ScriptVehicle::GetCargoLoad.
| author | frosch <frosch@openttd.org> |
|---|---|
| date | Sun, 01 Jul 2012 21:16:47 +0000 |
| parents | 2d863b09277f |
| children | 5de598a1870f |
| files | src/script/api/script_vehicle.hpp |
| diffstat | 1 files changed, 3 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/script/api/script_vehicle.hpp +++ b/src/script/api/script_vehicle.hpp @@ -506,12 +506,12 @@ 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 cargo The cargo to get the load amount for. + * @param cargo The cargo to get the loaded amount for. * @pre IsValidVehicle(vehicle_id). * @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);