getTerrainHeight: Difference between revisions

Latest revision as of 15:45, 8 November 2023

Hover & click on the images for description

Description:: Returns terrain height at the specified location.
ⓘ
Unlike getTerrainHeightASL which returns the exact position's height, this command returns the height at the closest terrain grid pixel to the provided position:
private _cellWidth = getTerrainInfo # 2; getTerrainHeightASL (_pos apply { _cellWidth * round (_x / _cellWidth) });
Groups:: Diagnostic

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

: 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

@@ Line 4: / Line 4: @@
 |version1= 2.10
-|branch= dev
 |gr1= Diagnostic
-|descr= {{Wiki|WIP}}
+|descr= Returns terrain height at the specified location.
+{{Feature|informative|Unlike [[getTerrainHeightASL]] which returns the exact position's height, this command returns the height at the closest terrain grid pixel to the provided position:
+<sqf>
+private _cellWidth = getTerrainInfo # 2;
+getTerrainHeightASL (_pos apply { _cellWidth * round (_x / _cellWidth) });
+</sqf>
+}}
-|s1= [[getTerrainHeight]]
+|s1= [[getTerrainHeight]] positionWorld
-|r1= [[Number]] -
+|p1= positionWorld: [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - position in world coordinates either in [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
-|x1= <sqf>private _height = getTerrainHeight [worldSize/2, worldSize/2];</sqf>
+|r1= [[Number]] - terrain height
-|seealso=
+|x1= <sqf>private _gridCellHeight = getTerrainHeight getPosWorld player;</sqf>
+|seealso= [[setTerrainHeight]] [[getTerrainInfo]]
 }}