getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |x2=" to "|Example1= |x2=")
Line 10: Line 10:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''getTerrainHeightASL''' position |SYNTAX=
| [[getTerrainHeightASL]] position |SYNTAX=


|p1= position: [[Position2D]] or [[Position3D]] |=  
|p1= position: [[Position2D]] or [[Position3D]] |PARAMETER1=


| [[Number]] |RETURNVALUE=
| [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code> _height = [[getTerrainHeightASL]] ([[position]] [[player]]); </code> |Example1=
|x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> |Example1=


|x2= <code> _height = [[getTerrainHeightASL]] [5213,3245]; </code> |=  
|x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code> |Example2=
|x3= <code> _seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); // sea depth at players position; </code> |=
 
|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code> |Example3=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |SEEALSO=
| [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |SEEALSO=
}}
}}


Line 52: Line 53:
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
<dd class="note">
This command can usefully return the depth of water at the given position when in water. Note that the number it returns is the depth, albiet expressed as a negative number. Use [https://community.bistudio.com/wiki/abs abs] to always return a positive number. See example 3
This command can usefully return the depth of water at the given position when in water. Note that the number it returns is the depth, albiet expressed as a negative number. Use [[abs]] to always return a positive number. See example 3


</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 14:13, 3 September 2019

Hover & click on the images for description

Description

Description:
Returns the terrain height above the sea for the given position.
Groups:
Uncategorised

Syntax

Syntax:
getTerrainHeightASL position
Parameters:
position: Position2D or Position3D
Return Value:
Number

Examples

Example 1:
_height = getTerrainHeightASL (position player);
Example 2:
_height = getTerrainHeightASL [5213,3245];
Example 3:
_seadepth = abs (getTerrainHeightASL getPos player); // sea depth at players position;

Additional Information

See also:
setPosASLgetPosASLgetPosATLASLToATLATLToASL

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

Notes

Bottom Section

Posted on June 6, 2017 - 20:02 (UTC)
Tankbuster
This command can usefully return the depth of water at the given position when in water. Note that the number it returns is the depth, albiet expressed as a negative number. Use abs to always return a positive number. See example 3