captiveNum: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?]]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma2 |Game name= | | arma2 |Game name= | ||
| Line 11: | Line 10: | ||
|gr2= Sides |GROUP2= | |gr2= Sides |GROUP2= | ||
| Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead.<br> | | 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= | | [[captiveNum]] unit |SYNTAX= | ||
| Line 22: | Line 19: | ||
| [[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= | |x1= <code>_captivity = [[captiveNum]] _unit;</code> |EXAMPLE1= | ||
| Line 30: | Line 26: | ||
[[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code> |EXAMPLE2= | [[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code> |EXAMPLE2= | ||
| [[captive]], [[setCaptive]] |SEEALSO= | | [[captive]], [[setCaptive]] |SEEALSO= | ||
Revision as of 00:22, 17 January 2021
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:
- 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