API reference
NavMeshSurface Class
Extends MonoBehaviour, ISurface
Encapsulating class that wraps a Unity navigation mesh as an ISurface for use in Interaction SDK logic (comparable to how ColliderSurface wraps a Unity Collider).
NavMeshSurface is primarily used in locomotion scenarios to allow an entire floorspace to be navigated as a single large interactable.
Properties
float SnapDistance[Get]
The default distance, in world space, across which targeting should "snap" to the navigation mesh.
Functionally, this value works as a constant addition to the maxDistance argument of ClosestSurfacePoint(in Vector3, out SurfaceHit, float).
float VoxelSize[Get]
Used in internal traversal calculations; making this value larger may reduce compute costs when dealing with large-scale locomotion, but at the cost of precision.
bool CalculateHitNormals[Get]
Determines whether normals on hit calculations are calculated robustly or just assumed to be the world-space up vector.
Since most navigation meshes are flat, typical usage should this setting as false (the default).
Fields
Transform Transform[Get]
Implementation of ISurface.Transform; for details, please refer to the related documentation provided for that property.
Protected Fields
bool _started[Get]
Protected Functions
virtual void Start ( )
Member Functions
bool ClosestSurfacePoint
( in Vector3 point,
out SurfaceHit surfaceHit,
float maxDistance )
Implementation of ISurface.ClosestSurfacePoint(in Vector3, out SurfaceHit, float); for details, please refer to the related documentation provided for that property.
bool Raycast
( in Ray ray,
out SurfaceHit surfaceHit,
float maxDistance )
Implementation of ISurface.Raycast(in Ray, out SurfaceHit, float); for details, please refer to the related documentation provided for that property.
void InjectOptionalAreaName
( string areaName )
void InjectOptionalAgentIndex
( int agentIndex )
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta