units: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (arma3 category, was ordered under 'unitsgrp')
(syntax, fixed/added example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns an array with all the units in the group or unit.<br>For a destroyed object an empty array is returned. |= Description
| 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. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Array]] <nowiki>=</nowiki> '''units''' groupOrunit |= Syntax
| '''units''' groupOrunit |= Syntax


|p1 = groupOrunit: [[Group]] or [[Object]]|= Parameter 1
|p1 = groupOrunit: [[Group]] or [[Object]]|= Parameter 1


| [[Array]] |= Return value
| [[Array]] of [[Object]]s |= Return value
____________________________________________________________________________________________
 
|x1 = <code>_myUnitCount = [[count]] [[units]] [[group]] [[player]];</code> |= Example 1


|x2 = <code>_isInMyGroup = _soldier1 [[in]] [[units]] [[player]];</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1 = [[player]] in units [[group]] [[player]] 
| [[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]] |= See also
|[[group]], [[allGroups]], [[allUnits]], [[playableUnits]], [[switchableUnits]], [[vehicles]] |= See also


}}
}}

Revision as of 16:38, 15 March 2014

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

Syntax

Syntax:
units groupOrunit
Parameters:
groupOrunit: Group or Object
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)

Bottom Section