units: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp


|1.00
|version1= 1.00
 
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2
 
|version4= 1.00
 
|game5= arma2oa
 
|version5= 1.51
 
|game6= tkoh
 
|version6= 1.00
 
|game7= arma3
 
|version7= 0.50


|gr1= Groups
|gr1= Groups
Line 9: Line 33:
|gr2= Object Detection
|gr2= Object Detection


| 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 group of the unit.
For a destroyed object an empty array is returned.
{{Feature|arma3| Since 2.01.146926, type can also be [[Side]]. Command will then return all units of given side.}}


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


|p1 = type: [[Group]] or [[Object]], {{Since|arma3|2.01.146926}} also [[Side]]
|p1 = type: [[Group]] or [[Object]], {{Since|arma3|2.02}} also [[Side]]


| [[Array]] of [[Object]]s
|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>


|seealso= [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]]
|seealso= [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]]
Line 31: Line 55:
<dd class="note">The returned array on MP clients is not updated when team members die (only when they are deleted). (''Tested on VBS2'')
<dd class="note">The returned array on MP clients is not updated when team members die (only when they are deleted). (''Tested on VBS2'')
</dl>
</dl>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}


<dl class="command_description">
<dl class="command_description">

Revision as of 11:37, 6 April 2021

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh 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 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

See also:
groupallGroupsallUnitsplayableUnitsswitchableUnitsvehicles

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.
Retrieved from "https://community.bistudio.com/wiki?title=units&oldid=254077"