Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

NavMesh.SamplePosition

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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