captiveNum: Difference between revisions
m (Bot: Reverted to revision 93015 by killzone_kid on 2015-11-30T21:52:37Z) |
m (template:command argument fix) |
||
| Line 17: | Line 17: | ||
| '''captiveNum''' unit |= Syntax | | '''captiveNum''' unit |= Syntax | ||
|p1= unit: [[Object]] |= | |p1= unit: [[Object]] |PARAMETER1= | ||
|p2= |= | |p2= |PARAMETER2= | ||
|p3= |= | |p3= |PARAMETER3= | ||
| [[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]]. |RETURNVALUE= | ||
|x1= <code>_captivity = [[captiveNum]] _unit;</code>|= | |x1= <code>_captivity = [[captiveNum]] _unit;</code>|EXAMPLE1= | ||
|x2= <code>_unit [[setCaptive]] 1024; | |x2= <code>_unit [[setCaptive]] 1024; | ||
[[hint]] [[str]] [[captive]] _unit; //true | [[hint]] [[str]] [[captive]] _unit; //true | ||
[[hint]] [[str]] [[captiveNum]] _unit; //1024</code>|= | [[hint]] [[str]] [[captiveNum]] _unit; //1024</code>|EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[captive]], [[setCaptive]] |= | | [[captive]], [[setCaptive]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 10:29, 7 April 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