getVehicleCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "\[\[Arma( |_)3( |_)Vehicle( |_)in( |_)Vehicle( |_)Transport" to "[[Arma 3: Vehicle in Vehicle Transport")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|1.62|Game version=
|version1= 1.62


|arg= global |Multiplayer Arguments=
|arg= global


|eff= global |Multiplayer Effects=
|eff= global


|gr1= Vehicle in Vehicle Transport |GROUP1=
|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. |DESCRIPTION=
|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.
____________________________________________________________________________________________


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


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


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


|x1= <code>_vehicleCargo = [[getVehicleCargo]] blackfish; {{codecomment|// returns [] if empty}}</code> |EXAMPLE1=
|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> |EXAMPLE2=
|x2= <sqf>_vehicleCargo = getVehicleCargo blackfish; // returns [quad_3, quad_1, quad_2] as they were loaded in this order</sqf>
____________________________________________________________________________________________
 
| [[Arma_3_Vehicle_in_Vehicle_Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]] |SEEALSO=


|seealso= [[Arma 3: Vehicle in Vehicle Transport|Vehicle in Vehicle Transport]] [[canVehicleCargo]] [[setVehicleCargo]] [[enableVehicleCargo]] [[isVehicleCargo]] [[vehicleCargoEnabled]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
<!-- Appropriate categories go here -->
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|New Scripting Commands}}

Latest revision as of 13: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