setCaptive: Difference between revisions
Jump to navigation
Jump to search
(add. ArmA2 classification) |
Dr Eyeball (talk | contribs) (fill in numbered status syntax details) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Mark unit as captive. | | Mark a unit as captive. | ||
If unit is a vehicle, commander is marked. | 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]]. |= Description | A captive is neutral to everyone, 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. |= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 18: | Line 22: | ||
|p1= unitName: [[Object]] |= Parameter 1 | |p1= unitName: [[Object]] |= Parameter 1 | ||
|p2= status: [[Boolean]] |= Parameter 2 | |p2= status: [[Boolean]] or [[Number]] - When using a number parameter, any value>0 is considered to be the same as [[true]] |= Parameter 2 | ||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
| Line 24: | Line 28: | ||
|x1= <code>_soldier1 setCaptive [[true]]</code> |= Example 1 | |x1= <code>_soldier1 setCaptive [[true]]</code> |= Example 1 | ||
|x2= <code>_soldier1 setCaptive 3</code> |= Example 2 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[setCaptive_(VBS2)]] |= See also | | [[captive]], [[captiveNum]], [[setCaptive_(VBS2)]] |= See also | ||
}} | }} | ||
Revision as of 00:41, 27 November 2009
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) 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 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
- See also:
- captivecaptiveNumsetCaptive_(VBS2)
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.