getTerrainHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix example)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
|version1= 2.10
|version1= 2.10


|branch= dev


|gr1= Diagnostic
|gr1= Diagnostic
Line 18: Line 17:
|s1= [[getTerrainHeight]] positionWorld
|s1= [[getTerrainHeight]] positionWorld


|p1= positionWorld: [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - Position in world coordinates either in [[Position#Introduction|Position2D]] or [[Position#Introduction|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

Latest revision as of 15:45, 8 November 2023

Hover & click on the images for description

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

Syntax:
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 _gridCellHeight = getTerrainHeight getPosWorld player;

Additional Information

See also:
setTerrainHeight getTerrainInfo

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