captiveNum (VBS2)

From Bohemia Interactive Community

Jump to: navigation, search
Editors, please check Policy: Scripting Command Page Syntax.
Introduced in Virtual Battlespace 2 version 1.22

Click on the images for descriptions

Introduced in

Game:
Virtual Battlespace 2
Version:
1.22

Description

Description:
Returns a unit's captivity status, as defined by setCaptive.

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

Examples

Example 1:
_captivity = captiveNum _unit

Additional Information

Multiplayer:
Behaviour unknown.
See also:
setCaptive

Notes

Notes

+ Add Note

Only post proven facts here. Use the talk page or the forums for discussions.

Notes

Bottom Section

Personal tools
Buy ArmA now!