setVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added unloading examples per https://forums.bistudio.com/topic/191678-vehicle-in-vehicle-transport-feedback/page-5#entry3056397)
m (format)
Line 19: Line 19:


|x1= Blackfish with no vehicle cargo loaded
|x1= Blackfish with no vehicle cargo loaded
<code>_success = blackfish setVehicleCargo offroad; //true
<code>_success = blackfish [[setVehicleCargo]] offroad; //true
</code> |= Example 1
</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________


|x2= Blackfish with full cargo already loaded
|x2= Blackfish with full cargo already loaded
<code>_success = blackfish setVehicleCargo offroad; //false
<code>_success = blackfish [[setVehicleCargo]] offroad; //false
</code> |= Example 2
</code> |= Example 2
__________________________
__________________________


|x3= Unload specific loaded vehicle
|x3= Unload specific loaded vehicle
<code>_success = objNull setVehicleCargo offroad;  
<code>_success = [[objNull]] [[setVehicleCargo]] offroad;  
</code> |= Example 3
</code> |= Example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


|x4= Unload all vehicles
|x4= Unload all vehicles
<code>_success = blackfish setVehicleCargo objNull;
<code>_success = blackfish [[setVehicleCargo]] [[objNull]];
</code> |= Example 4
</code> |= Example 4
__________________________________________________________________
__________________________________________________________________

Revision as of 05:19, 20 September 2016

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.
Multiplayer:
-
Groups:
Uncategorised

Syntax

Syntax:
vehicle setVehicleCargo cargo
Parameters:
vehicle: Object
cargo: Object
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

Bottom Section

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"