setCaptive: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (template:command argument fix) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 10: | Line 10: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Mark a unit as captive. | | Mark a unit as captive. If unit is a vehicle, commander is marked. A captive is neutral to everyone (belong to [[civilian]] [[side]]), and will not trigger "detected by" conditions for its original [[side]]. | ||
<br><br>Using a number (instead of a boolean) for the status has no further effect on the engine's behavior, but can be used by [[captiveNum]] to keep track of the captivity status at a finer resolution (e.g. handcuffed, grouped, etc.). The numbered status syntax was introduced in Arma 2. |DESCRIPTION= | |||
____________________________________________________________________________________________ | |||
| unitName '''setCaptive''' status |SYNTAX= | |||
|p1= unitName: [[Object]] |PARAMETER1= | |||
|p2= status: [[Boolean]] - [[true]] means [[captive]]|PARAMETER2= | |||
| [[Nothing]] |RETURNVALUE= | |||
| unitName '''setCaptive''' status |= | | s2= unitName '''setCaptive''' status |SYNTAX= | ||
| | |p21= unitName: [[Object]] |PARAMETER1= | ||
| | |p22= status: [[Number]] - 0 or non zero. A non zero value means [[captive]]|PARAMETER2= | ||
| [[Nothing]] |= | | r2= [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_soldier1 setCaptive [[true]]</code> |= | |x1= <code>_soldier1 [[setCaptive]] [[true]];</code> |EXAMPLE1= | ||
|x2= <code>_soldier1 setCaptive | |x2= <code>_soldier1 [[setCaptive]] 1;</code> |EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[captive]], [[captiveNum | | [[captive]], [[captiveNum]] |SEEALSO= | ||
}} | }} | ||
| Line 58: | Line 59: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands|SETCAPTIVE]] | [[Category:Scripting Commands|SETCAPTIVE]] | ||
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands OFP 1.96|SETCAPTIVE]] | [[Category:Scripting Commands OFP 1.96|SETCAPTIVE]] | ||
[[Category:Scripting Commands OFP 1.46|SETCAPTIVE]] | [[Category:Scripting Commands OFP 1.46|SETCAPTIVE]] | ||
| Line 64: | Line 66: | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | ||
<!-- CONTINUE Notes --> | |||
<dl class="command_description"> | |||
<dd class="notedate">Posted on November 19, 2017 - 10:58 (UTC)</dd> | |||
<dt class="note">[[User:Lou Montana|Lou Montana]]</dt> | |||
<dd class="note"> | |||
'''Talkingtoaj''' note doesn't apply to Arma 3 anymore (earlier than 1.76)<br /> | |||
A captive unit will immediately be shot (after a normal "human" reaction time from the AI) | |||
</dd> | |||
</dl> | |||
<!-- DISCONTINUE Notes --> | |||
Revision as of 15:46, 7 April 2019
Description
- Description:
- Mark a unit as captive. If unit is a vehicle, commander is marked. A captive is neutral to everyone (belong to civilian side), and will not trigger "detected by" conditions for its original side.
Using a number (instead of a boolean) for the status has no further effect on the engine's behavior, but can be used by captiveNum to keep track of the captivity status at a finer resolution (e.g. handcuffed, grouped, etc.). The numbered status syntax was introduced in Arma 2. - Groups:
- Uncategorised
Syntax
- Syntax:
- unitName setCaptive status
- Parameters:
- unitName: Object
- status: Boolean - true means captive
- Return Value:
- Nothing
Alternative Syntax
- Syntax:
- unitName setCaptive status
- Parameters:
- unitName: Object
- status: Number - 0 or non zero. A non zero value means captive
- Return Value:
- Nothing
Examples
- Example 1:
_soldier1 setCaptive true;- Example 2:
_soldier1 setCaptive 1;
Additional Information
- See also:
- captivecaptiveNum
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
- Posted on August 4, 2006 - 23:49
- hoz
- This function does not remove unit's weapons. If you make a unit captive, that unit will still fire on the enemy, but the enemy will not fire back.
- Posted on January 1, 2011 - 13:11
- Talkingtoaj
- If you change a unit from captive to no longer captive (for example, to "reveal" an undercover unit), enemy units that already have prior knowledge of the unit as a captive will only partially engage, making it very easy for the undercover unit. This seems to be a bug. However other enemy unit the unit later encounters will engage freely with full force.
Bottom Section
- Posted on November 19, 2017 - 10:58 (UTC)
- Lou Montana
-
Talkingtoaj note doesn't apply to Arma 3 anymore (earlier than 1.76)
A captive unit will immediately be shot (after a normal "human" reaction time from the AI)
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Global Effect
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters