unitsBelowHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{uc:{{PAGENAME}}}}" to "")
(the command is 2 syntaxes)
Line 15: Line 15:
| units [[unitsBelowHeight]] height |SYNTAX=
| units [[unitsBelowHeight]] height |SYNTAX=


|p1= units: [[Group]] or [[Array]] of [[Object]]s |PARAMETER1=  
|p1= units: [[Array]] of [[Object]]s |PARAMETER1=  


|p2= height: [[Number]] - height above terrain level ([[PositionATL]]) |PARAMETER2=  
|p2= height: [[Number]] - height above terrain level ([[PositionATL]]) |PARAMETER2=  


| [[Array]] of [[Object]]s |RETURNVALUE=  
| [[Array]] of [[Object]]s |RETURNVALUE=  
|s2= group [[unitsBelowHeight]] height |SYNTAX2=
|p21= group: [[Group]] - AI group |PARAMETER21=
|p22= height: [[Number]] - height above terrain level ([[PositionATL]]) |PARAMETER22=
|r2= [[Array]] of [[Object]]s |RETURNVALUE2=


|x1= <code>_allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10;</code> |EXAMPLE1=  
|x1= <code>_allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10;</code> |EXAMPLE1=  

Revision as of 16:19, 29 October 2019

Hover & click on the images for description

Description

Description:
Returns units in group/array below given Above Terrain Level (ATL) height.
unit's ATL height can be found with _height = (getPosATL _unit) select 2;
Groups:
Uncategorised

Syntax

Syntax:
units unitsBelowHeight height
Parameters:
units: Array of Objects
height: Number - height above terrain level (PositionATL)
Return Value:
Array of Objects

Alternative Syntax

Syntax:
group unitsBelowHeight height
Parameters:
group: Group - AI group
height: Number - height above terrain level (PositionATL)
Return Value:
Array of Objects

Examples

Example 1:
_allOnGroudUnits = group player unitsBelowHeight 10;
Example 2:
_units = allUnits unitsBelowHeight 30;

Additional Information

See also:
allUnitsgetPosATLgroup

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

Bottom Section