captiveNum: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:ArmA 2: New Scripting Commands List\|{{uc:{{PAGENAME}}}}\]\]\s*" to "") |
Lou Montana (talk | contribs) |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead. | | 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]]). |DESCRIPTION= | |||
If a unit's captivity level was set as a [[Boolean]], then the returned number is either 0 (for [[false]]) or 1 (for [[true]]). | |||
|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[captiveNum]] unit |SYNTAX= | ||
|p1= unit: [[Object]] |PARAMETER1= | |p1= unit: [[Object]] |PARAMETER1= | ||
| [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. |RETURNVALUE= | |||
____________________________________________________________________________________________ | |||
| [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. |RETURNVALUE= | |||
|x1= <code>_captivity = [[captiveNum]] _unit;</code> |EXAMPLE1= | |||
|x2= <code>_unit [[setCaptive]] 1024; | |x2= <code>_unit [[setCaptive]] 1024; | ||
[[hint]] [[str]] [[captive]] _unit; | [[hint]] [[str]] [[captive]] _unit; {{cc|true}} | ||
[[hint]] [[str]] [[captiveNum]] _unit; | [[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[captive]], [[setCaptive]] |SEEALSO= | | [[captive]], [[setCaptive]] |SEEALSO= | ||
}} | }} | ||
Revision as of 10:27, 1 October 2019
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:
- Uncategorised
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:
- captivesetCaptive
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