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 (Some wiki formatting)
 
(26 intermediate revisions by 2 users not shown)
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|Multiplayer Arguments=
|game3= tkoh
|version3= 1.00


|gr1= Object Detection |GROUP1=
|game4= arma3
|version4= 0.50


|gr2= Positions |GROUP2=
|arg= global
____________________________________________________________________________________________


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


| units [[unitsBelowHeight]] height |SYNTAX=
|gr2= Positions


|p1= units: [[Array]] of [[Object]]s |PARAMETER1=  
|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>.}}


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


| [[Array]] of [[Object]]s |RETURNVALUE=
|p1= units: [[Array]] of [[Object]]s


|s2= group [[unitsBelowHeight]] height |SYNTAX2=
|p2= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])


|p21= group: [[Group]] - AI group |PARAMETER21=
|r1= [[Array]] of [[Object]]s


|p22= height: [[Number]] - height above terrain level ([[PositionATL]]) |PARAMETER22=
|s2= group [[unitsBelowHeight]] height


|r2= [[Array]] of [[Object]]s |RETURNVALUE2=
|p21= group: [[Group]] - AI group


|x1= <code>_allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10;</code> |EXAMPLE1=
|p22= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])


|x2= <code>_units = [[allUnits]] [[unitsBelowHeight]] 30;</code> |EXAMPLE2=
|r2= [[Array]] of [[Object]]s
____________________________________________________________________________________________


| [[allUnits]], [[getPosATL]], [[group]] |SEEALSO=
|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 -->


<!-- Note Section END -->
|seealso= [[allUnits]] [[getPosATL]] [[group]]
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
 
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:53, 1 July 2022

Logo A2.png1.04A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=unitsBelowHeight&oldid=325197"