units: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
 
(4 intermediate revisions by 2 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 of the unit. <br>
|descr= Returns an array with all the units in the group or unit's group, or all units belonging to a certain side.
Since {{arma3}} v2.02 the command can also return all units belonging to a certain side.


|s1= [[units]] type
|s1= [[units]] type


|p1= type: [[Group]], [[Object]] or (since {{arma3}} v2.02) [[Side]]
|p1= type: [[Group]], [[Object]] or {{GVI|arma3|2.02|size= 0.75}} [[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 player;</code>
|x1= <sqf>_myUnitCount = count units player;</sqf>


|x2= <code>_isInMyGroup = _soldier1 in units player;</code>
|x2= <sqf>_isInMyGroup = _soldier1 in units player;</sqf>


|x3= <code>_unitsEast = units opfor;</code>
|x3= <sqf>private _unitsEast = units opfor;</sqf>


|x4= <code>// Both methods are the same, the latter is preferred
|x4= <sqf>
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]
// both methods are the same, the latter is preferred for performance reason
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]</code>  
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]] [[allUnits]] [[playableUnits]] [[switchableUnits]] [[vehicles]]
|seealso= [[group]] [[allGroups]] [[groups]] [[allUnits]] [[playableUnits]] [[switchableUnits]] [[vehicles]]
}}
}}


<dl class="command_description">
{{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'')
}}


<dt></dt>
{{Note
<dd class="notedate">Posted on September 24, 2009</dd>
|user= Ilias38rus
<dt class="note">[[User:Kronzky|Kronzky]]</dt>
|timestamp= 20200703033600
<dd class="note">The returned array on MP clients is not updated when team members die (only when they are deleted). (''Tested on VBS2'')
|text= Seems to always return a list with the same order as the leader's squad menu.
<dt></dt>
}}
<dd class="notedate">Posted on July 3, 2020 - 03:36 (UTC)</dd>
<dt class="note">[[User:Ilias38rus|Ilias38rus]]</dt>
<dd class="note">
Seem to always return a list with the same order as the squad menu of the leader.
</dd>
 
</dl>

Latest revision as of 18:06, 29 April 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

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 Arma 3 logo black.png2.02 Side
Return Value:
Array of Objects - if type is a destroyed object, an empty array is returned

Examples

Example 1:
_myUnitCount = count units player;
Example 2:
_isInMyGroup = _soldier1 in units player;
Example 3:
private _unitsEast = units opfor;
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
Kronzky - c
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)
Ilias38rus - c
Posted on Jul 03, 2020 - 03:36 (UTC)
Seems to always return a list with the same order as the leader's squad menu.
Retrieved from "https://community.bistudio.com/wiki?title=units&oldid=340313"