unitsBelowHeight: Difference between revisions

Latest revision as of 15:53, 1 July 2022

1.04

Hover & click on the images for description

Description

Description:: Returns units in group/array below given Above Terrain Level (ATL) altitude.
ⓘ
an object's ATL altitude can be found with _altitude = (getPosATL _obj) select 2;.
Groups:: Object Detection Positions

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:: allUnits getPosATL group

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma2
+|game1= arma2
+|version1= 1.04
-|1.04
+|game2= arma2oa
+|version2= 1.50
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
 |arg= global
@@ Line 11: / Line 19: @@
 |gr2= Positions
-| Returns units in group/array below given Above Terrain Level (ATL) height.
+|descr= Returns units in group/array below given Above Terrain Level (ATL) altitude.
-{{Feature | Informative | unit's ATL height can be found with {{ic|_height {{=}} ([[getPosATL]] _unit) [[select]] 2;}}}}
+{{Feature|informative|an object's ATL altitude can be found with <sqf inline>_altitude = (getPosATL _obj) select 2;</sqf>.}}
-| units [[unitsBelowHeight]] height
+|s1= units [[unitsBelowHeight]] height
 |p1= units: [[Array]] of [[Object]]s
-|p2= height: [[Number]] - height above terrain level ([[PositionATL]])
+|p2= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])
-| [[Array]] of [[Object]]s
+|r1= [[Array]] of [[Object]]s
 |s2= group [[unitsBelowHeight]] height
@@ Line 26: / Line 34: @@
 |p21= group: [[Group]] - AI group
-|p22= height: [[Number]] - height above terrain level ([[PositionATL]])
+|p22= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])
 |r2= [[Array]] of [[Object]]s
-|x1= <code>_allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10;</code>
+|x1= <sqf>_allOnGroudUnits = group player unitsBelowHeight 10;</sqf>
-|x2= <code>_units = [[allUnits]] [[unitsBelowHeight]] 30;</code>
+|x2= <sqf>_units = allUnits unitsBelowHeight 30;</sqf>
-|seealso= [[allUnits]], [[getPosATL]], [[group]]
+|seealso= [[allUnits]] [[getPosATL]] [[group]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]