getCargoIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command
 
|game1= arma3
|version1= 1.26


| arma3
|arg= global
|arg= global
|1.26


|gr1= Object Manipulation
|gr1= Object Manipulation


| Returns index of the unit in cargo. 0,1,2... or -1 if not in cargo.
|descr= Returns index of the unit in cargo. -1 if not in cargo.


| vehicle '''getCargoIndex''' unit
|s1= vehicle [[getCargoIndex]] unit


|p1= vehicle: [[Object]]
|p1= vehicle: [[Object]]
Line 15: Line 16:
|p2= unit: [[Object]]
|p2= unit: [[Object]]


| [[Number]]
|r1= [[Number]]
 
|x1= <code>[[player]] [[moveInCargo]] heli;
[[hint]] [[str]] (heli [[getCargoIndex]] [[player]]);</code>


| [[moveInCargo]], [[assignAsCargoIndex]], [[emptyPositions]]
|x1= <sqf>
player moveInCargo heli;
hint str (heli getCargoIndex player);
</sqf>


|seealso= [[moveInCargo]] [[assignAsCargoIndex]] [[emptyPositions]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Returns index of the unit in cargo. -1 if not in cargo.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle getCargoIndex unit
Parameters:
vehicle: Object
unit: Object
Return Value:
Number

Examples

Example 1:
player moveInCargo heli; hint str (heli getCargoIndex player);

Additional Information

See also:
moveInCargo assignAsCargoIndex emptyPositions

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