units: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " </dl> <dl class="command_description"> <dt></dt>" to " <dt></dt>") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (22 intermediate revisions by 4 users not shown) | |||
| Line 26: | Line 26: | ||
|gr2= Object Detection | |gr2= Object Detection | ||
|descr= Returns an array with all the units in the group or group | |descr= Returns an array with all the units in the group or unit's group, or all units belonging to a certain side. | ||
|s1= [[units]] type | |s1= [[units]] type | ||
|p1= type: [[Group]] | |p1= type: [[Group]], [[Object]] or {{GVI|arma3|2.02|size= 0.75}} [[Side]] | ||
|r1= [[Array]] of [[Object]]s - | |r1= [[Array]] of [[Object]]s - if ''type'' is a destroyed object, an empty array is returned | ||
|x1= < | |x1= <sqf>_myUnitCount = count units player;</sqf> | ||
|x2= < | |x2= <sqf>_isInMyGroup = _soldier1 in units player;</sqf> | ||
|x3= < | |x3= <sqf>private _unitsEast = units opfor;</sqf> | ||
|seealso= [[group]] | |x4= <sqf> | ||
// both methods are the same, the latter is preferred for performance reason | |||
units group player; // [B Alpha 1-1:1 (R3vo), B Alpha 1-1:2, B Alpha 1-1:3, B Alpha 1-1:4, B Alpha 1-1:5, B Alpha 1-1:6, B Alpha 1-1:7, B Alpha 1-1:8] | |||
units player; // [B Alpha 1-1:1 (R3vo), B Alpha 1-1:2, B Alpha 1-1:3, B Alpha 1-1:4, B Alpha 1-1:5, B Alpha 1-1:6, B Alpha 1-1:7, B Alpha 1-1:8] | |||
</sqf> | |||
|seealso= [[group]] [[allGroups]] [[groups]] [[allUnits]] [[playableUnits]] [[switchableUnits]] [[vehicles]] | |||
}} | }} | ||
{{Note | |||
|user= Kronzky | |||
|timestamp= 20090925010300 | |||
|text= The returned array on MP clients is not updated when team members die (only when they are deleted). (''Tested on VBS2'') | |||
}} | |||
{{Note | |||
|user= Ilias38rus | |||
|timestamp= 20200703033600 | |||
|text= Seems to always return a list with the same order as the leader's squad menu. | |||
}} | |||
Latest revision as of 18:06, 29 April 2023
Description
- Description:
- Returns an array with all the units in the group or unit's group, or all units belonging to a certain side.
- Groups:
- GroupsObject Detection
Syntax
- Syntax:
- units type
- Parameters:
- type: Group, Object or
2.02 Side - Return Value:
- Array of Objects - if type is a destroyed object, an empty array is returned
Examples
- Example 1:
- Example 2:
- Example 3:
- Example 4:
- // both methods are the same, the latter is preferred for performance reason units group player; // [B Alpha 1-1:1 (R3vo), B Alpha 1-1:2, B Alpha 1-1:3, B Alpha 1-1:4, B Alpha 1-1:5, B Alpha 1-1:6, B Alpha 1-1:7, B Alpha 1-1:8] units player; // [B Alpha 1-1:1 (R3vo), B Alpha 1-1:2, B Alpha 1-1:3, B Alpha 1-1:4, B Alpha 1-1:5, B Alpha 1-1:6, B Alpha 1-1:7, B Alpha 1-1:8]
Additional Information
- See also:
- group allGroups groups allUnits playableUnits switchableUnits vehicles
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 Sep 25, 2009 - 01:03 (UTC)
- The returned array on MP clients is not updated when team members die (only when they are deleted). (Tested on VBS2)
- Posted on Jul 03, 2020 - 03:36 (UTC)
- Seems to always return a list with the same order as the leader's squad menu.
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