getTerrainHeightASL: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (removed note - commands for that exist; (see also))
(format)
(5 intermediate revisions by 2 users not shown)
Line 12: Line 12:
| '''getTerrainHeightASL''' position |= Syntax
| '''getTerrainHeightASL''' position |= Syntax


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


| [[Number]] |= Return value
| [[Number]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code> _height <nowiki>=</nowiki> '''getTerrainHeightASL''' ([[position]] [[player]]); </code> |=  
|x1= <code> _height = [[getTerrainHeightASL]] ([[position]] [[player]]); </code> |=  
|x2= <code> _height <nowiki>=</nowiki> '''getTerrainHeightASL''' [5213,3245]; </code> |=  
|x2= <code> _height = [[getTerrainHeightASL]] [5213,3245]; </code> |=
|x3= <code> _seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); // sea depth at players position; </code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 44: Line 45:
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:ArmA 2 OA: 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 [https://community.bistudio.com/wiki/abs abs] to always return a positive number. See example 3
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 09:59, 7 June 2017

A2 OA Logo.png1.55
Hover & click on the images for description

Description

Description:
Returns the terrain height above the sea for the given position.
Groups:
Uncategorised

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

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
Retrieved from "https://community.bistudio.com/wiki?title=getTerrainHeightASL&oldid=103390"