captiveNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
Line 30: Line 30:
|x1= <sqf>_captivity = captiveNum _unit;</sqf>
|x1= <sqf>_captivity = captiveNum _unit;</sqf>


|x2= <sqf>_unit setCaptive 1024;
|x2= <sqf>
_unit setCaptive 1024;
hint str captive _unit; // true
hint str captive _unit; // true
hint str captiveNum _unit; // 1024</sqf>
hint str captiveNum _unit; // 1024
</sqf>


|seealso= [[captive]] [[setCaptive]]
|seealso= [[captive]] [[setCaptive]]
}}
}}

Latest revision as of 19:42, 3 September 2024

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