setCaptive: Difference between revisions

Revision as of 11:32, 12 May 2022

Hover & click on the images for description

Description:

Mark a unit as captive. If unit is a vehicle, commander is marked. A captive unit:

ⓘ

The number used as status can be retrieved by captiveNum to keep track of the captivity status at a finer resolution (e.g. handcuffed, grouped, etc).

Groups:

Object Manipulation Sides

Syntax:: unitName setCaptive statusNumber
Parameters:: unitName: Object
: statusNumber: Number - Zero means non-captive, a non-zero value means captive. See captiveNum
Return Value:: Nothing

Example 1:: _soldier1 setCaptive true; side _soldier1; // returns civilian side group _soldier1; // returns e.g blufor
Example 2:: _soldier1 setCaptive 1; captive _soldier1; // returns true _soldier1 setCaptive 42; captive _soldier1; // returns true _soldier1 setCaptive 0; captive _soldier1; // returns false

: 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


: 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.

: Posted on November 19, 2017 - 10:58 (UTC)
Lou Montana: Talkingtoaj's note does not 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)

: Posted on August 21, 2019 - 18:02 (UTC)
Tankbuster: Units that are setcaptive belong to their original side for the purposes of score and rating. So if an OPFOR unit is setcaptive and is killed by BLUFOR players, their score will be calculated as if they killed an OPFOR, not a civilian.

DreadedEntity - c: Posted on Apr 26, 2022 - 01:15 (UTC)
: In A3 2.08.149102, entering an empty vehicle with the same side as the player as defined in CfgVehicles >> _vehicleClassname >> side will briefly switch the side of the vehicle to the side of the player soldier (specifically, while the get in animation is playing), even if captive. Once exiting the vehicle, it will retain that side until the player enters a new vehicle or, seemingly arbitrarily, moves more than 100 meters away from the vehicle player distance _vehicle > 100. If the player gets within 100 meters of the vehicle without entering a new vehicle, it will again switch to the players side. This is probably a bug, in my opinion

@@ Line 58: / Line 58: @@
 |x1= <code>_soldier1 [[setCaptive]] [[true]];
 [[side]] _soldier1; // returns [[civilian]]
-side [[group]] _soldier1; // returns e.g [[blufor]]</code>
+side group _soldier1; // returns e.g [[blufor]]</code>
 |x2= <code>_soldier1 [[setCaptive]] 1;
@@ Line 67: / Line 67: @@
 _soldier1 [[setCaptive]] 0;
-captive _soldier1; // returns [[false]]</code>
+captive _soldier1; // returns false</code>
 |seealso= [[captive]] [[captiveNum]]