captiveNum: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|s1= +" to "|s1= ") |
Lou Montana (talk | contribs) m (Text replacement - " |r1=[[" to " |r1= [[") |
||
| Line 26: | Line 26: | ||
|p1= unit: [[Object]] | |p1= unit: [[Object]] | ||
|r1=[[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. | |r1= [[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> | ||
Revision as of 23:38, 7 August 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