captiveNum: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. classification)
(fill some info)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Checks whether the unit is a captive. If the unit is a vehicle, its commander is checked instead. |= 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]]).
|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''captiveNum''' unit |= Syntax
| '''captiveNum''' unit |= Syntax


|p1= unit:[[Object]] |= PARAMETER1  
|p1= unit: [[Object]] |= PARAMETER1  


|p2= |= PARAMETER2  
|p2= |= PARAMETER2  
Line 18: Line 21:
|p3= |= PARAMETER3  
|p3= |= PARAMETER3  


| |= RETURNVALUE  
| [[Number]] |= RETURNVALUE  




|x1= <code>(example)</code>|= EXAMPLE1  
|x1= <code><nowiki>_captivity = captiveNum _unit</nowiki></code>|= EXAMPLE1  


____________________________________________________________________________________________
____________________________________________________________________________________________


| [[captive]] |= SEEALSO  
| [[captive]], [[setCaptive]] |= SEEALSO  


|  |= MPBEHAVIOUR  
|  |= MPBEHAVIOUR  

Revision as of 03:08, 10 September 2009

Hover & click on the images for description

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

Examples

Example 1:
_captivity = captiveNum _unit

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

Notes

Bottom Section