captiveNum

Global argument
Arma 3 v0.50
First in Arma 2 v1.00

Command · also in Sides · Markdown · JSON · original wiki page

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).

Syntax

captiveNum unit

Parameters:

unit: Object

Returns: 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