unitsBelowHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Page cleanup)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.04|= Game version
|1.04|Game version=


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns units in group/array below given height Above The Land (ATL). Current unit height ATL could be found with <br>
| Returns units in group/array below given Above Terrain Level (ATL) height.
<tt>_height <nowiki>=</nowiki> ([[getPosATL]] _unit) [[select]] 2;</tt> |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=


|p1= units: [[Group]] or [[Array]] of [[Object]]s |PARAMETER1=  
|p1= units: [[Group]] or [[Array]] of [[Object]]s |PARAMETER1=  


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


|p3= |PARAMETER3=  
| [[Array]] of [[Object]]s |RETURNVALUE=  


| [[Array]] of [[Object]]s|RETURNVALUE=
|x1= <code>_allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10;</code> |EXAMPLE1=  
 
 
|x1= <code> _allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10; </code> |EXAMPLE1=
 
|x2=  <code> _units = [[allUnits]] [[unitsBelowHeight]] 30; </code> |EXAMPLE2=  


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


| [[allUnits]], [[getPosATL]], [[group]] |SEEALSO=  
| [[allUnits]], [[getPosATL]], [[group]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 39: Line 32:
<dl class='command_description'>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- 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 -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 23:57, 29 August 2019

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:
Uncategorised

Syntax

Syntax:
units unitsBelowHeight height
Parameters:
units: Group or Array of Objects
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