getTerrainHeight: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
m (Some wiki formatting)
 
(2 intermediate revisions by one other user not shown)
Line 5: Line 5:




|gr1= Diagnostic
|gr1= Positions


|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 command returns the height at the closest terrain grid pixel to the provided position:
{{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>
<sqf>
private _cellWidth = getTerrainInfo # 2;
private _cellWidth = getTerrainInfo # 2;
Line 17: Line 18:
|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: [[Array]] format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - world coordinates


|r1= [[Number]] - terrain height
|r1= [[Number]] - terrain height
Line 23: Line 24:
|x1= <sqf>private _gridCellHeight = getTerrainHeight getPosWorld player;</sqf>
|x1= <sqf>private _gridCellHeight = getTerrainHeight getPosWorld player;</sqf>


|seealso= [[setTerrainHeight]] [[getTerrainInfo]]
|seealso= [[setTerrainHeight]] [[getTerrainHeightASL]] [[getTerrainInfo]]
}}
}}

Latest revision as of 14:32, 20 September 2025

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:
Positions

Syntax

Syntax:
getTerrainHeight positionWorld
Parameters:
positionWorld: Array format Position2D or Position3D - world coordinates
Return Value:
Number - terrain height

Examples

Example 1:
private _gridCellHeight = getTerrainHeight getPosWorld player;

Additional Information

See also:
setTerrainHeight getTerrainHeightASL 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