units: Difference between revisions

Revision as of 10:25, 13 May 2022

Hover & click on the images for description

Description:: Returns an array with all the units in the group or group of the unit.
Since Arma 3 v2.02 the command can also return all units belonging to a certain side.
Groups:: Groups Object Detection

Syntax:: units type
Parameters:: type: Group, Object or (since Arma 3 v2.02) Side
Return Value:: Array of Objects - If type is a destroyed object, an empty array is returned

Example 1:: _myUnitCount = count units player;
Example 2:: _isInMyGroup = _soldier1 in units player;
Example 3:: _unitsEast = units opfor;
Example 4:: // Both methods are the same, the latter is preferred 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]

: 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.

@@ Line 35: / Line 35: @@
 |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>_unitsEast = units opfor;</sqf>
-|x4= <code>// Both methods are the same, the latter is preferred
+|x4= <sqf>// Both methods are the same, the latter is preferred
 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]</code>
+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]]