getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:ArmA 2 OA: New Scripting Commands List" to "[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List")
m (Undo revision 336253 by Lou Montana (talk))
Tag: Undo
 
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2oa |Game name=
|game1= arma2oa
|version1= 1.55


|1.55|Game version=
|game2= tkoh
____________________________________________________________________________________________
|version2= 1.00


| Returns the terrain height above the sea for the given position. |DESCRIPTION=
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| [[getTerrainHeightASL]] position |SYNTAX=
|gr1= Positions


|p1= position: [[Position2D]] or [[Position3D]] |PARAMETER1=
|descr= Returns the terrain height above the sea for the given position.


| [[Number]] |RETURNVALUE=
|s1= [[getTerrainHeightASL]] position
____________________________________________________________________________________________


|x1= <code>_height = [[getTerrainHeightASL]] ([[position]] [[player]]);</code> |Example1=
|p1= position: [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (in which case the Z value is ignored)


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


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


| [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |SEEALSO=
|x2= <sqf>_height = getTerrainHeightASL [5213,3245];</sqf>
}}


<h3 style="display:none">Notes</h3>
|x3= <sqf>_seaDepth = abs (getTerrainHeightASL getPosATL player); // sea depth at player's position</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[setPosASL]] [[getPosASL]] [[getPosATL]] [[ASLToATL]] [[ATLToASL]] [[getElevationOffset]]
</dl>
}}
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on June 6, 2017 - 20:02 (UTC)</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
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
 
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 13:09, 20 December 2022

A2 OA Logo.png1.55tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=getTerrainHeightASL&oldid=336254"