unitsBelowHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 11: Line 10:


|gr2= Positions |GROUP2=
|gr2= Positions |GROUP2=
____________________________________________________________________________________________


| Returns units in group/array below given Above Terrain Level (ATL) height.
| Returns units in group/array below given Above Terrain Level (ATL) height.
{{Informative | unit's ATL height can be found with {{Inline code|_height {{=}} ([[getPosATL]] _unit) [[select]] 2;}}}} |DESCRIPTION=
{{Informative | unit's ATL height can be found with {{Inline code|_height {{=}} ([[getPosATL]] _unit) [[select]] 2;}}}} |DESCRIPTION=
____________________________________________________________________________________________


| units [[unitsBelowHeight]] height |SYNTAX=
| units [[unitsBelowHeight]] height |SYNTAX=
Line 36: Line 33:


|x2= <code>_units = [[allUnits]] [[unitsBelowHeight]] 30;</code> |EXAMPLE2=  
|x2= <code>_units = [[allUnits]] [[unitsBelowHeight]] 30;</code> |EXAMPLE2=  
____________________________________________________________________________________________


| [[allUnits]], [[getPosATL]], [[group]] |SEEALSO=
| [[allUnits]], [[getPosATL]], [[group]] |SEEALSO=

Revision as of 04:20, 17 January 2021

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:
Object DetectionPositions

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