diag getTerrainHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example and some formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


|game1= arma3diag
|game1= arma3


|version1= 2.03
|branch= diag
 
|version1= 2.04


|gr1= Diagnostic
|gr1= Diagnostic


|descr= Returns terrain height at the specified location.
|descr= Returns terrain height at the specified location.
{{Feature|informative|Unlike [[getTerrainHeightASL]] which  returns the exact position's height, this commands returns the apex of the terrain polygon.}}
{{Feature|obsolete|This command is subject to be removed and replaced with: [[getTerrainHeight]]|arma3|2.10}}


{{Feature | Warning | Command is only available when using [[Arma 3: Diagnostics Exe]] on Dev-Branch.}}
|s1= [[diag_getTerrainHeight]] positionWorld
 
|s1= '''diag_getTerrainHeight''' positionWorld


|p1= positionWorld: [[Position2D]] or [[Position3D]] - Position in world coordinates either in [[Position2D]] or [[Position3D]]
|p1= positionWorld: [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - position in world coordinates either in [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]


|r1= [[Number]] - Terrain height
|r1= [[Number]] - terrain height


|x1= <code>[[private]] _h = '''diag_getTerrainHeight''' [[position]] [[player]];</code>
|x1= <sqf>private _h = diag_getTerrainHeight position player;</sqf>


|seealso= [[diag_setTerrainHeight]]
|seealso= [[diag_setTerrainHeight]]
}}
}}

Latest revision as of 15:45, 8 November 2023

Hover & click on the images for description
Only available in Diagnostic branch(es).

Description

Description:
Returns terrain height at the specified location.
Unlike getTerrainHeightASL which returns the exact position's height, this commands returns the apex of the terrain polygon.
🕖
This information is obsolete as of Arma 3 v2.10. Reason: This command is subject to be removed and replaced with: getTerrainHeight
Groups:
Diagnostic

Syntax

Syntax:
diag_getTerrainHeight positionWorld
Parameters:
positionWorld: Position2D or Position3D - position in world coordinates either in Position2D or Position3D
Return Value:
Number - terrain height

Examples

Example 1:
private _h = diag_getTerrainHeight position player;

Additional Information

See also:
diag_setTerrainHeight

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