captive: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?]]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 11: | Line 10: | ||
|gr2= Sides |GROUP2= | |gr2= Sides |GROUP2= | ||
| 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= | ||
| Line 23: | Line 20: | ||
| [[Boolean]] - [[true]] if the unit is captive, [[false]] if not |RETURNVALUE= | | [[Boolean]] - [[true]] if the unit is captive, [[false]] if not |RETURNVALUE= | ||
|x1= <code>[[if]] ([[captive]] _general) [[then]] { [[removeAllWeapons]] _general; };</code> |EXAMPLE1= | |x1= <code>[[if]] ([[captive]] _general) [[then]] { [[removeAllWeapons]] _general; };</code> |EXAMPLE1= | ||
| [[captiveNum]], [[setCaptive]], [[side]] |SEEALSO= | | [[captiveNum]], [[setCaptive]], [[side]] |SEEALSO= | ||
Revision as of 00:24, 17 January 2021
Description
- Description:
- Returns the captive state of the given unit (set with setCaptive). A captive unit will not be attacked by its enemies.
- Groups:
- Object ManipulationSides
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Object Manipulation
- Command Group: Sides
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands