units: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1= Groups |GROUP1=
|gr1= Groups


|gr2= Object Detection |GROUP2=
|gr2= Object Detection


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


| [[units]] type |SYNTAX=
| [[units]] type


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


| [[Array]] of [[Object]]s |RETURNVALUE=
| [[Array]] of [[Object]]s


|x1 = <code>_myUnitCount = [[count]] [[units]] [[group]] [[player]];</code> |EXAMPLE1=
|x1 = <code>_myUnitCount = [[count]] [[units]] [[group]] [[player]];</code>


|x2 = <code>_isInMyGroup = _soldier1 [[in]] [[units]] [[player]];</code> |EXAMPLE2=
|x2 = <code>_isInMyGroup = _soldier1 [[in]] [[units]] [[player]];</code>


| [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]] |SEEALSO=
| [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]]


}}
}}

Revision as of 11:40, 18 January 2021

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Returns an array with all the units in the group or group of the unit.
For a destroyed object an empty array is returned.
Arma 3
Since 2.01.146926, type can also be Side. Command will then return all units of given side.
Groups:
GroupsObject Detection

Syntax

Syntax:
units type
Parameters:
type: Group or Object, Template:Since also Side
Return Value:
Array of Objects

Examples

Example 1:
_myUnitCount = count units group player;
Example 2:
_isInMyGroup = _soldier1 in units player;

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

Notes

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=211173"