getCargoIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|arg= global|= Arguments in MP
|version1= 1.26
|1.26|= Game version


____________________________________________________________________________________________
|arg= global


| Returns index of the unit in cargo. 0,1,2... or -1 if not in cargo. |DESCRIPTION=
|gr1= Object Manipulation
____________________________________________________________________________________________


| vehicle '''getCargoIndex''' unit |SYNTAX=
|descr= Returns index of the unit in cargo. -1 if not in cargo.


|p1= vehicle: [[Object]] |PARAMETER1=
|s1= vehicle [[getCargoIndex]] unit


|p2= unit: [[Object]] |PARAMETER2=
|p1= vehicle: [[Object]]


| [[Number]] |RETURNVALUE=
|p2= unit: [[Object]]
____________________________________________________________________________________________
 
|x1= <code>[[player]] [[moveInCargo]] heli;
[[hint]] [[str]] (heli [[getCargoIndex]] [[player]]);</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[moveInCargo]], [[assignAsCargoIndex]], [[emptyPositions]]|SEEALSO=
|r1= [[Number]]


|x1= <sqf>
player moveInCargo heli;
hint str (heli getCargoIndex player);
</sqf>
|seealso= [[moveInCargo]] [[assignAsCargoIndex]] [[emptyPositions]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

Arma 3 logo black.png1.26
GAGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=getCargoIndex&oldid=369168"