unitsBelowHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fixed example. Added BI description.)
m (Some wiki formatting)
 
(47 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.04


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| (description) |= Returns unit in group below passed height.
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| group or array '''unitsBelowHeight''' height |= Syntax
|game4= arma3
|version4= 0.50


|p1= group or array [[Group]] or [[Array]] |= PARAMETER1
|arg= global


|p2= height [[Number]] |= PARAMETER2
|gr1= Object Detection


|p3= |= PARAMETER3
|gr2= Positions


| [[Array]] |= RETURNVALUE
|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>.}}


|s1= units [[unitsBelowHeight]] height


|x1= <pre> _allOnGroudUnits = group player unitsBelowHeight 10 </pre> |= EXAMPLE1
|p1= units: [[Array]] of [[Object]]s


____________________________________________________________________________________________
|p2= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])


| |= SEEALSO
|r1= [[Array]] of [[Object]]s


| |= MPBEHAVIOUR
|s2= group [[unitsBelowHeight]] height
____________________________________________________________________________________________
 
}}
|p21= group: [[Group]] - AI group
 
|p22= height: [[Number]] - height above terrain level ([[Position#PositionATL|PositionATL]])
 
|r2= [[Array]] of [[Object]]s


<h3 style='display:none'>Notes</h3>
|x1= <sqf>_allOnGroudUnits = group player unitsBelowHeight 10;</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_units = allUnits unitsBelowHeight 30;</sqf>
</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|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15: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"