captiveNum: Difference between revisions

Latest revision as of 19:42, 3 September 2024

1.00

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 Manipulation Sides

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead. |= Description
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| '''captiveNum''' unit |= Syntax
+|game4= arma3
+|version4= 0.50
-|p1= unit:[[Object]] |= PARAMETER1
+|arg= global
-|p2= |= PARAMETER2
+|gr1= Object Manipulation
-|p3= |= PARAMETER3
+|gr2= Sides
-| |= RETURNVALUE
+|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
-|x1= <code>(example)</code>|= EXAMPLE1
+|p1= unit: [[Object]]
-____________________________________________________________________________________________
+|r1= [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]].
-| [[captive]] |= SEEALSO
+|x1= <sqf>_captivity = captiveNum _unit;</sqf>
-|  |= MPBEHAVIOUR
+|x2= <sqf>
-____________________________________________________________________________________________
+_unit setCaptive 1024;
+hint str captive _unit; // true
+hint str captiveNum _unit; // 1024
+</sqf>
+|seealso= [[captive]] [[setCaptive]]
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
-[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]