setVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - "<!-- Appropriate categories go here -->" to "")
Line 36: Line 36:
}}
}}


<!-- Appropriate categories go here -->
 


{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}

Revision as of 10:09, 18 January 2021

Hover & click on the images for description

Description

Description:
Load cargo vehicle inside vehicle if possible, returns bool based on whether the vehicle was able to be loaded. Can also be used to unload a specific loaded vehicle or all loaded vehicles.
Groups:
Vehicle in Vehicle Transport

Syntax

Syntax:
vehicle setVehicleCargo cargo
Parameters:
vehicle: Object - vehicle carrying cargo
cargo: Object - cargo to put in vehicle
Return Value:
Boolean - whether the vehicle was able to be loaded

Examples

Example 1:
Blackfish with no vehicle cargo loaded _success = blackfish setVehicleCargo offroad; //true
Example 2:
Blackfish with full cargo already loaded _success = blackfish setVehicleCargo offroad; //false
Example 3:
Unload specific loaded vehicle _success = objNull setVehicleCargo offroad;
Example 4:
Unload all vehicles _success = blackfish setVehicleCargo objNull;

Additional Information

See also:
Vehicle in Vehicle Transport canVehicleCargo enableVehicleCargo getVehicleCargo isVehicleCargo vehicleCargoEnabled

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Posted on July 4, 2016 - 18:46 (UTC)
ImperialAlex
From biforums: "objnull setVehicleCargo cargo vehicle - will unload specific loaded vehicle" and "transporting vehicle setVehicleCargo objnul - unload all vehicles"