getVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma3 *\| *(New )?Scripting Commands\}\}" to "")
m (Text replacement - "\[\[Arma( |_)3( |_)Vehicle( |_)in( |_)Vehicle( |_)Transport" to "[[Arma 3: Vehicle in Vehicle Transport")
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
|1.62
|version1= 1.62


|arg= global
|arg= global
Line 10: Line 10:
|gr1= Vehicle in Vehicle Transport
|gr1= Vehicle in Vehicle Transport


| Get a list of vehicles loaded as cargo inside this vehicle. The returned array is in the order the cargo vehicles were added to containing vehicle.
|descr= Get a list of vehicles loaded as cargo inside this vehicle. The returned array is in the order the cargo vehicles were added to containing vehicle.


|s1= [[getVehicleCargo]] storingVehicle
|s1= [[getVehicleCargo]] storingVehicle


|p1= storingVehicle: [[Object]]
|p1= storingVehicle: [[Object]]


|r1=[[Array]] - vehicles loaded in storingVehicle, in order of their loading
|r1= [[Array]] - vehicles loaded in storingVehicle, in order of their loading


|x1= <code>_vehicleCargo = [[getVehicleCargo]] blackfish; {{codecomment|// returns [] if empty}}</code>
|x1= <sqf>_vehicleCargo = getVehicleCargo blackfish; // returns [] if empty</sqf>


|x2= <code>_vehicleCargo = [[getVehicleCargo]] blackfish; {{codecomment|// returns [quad_3, quad_1, quad_2] as they were loaded in this order}}</code>
|x2= <sqf>_vehicleCargo = getVehicleCargo blackfish; // returns [quad_3, quad_1, quad_2] as they were loaded in this order</sqf>


|seealso= [[Arma_3_Vehicle_in_Vehicle_Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]]
|seealso= [[Arma 3: Vehicle in Vehicle Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]]
}}
}}

Latest revision as of 14:55, 14 August 2022

Hover & click on the images for description

Description

Description:
Get a list of vehicles loaded as cargo inside this vehicle. The returned array is in the order the cargo vehicles were added to containing vehicle.
Groups:
Vehicle in Vehicle Transport

Syntax

Syntax:
getVehicleCargo storingVehicle
Parameters:
storingVehicle: Object
Return Value:
Array - vehicles loaded in storingVehicle, in order of their loading

Examples

Example 1:
_vehicleCargo = getVehicleCargo blackfish; // returns [] if empty
Example 2:
_vehicleCargo = getVehicleCargo blackfish; // returns [quad_3, quad_1, quad_2] as they were loaded in this order

Additional Information

See also:
Vehicle in Vehicle Transport canVehicleCargo setVehicleCargo enableVehicleCargo 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