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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.04
-|1.04|= Game version
+|game2= arma2oa
+|version2= 1.50
-|arg= global|= Arguments in MP
+|game3= tkoh
-____________________________________________________________________________________________
+|version3= 1.00
-| Returns units in group/array below given height Above The Land (ATL). Current unit height ATL could be found with <br>
+|game4= arma3
-<tt>_height <nowiki>=</nowiki> ([[getPosATL]] _unit) [[select]] 2;</tt> |= Description
+|version4= 0.50
-____________________________________________________________________________________________
-| units '''unitsBelowHeight''' height |= Syntax
+|arg= global
-|p1= units: [[Group]] or [[Array]] of [[Object]]s |= PARAMETER1
+|gr1= Object Detection
-|p2= height: [[Number]] - height above terrain level ([[PositionATL]])|= PARAMETER2
+|gr2= Positions
-|p3= |= PARAMETER3
+|descr= Returns units in group/array below given Above Terrain Level (ATL) altitude.
+{{Feature|informative|an object's ATL altitude can be found with <sqf inline>_altitude = (getPosATL _obj) select 2;</sqf>.}}
-| [[Array]] of [[Object]]s|= RETURNVALUE
+|s1= units [[unitsBelowHeight]] height
+|p1= units: [[Array]] of [[Object]]s
-|x1=  <code> _allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10; </code> |= EXAMPLE1
+|p2= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])
-|x2=  <code> _units = [[allUnits]] [[unitsBelowHeight]] 30; </code> |= EXAMPLE2
+|r1= [[Array]] of [[Object]]s
-____________________________________________________________________________________________
+|s2= group [[unitsBelowHeight]] height
-| [[allUnits]], [[getPosATL]], [[group]] |= SEEALSO
+|p21= group: [[Group]] - AI group
-|  |= MPBEHAVIOUR
+|p22= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])
-____________________________________________________________________________________________
-}}
+|r2= [[Array]] of [[Object]]s
+|x1= <sqf>_allOnGroudUnits = group player unitsBelowHeight 10;</sqf>
-<h3 style='display:none'>Notes</h3>
+|x2= <sqf>_units = allUnits unitsBelowHeight 30;</sqf>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on Nov 12, 2009 - 23:46
-<dt class="note">'''[[User:Lou Montana|Lou Montana]]'''
-<dd class="note">the height is calculated above terrain level (ATL), not water level or building level.
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
+|seealso= [[allUnits]] [[getPosATL]] [[group]]
-[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]