units: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<dl class="command_description"> <dd class="notedate">" to "<dl class="command_description"> <dt></dt> <dd class="notedate">") |
Lou Montana (talk | contribs) m (Text replacement - " \|(x[0-9]|p[0-9]{1,2}|descr|game[0-9]|version[0-9]|s[0-9]|exec|r[0-9]|arg|eff|branch|serverExec|gr[0-9]|mp|pr|seealso) +=" to " |$1=") |
||
Line 30: | Line 30: | ||
|s1= [[units]] type | |s1= [[units]] type | ||
|p1 = type: [[Group]] or [[Object]], {{Since|arma3|2.02}} also [[Side]] | |p1= type: [[Group]] or [[Object]], {{Since|arma3|2.02}} also [[Side]] | ||
|r1= [[Array]] of [[Object]]s - If ''type'' is a destroyed object, an empty array is returned | |r1= [[Array]] of [[Object]]s - If ''type'' is a destroyed object, an empty array is returned | ||
|x1 = <code>_myUnitCount = [[count]] [[units]] [[group]] [[player]];</code> | |x1= <code>_myUnitCount = [[count]] [[units]] [[group]] [[player]];</code> | ||
|x2 = <code>_isInMyGroup = _soldier1 [[in]] [[units]] [[player]];</code> | |x2= <code>_isInMyGroup = _soldier1 [[in]] [[units]] [[player]];</code> | ||
|x3 = <code>_unitsEast = [[units]] [[opfor]];</code> | |x3= <code>_unitsEast = [[units]] [[opfor]];</code> | ||
|seealso= [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]] | |seealso= [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]] |
Revision as of 23:29, 10 June 2021
Description
- Description:
- Returns an array with all the units in the group or group of the unit.
- Groups:
- GroupsObject Detection
Syntax
- Syntax:
- units type
- Parameters:
- type: Group or Object, Template:Since also Side
- Return Value:
- Array of Objects - If type is a destroyed object, an empty array is returned
Examples
- Example 1:
_myUnitCount = count units group player;
- Example 2:
_isInMyGroup = _soldier1 in units player;
- Example 3:
_unitsEast = units opfor;
Additional Information
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
- Posted on September 24, 2009
- Kronzky
- The returned array on MP clients is not updated when team members die (only when they are deleted). (Tested on VBS2)
- Posted on July 3, 2020 - 03:36 (UTC)
- Ilias38rus
- Seem to always return a list with the same order as the squad menu of the leader.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Groups
- Command Group: Object Detection