captiveNum: Difference between revisions

Latest revision as of 19:42, 3 September 2024

Hover & click on the images for 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 Manipulation Sides

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.

Example 1:: _captivity = captiveNum _unit;
Example 2:: _unit setCaptive 1024; hint str captive _unit; // true hint str captiveNum _unit; // 1024

: 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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma2
+|game1= arma2
-|1.00
+|version1= 1.00
 |game2= arma2oa
@@ Line 19: / Line 19: @@
 |gr2= Sides
-| Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead.<br>
+|descr= Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead.<br>
 If a unit's captivity level was set as a [[Boolean]], then the returned number is either 0 (for [[false]]) or 1 (for [[true]]).
-|s1=  [[captiveNum]] unit
+|s1= [[captiveNum]] unit
 |p1= unit: [[Object]]
-|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= <sqf>
-[[hint]] [[str]] [[captive]] _unit; {{cc|true}}
+_unit setCaptive 1024;
-[[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code>
+hint str captive _unit; // true
+hint str captiveNum _unit; // 1024
+</sqf>
-|seealso= [[captive]], [[setCaptive]]
+|seealso= [[captive]] [[setCaptive]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}