Legacy Documentation: Version 4.3.0
NavMesh.SamplePosition
static function SamplePosition(sourcePosition: Vector3, hit: NavMeshHit, maxDistance: float, allowedMask: int): bool;
static bool SamplePosition(Vector3 sourcePosition, NavMeshHit hit, float maxDistance, int allowedMask);
static def SamplePosition(sourcePosition as Vector3, hit as NavMeshHit, maxDistance as float, allowedMask as int) as bool
Parameters

sourcePosition The origin of the sample query.
hit Holds the properties of the resulting location.
maxDistance Sample within this distance from sourcePosition.
allowedMask A mask specifying which NavMesh layers are allowed when finding the nearest point.
Returns
bool True if a nearest point is found.
Description

Sample the NavMesh closest to the point specified.