getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Add seeAlso)
Line 26: Line 26:
|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code>
|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code>


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


{{Note
{{Note
Line 35: Line 34:
|text= This command can usefully return the depth of water at the given position when in water.
|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.
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}}
Use [[abs]] to always return a positive number - see {{#Example 3}}.
}}
}}

Revision as of 12:50, 20 January 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 Position
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:
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
Tankbuster - c
Posted on Jun 06, 2017 - 20:02 (UTC)
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}}.