Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

NavMesh.SamplePosition

public static function SamplePosition(sourcePosition: Vector3, hit: NavMeshHit, maxDistance: float, allowedMask: int): 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.