getCargoIndex: 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 - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


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


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


| vehicle '''getCargoIndex''' unit |SYNTAX=
| vehicle '''getCargoIndex''' unit |SYNTAX=
Line 19: Line 16:


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


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

Revision as of 02:13, 17 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

Notes

Bottom Section