getTerrainHeightASL: Difference between revisions

Latest revision as of 13:09, 20 December 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 (getPosATL 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 [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (in which case the Z value is ignored)
 |r1= [[Number]]
-|x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code>
+|x1= <sqf>_height = getTerrainHeightASL (getPosATL player);</sqf>
-|x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code>
+|x2= <sqf>_height = getTerrainHeightASL [5213,3245];</sqf>
-|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code>
+|x3= <sqf>_seaDepth = abs (getTerrainHeightASL getPosATL player); // sea depth at player's position</sqf>
-|seealso= [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]]
+|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}}
 }}