captiveNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(39 intermediate revisions by 2 users not shown)
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


|arg= global|Multiplayer Arguments=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead.
|game4= arma3
|version4= 0.50


If a unit's captivity level was set as a [[Boolean]], then the returned number is either 0 (for [[false]]) or 1 (for [[true]]).
|arg= global
|DESCRIPTION=
____________________________________________________________________________________________


| '''captiveNum''' unit |SYNTAX=
|gr1= Object Manipulation


|p1= unit: [[Object]] |PARAMETER1=  
|gr2= Sides


|p2= |PARAMETER2=
|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]]).
|p3= |PARAMETER3=


| [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. |RETURNVALUE=
|s1= [[captiveNum]] unit


|p1= unit: [[Object]]


|x1= <code>_captivity = [[captiveNum]] _unit;</code>|EXAMPLE1=
|r1= [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]].
|x2= <code>_unit [[setCaptive]] 1024;
[[hint]] [[str]] [[captive]] _unit; //true
[[hint]] [[str]] [[captiveNum]] _unit; //1024</code>|EXAMPLE1=


____________________________________________________________________________________________
|x1= <sqf>_captivity = captiveNum _unit;</sqf>


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


| |MPBEHAVIOUR=  
|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 Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=captiveNum&oldid=369311"