getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2oa |Game name=
| arma2oa


|1.55|Game version=
|1.55


|gr1= Positions |GROUP1=
|gr1= Positions


| Returns the terrain height above the sea for the given position. |DESCRIPTION=
| Returns the terrain height above the sea for the given position.


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


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


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


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


|x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code> |Example2=
|x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code>


|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code> |Example3=
|x3= <code>_seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code>


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



Revision as of 01:43, 18 January 2021

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: 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

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