getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
m (Some wiki formatting)
Line 16: Line 16:
|s1= [[getTerrainHeightASL]] position
|s1= [[getTerrainHeightASL]] position


|p1= position: [[Array]] in format [[Position2D]] or [[Position3D]] (in which case the Z value is ignored)
|p1= position: [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (in which case the Z value is ignored)


|r1= [[Number]]
|r1= [[Number]]
Line 24: Line 24:
|x2= <sqf>_height = getTerrainHeightASL [5213,3245];</sqf>
|x2= <sqf>_height = getTerrainHeightASL [5213,3245];</sqf>


|x3= <sqf>_seadepth = abs (getTerrainHeightASL getPosATL player); // sea depth at player's position</sqf>
|x3= <sqf>_seaDepth = abs (getTerrainHeightASL getPosATL player); // sea depth at player's position</sqf>


|seealso= [[setPosASL]] [[getPosASL]] [[getPosATL]] [[ASLToATL]] [[ATLToASL]] [[getElevationOffset]]
|seealso= [[setPosASL]] [[getPosASL]] [[getPosATL]] [[ASLToATL]] [[ATLToASL]] [[getElevationOffset]]
}}
}}

Revision as of 13:04, 21 August 2022

Hover & click on the images for description

Description

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

Syntax

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

Examples

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

Additional Information

See also:
setPosASL getPosASL getPosATL ASLToATL ATLToASL getElevationOffset

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