captiveNum

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 2 version 1.00
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

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

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

Multiplayer:
-
See also:
captivesetCaptive

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section