Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

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

sourcePositionThe origin of the sample query.
hitHolds the properties of the resulting location.
maxDistanceSample within this distance from sourcePosition.
allowedMaskA 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.