getVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added locality)
m (template:command argument fix)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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. |= 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. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[getVehicleCargo]] storingVehicle |= Syntax
| [[getVehicleCargo]] storingVehicle |SYNTAX=


|p1= storingVehicle: [[Object]]  |= Parameter 1
|p1= storingVehicle: [[Object]]  |PARAMETER1=


| [[Array]] - vehicles loaded in storingVehicle, in order of their loading |= Return value
| [[Array]] - vehicles loaded in storingVehicle, in order of their loading |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_vehicleCargo = [[getVehicleCargo]] blackfish; {{codecomment|// returns [] if empty}}</code> |= Example 1
|x1= <code>_vehicleCargo = [[getVehicleCargo]] blackfish; {{codecomment|// returns [] if empty}}</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| [[Arma_3_Vehicle_in_Vehicle_Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]] |= See Also
| [[Arma_3_Vehicle_in_Vehicle_Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]] |SEEALSO=


}}
}}

Revision as of 14:40, 7 April 2019

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:
Uncategorised

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

Bottom Section