captiveNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= ?\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Text replacement - "<code>_([a-zA-Z0-9_]+) = \[\[([a-zA-Z0-9]+)\]\] _([a-zA-Z0-9_]+);?<\/code>" to "<sqf>_$1 = $2 _$3;</sqf>")
Line 28: Line 28:
|r1= [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]].
|r1= [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]].


|x1= <code>_captivity = [[captiveNum]] _unit;</code>
|x1= <sqf>_captivity = captiveNum _unit;</sqf>


|x2= <code>_unit [[setCaptive]] 1024;
|x2= <code>_unit [[setCaptive]] 1024;

Revision as of 21:24, 7 May 2022

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:
Object ManipulationSides

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:
captive setCaptive

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