getTerrainHeightASL: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma2oa |Game name= | | arma2oa |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Positions |GROUP1= | |gr1= Positions |GROUP1= | ||
| Returns the terrain height above the sea for the given position. |DESCRIPTION= | | Returns the terrain height above the sea for the given position. |DESCRIPTION= | ||
| [[getTerrainHeightASL]] position |SYNTAX= | | [[getTerrainHeightASL]] position |SYNTAX= | ||
| Line 17: | Line 14: | ||
| [[Number]] |RETURNVALUE= | | [[Number]] |RETURNVALUE= | ||
|x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> |Example1= | |x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> |Example1= | ||
| Line 24: | Line 20: | ||
|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> |Example3= | ||
| [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |SEEALSO= | | [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |SEEALSO= | ||
Revision as of 01:42, 17 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
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