setCaptive: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[Category:Scripting Commands|SETCAPTIVE]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|SETCAPTIVE]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|SETCAPTIVE]]
[[Category:Scripting Commands ArmA|SETCAPTIVE]]


| ofp |= Game name


<h2 style="color:#000066">'''''person'' setCaptive ''captive'''''</h2>
|1.00|= Game version
____________________________________________________________________________________________


| Mark unit as captive.
If unit is a vehicle, commander is marked.
A captive is neutral to everyone.
Note: This function does not remove unit's weapons.
Note: If you make a unit captive, that unit will still fire on the enemy, but the enemy will not fire back. |= Description
____________________________________________________________________________________________


'''Operand types:'''
| person '''setCaptive''' captive |= Syntax


'''person:''' [[Object]]
|p1= person: [[Object]] |= Parameter 1


'''captive:''' [[Boolean]]
|p2= captive: [[Boolean]] |= Parameter 2


'''Type of returned value:'''
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>soldier1 setCaptive [[true]]</pre> |= Example 1
____________________________________________________________________________________________


[[Nothing]]
|  |= See also


'''Description:'''
}}


Mark unit as captive.<br>
<h3 style="display:none">Notes</h3>
If unit is a vehicle, commander is marked.<br>
<dl class="command_description">
A captive is neutral to everyone.<br>
<!-- Note Section BEGIN -->
'''Note:''' This function does not remove unit's weapons.<br>
'''Note:''' If you make a unit captive, that unit will still fire on the enemy, but the enemy will not fire back.


<!-- Note Section END -->
</dl>


'''Example:<br>'''
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|SETCAPTIVE]]
soldier1 '''setCaptive''' [[true]]
[[Category:Scripting Commands OFP 1.96|SETCAPTIVE]]
[[Category:Scripting Commands OFP 1.46|SETCAPTIVE]]
[[Category:Scripting Commands ArmA|SETCAPTIVE]]

Revision as of 23:07, 1 August 2006

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Mark unit as captive. If unit is a vehicle, commander is marked. A captive is neutral to everyone. Note: This function does not remove unit's weapons. Note: If you make a unit captive, that unit will still fire on the enemy, but the enemy will not fire back.
Groups:
Uncategorised

Syntax

Syntax:
person setCaptive captive
Parameters:
person: Object
captive: Boolean
Return Value:
Nothing

Examples

Example 1:
soldier1 setCaptive [[true]]

Additional Information

See also:
See also needed

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

Retrieved from "https://community.bistudio.com/wiki?title=setCaptive&oldid=16612"