setCaptive (VBS2)
From Bohemia Interactive Community
| Editors, please check Policy: Scripting Command Page Syntax. |
Click on the images for descriptions
Introduced in
- Game:
- Virtual Battlespace 2
- Version:
- 1.00
Description
- Description:
- Mark a unit as captive.
If unit is a vehicle, commander is marked.
A captive is neutral to everyone, and will not trigger "detected by" conditions for its original side. Using a number instead of a boolean has no further effect on the engine's behavior, but can be used by scripting commands to keep track of the captivity status at a finer resolution (e.g. handcuffed, grouped, etc.)
The syntax with numbers was introduced in VBS2 v1.22.
Syntax
- Syntax:
- unit setCaptive captive
- Parameters:
- unit: Object
- captive: Boolean or Number - When using a number parameter, any value>0 is considered to be the same as true
- Return Value:
- Nothing
Examples
- Example 1:
_soldier1 setCaptive true- Example 2:
_soldier1 setCaptive 3
Additional Information
- Multiplayer:
- Behaviour unknown.
- See also:
- captiveNum
Notes
Notes
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.
