unitsBelowHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(MP arguments, syntax, added example/see also)
Line 5: Line 5:


|1.04|= Game version
|1.04|= Game version
|arg= global|= Arguments in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns units in group below passed height. |= Description
| Returns units in group/array below passed height. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| group or array '''unitsBelowHeight''' height |= Syntax
| units '''unitsBelowHeight''' height |= Syntax


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


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


|p3= |= PARAMETER3  
|p3= |= PARAMETER3  


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


|x1=  <code> _allOnGroudUnits = [[group]] [[player]] [[unitsBelowHeight]] 10; </code> |= EXAMPLE1


|x1=  <pre> _allOnGroudUnits = group player unitsBelowHeight 10 </pre> |= EXAMPLE1
|x2=  <code> _units = [[allUnits]] [[unitsBelowHeight]] 30; </code> |= EXAMPLE2


____________________________________________________________________________________________
____________________________________________________________________________________________


| |= SEEALSO  
| [[allUnits]], [[getPosATL]], [[group]] |= SEEALSO  


|  |= MPBEHAVIOUR  
|  |= MPBEHAVIOUR  

Revision as of 12:44, 20 April 2014

Hover & click on the images for description

Description

Description:
Returns units in group/array below passed height.
Groups:
Uncategorised

Syntax

Syntax:
units unitsBelowHeight height
Parameters:
units: Group or Array of Objects
height: Number - height above terrain level (ATL)
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

Posted on Nov 12, 2009 - 23:46
Lou Montana
the height is calculated above terrain level (ATL), not water level or building level.

Bottom Section