getTerrainHeightASL: Difference between revisions

Revision as of 00:46, 12 February 2022

Hover & click on the images for description

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

Syntax:: getTerrainHeightASL position
Parameters:: position: Array in format Position2D or Position3D (in which case the Z value is ignored)
Return Value:: Number

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

See also:: setPosASL getPosASL getPosATL ASLToATL ATLToASL getElevationOffset

: 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

@@ Line 16: / Line 16: @@
 |s1= [[getTerrainHeightASL]] position
-|p1= position: [[Array]] in format [[Position]]
+|p1= position: [[Array]] in format [[Position2D]] or [[Position3D]] (in which case the Z value is ignored)
 |r1= [[Number]]
@@ Line 24: / Line 24: @@
 |x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code>
-|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code>
+|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPosATL]] [[player]]); {{cc|sea depth at player's position}}</code>
 |seealso= [[setPosASL]] [[getPosASL]] [[getPosATL]] [[ASLToATL]] [[ATLToASL]] [[getElevationOffset]]
-}}
-{{Note
-|user= Tankbuster
-|timestamp= 20170606200200
-|text= 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}}.
 }}