captiveNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Text replacement - "|= Game version" to "|Game version=")
Line 4: Line 4:
| arma2 |= Game name
| arma2 |= Game name


|1.00|= Game version
|1.00|Game version=


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

Revision as of 02:27, 31 August 2019

Hover & click on the images for description

Description

Description:
Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead. If a unit's captivity level was set as a Boolean, then the returned number is either 0 (for false) or 1 (for true).
Groups:
Uncategorised

Syntax

Syntax:
captiveNum unit
Parameters:
unit: Object
Return Value:
Number - anything from 0 to value set by setCaptive alt syntax. A non zero value means captive.

Examples

Example 1:
_captivity = captiveNum _unit;
Example 2:
_unit setCaptive 1024; hint str captive _unit; //true hint str captiveNum _unit; //1024

Additional Information

See also:
captivesetCaptive

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