captiveNum: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *((\[\[.*\]\],? ?)+) * \}\}" to "|seealso= $1 }}") |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>") |
||
| (22 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2 | |game1= arma2 | ||
|version1= 1.00 | |||
|1.00 | |game2= arma2oa | ||
|version2= 1.50 | |||
|game3= tkoh | |||
|version3= 1.00 | |||
|game4= arma3 | |||
|version4= 0.50 | |||
|arg= global | |arg= global | ||
| Line 11: | Line 19: | ||
|gr2= Sides | |gr2= Sides | ||
| Checks whether the unit is a [[captive]]. If the unit is a vehicle, its commander is checked instead.<br> | |descr= 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 | |s1= [[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]]. | |r1= [[Number]] - anything from 0 to value set by [[setCaptive]] alt syntax. A non zero value means [[captive]]. | ||
|x1= < | |x1= <sqf>_captivity = captiveNum _unit;</sqf> | ||
|x2= < | |x2= <sqf> | ||
_unit setCaptive 1024; | |||
hint str captive _unit; // true | |||
hint str captiveNum _unit; // 1024 | |||
</sqf> | |||
|seealso= [[captive]] | |seealso= [[captive]] [[setCaptive]] | ||
}} | }} | ||
Latest revision as of 19:42, 3 September 2024
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:
- Example 2:
Additional Information
- See also:
- captive setCaptive
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