getTerrainHeightASL: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) 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 | {{Command | ||
| arma2oa | | arma2oa | ||
|1.55 | |1.55 | ||
|gr1= Positions | |gr1= Positions | ||
| Returns the terrain height above the sea for the given position. | | Returns the terrain height above the sea for the given position. | ||
| [[getTerrainHeightASL]] position | | [[getTerrainHeightASL]] position | ||
|p1= position: [[Position2D]] or [[Position3D]] | |p1= position: [[Position2D]] or [[Position3D]] | ||
| [[Number]] | | [[Number]] | ||
|x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> | |x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> | ||
|x2= <code>_height = [[getTerrainHeightASL]] [5213,3245];</code> | |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]] [[getPos]] [[player]]); {{cc|sea depth at players position;}}</code> | ||
| [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] | | [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] | ||
}} | }} | ||
Revision as of 00:43, 18 January 2021
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
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
Categories:
- Scripting Commands
- Introduced with Arma 2: Operation Arrowhead version 1.55
- Arma 2: Operation Arrowhead: New Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Command Group: Positions
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 2: Operation Arrowhead: New Scripting Commands List