captiveNum: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|arg= global | |arg= global | ||
|gr1= Object Manipulation | |gr1= Object Manipulation | ||
|gr2= Sides | |gr2= Sides | ||
| 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]]). | If a unit's captivity level was set as a [[Boolean]], then the returned number is either 0 (for [[false]]) or 1 (for [[true]]). | ||
| [[captiveNum]] unit | | [[captiveNum]] unit | ||
|p1= unit: [[Object]] | |p1= unit: [[Object]] | ||
| [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. | | [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. | ||
|x1= <code>_captivity = [[captiveNum]] _unit;</code> | |x1= <code>_captivity = [[captiveNum]] _unit;</code> | ||
|x2= <code>_unit [[setCaptive]] 1024; | |x2= <code>_unit [[setCaptive]] 1024; | ||
[[hint]] [[str]] [[captive]] _unit; {{cc|true}} | [[hint]] [[str]] [[captive]] _unit; {{cc|true}} | ||
[[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code> | [[hint]] [[str]] [[captiveNum]] _unit; {{cc|1024}}</code> | ||
| [[captive]], [[setCaptive]] | | [[captive]], [[setCaptive]] | ||
}} | }} | ||
Revision as of 00:12, 18 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