captive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Reverted to revision 106253 by Lou Montana on 2018-03-25T10:36:44Z)
m (template:command argument fix)
Line 11: Line 11:
| Returns the captive state of the given unit (set with [[setCaptive]]). A captive unit will not be attacked by its enemies.
| Returns the captive state of the given unit (set with [[setCaptive]]). A captive unit will not be attacked by its enemies.
{{Important|
{{Important|
While a captive unit won't be attacked, it will still attack its enemies – be sure to [[setBehaviour]] "CARELESS" / [[removeAllWeapons]] accordingly.}} |= Description
While a captive unit won't be attacked, it will still attack its enemies – be sure to [[setBehaviour]] "CARELESS" / [[removeAllWeapons]] accordingly.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[captive]] object |= Syntax
| [[captive]] object |SYNTAX=


|p1= object: [[Object]] - unit or vehicle |= Parameter 1
|p1= object: [[Object]] - unit or vehicle |PARAMETER1=


| [[Boolean]] - [[true]] if the unit is captive, [[false]] if not |= Return value
| [[Boolean]] - [[true]] if the unit is captive, [[false]] if not |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[if]] ([[captive]] _general) [[then]] { [[removeAllWeapons]] _general; };</code> |= Example 1
|x1= <code>[[if]] ([[captive]] _general) [[then]] { [[removeAllWeapons]] _general; };</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[captiveNum]], [[setCaptive]], [[side]] |= See also
| [[captiveNum]], [[setCaptive]], [[side]] |SEEALSO=


}}
}}

Revision as of 14:35, 7 April 2019

Hover & click on the images for description

Description

Description:
Returns the captive state of the given unit (set with setCaptive). A captive unit will not be attacked by its enemies.
While a captive unit won't be attacked, it will still attack its enemies – be sure to setBehaviour "CARELESS" / removeAllWeapons accordingly.
Groups:
Uncategorised

Syntax

Syntax:
captive object
Parameters:
object: Object - unit or vehicle
Return Value:
Boolean - true if the unit is captive, false if not

Examples

Example 1:
if (captive _general) then { removeAllWeapons _general; };

Additional Information

See also:
captiveNumsetCaptiveside

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