Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Navmesh > Recast > rcBuildCompactHeightfield

Light Theme

Dark Theme

rcBuildCompactHeightfield

Builds a compact heightfield representing open space, from a heightfield representing solid space.

Windows

MacOS

Linux

References

Module	Navmesh
Header	/Engine/Source/Runtime/Navmesh/Public/Recast/Recast.h
Include	#include "Recast/Recast.h"
Source	/Engine/Source/Runtime/Navmesh/Private/Recast/Recast.cpp

Syntax

bool rcBuildCompactHeightfield
(
    rcContext * ctx,
    const int walkableHeight,
    const int walkableClimb,
    rcHeightfield & hf,
    rcCompactHeightfield & chf
)

Remarks

Builds a compact heightfield representing open space, from a heightfield representing solid space.

This is just the beginning of the process of fully building a compact heightfield. Various filters may be applied applied, then the distance field and regions built. E.g: rcBuildDistanceField and rcBuildRegions

See the rcConfig documentation for more information on the configuration parameters.

Returns

True if the operation completed successfully.

Parameters

Parameter	Description
ctx	The build context to use during the operation.
walkableHeight	Minimum floor to 'ceiling' height that will still allow the floor area to be considered walkable. [Limit: >= 3] [Units: vx]
walkableClimb	Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
hf	The heightfield to be compacted.
chf	The resulting compact heightfield. (Must be pre-allocated.)