captiveNum: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
Killzone Kid (talk | contribs) (example) |
||
| Line 23: | Line 23: | ||
|p3= |= PARAMETER3 | |p3= |= PARAMETER3 | ||
| [[Number]] |= 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 | ||
|x2= <code>_unit [[setCaptive]] 1024; | |||
[[hint]] [[str]] [[captiveNum]] _unit; //1024</code>|= EXAMPLE1 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 23:51, 30 November 2015
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 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