getCargoIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
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...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3
|arg= global|Multiplayer Arguments=
|arg= global
|1.26|Game version=
|1.26


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation


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


| vehicle '''getCargoIndex''' unit |SYNTAX=
| vehicle '''getCargoIndex''' unit


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


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


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


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


}}
}}

Revision as of 00:33, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns index of the unit in cargo. 0,1,2... or -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:
moveInCargoassignAsCargoIndexemptyPositions

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