getTerrainHeightASL: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Killzone Kid (talk | contribs) (format) |
||
(9 intermediate revisions by 5 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 | |x1= <code> _height = [[getTerrainHeightASL]] ([[position]] [[player]]); </code> |= | ||
|x2= <code> _height < | |x2= <code> _height = [[getTerrainHeightASL]] [5213,3245]; </code> |= | ||
|x3= <code> _seadepth = [[abs]] ([[getTerrainHeightASL]] [[getPos]] [[player]]); // sea depth at players position; </code> |= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= See also | | [[setPosASL]], [[getPosASL]], [[getPosATL]], [[ASLToATL]], [[ATLToASL]] |= See also | ||
}} | }} | ||
Line 27: | Line 28: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<h3 style="display:none">Notes</h3> | |||
<dl class="command_description"> | |||
<!-- Note Section BEGIN --> | |||
<!-- Note Section END --> | |||
</dl> | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
Line 35: | Line 42: | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[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
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
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: Uncategorised
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters
- ArmA 2 OA: New Scripting Commands List