Version: 2023.1
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

NavMeshQuery.CreateLocation

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

Submission failed

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

Close

Cancel

Declaration

public Experimental.AI.NavMeshLocation CreateLocation(Vector3 position, Experimental.AI.PolygonId polygon);

Parameters

position World position of the NavMeshLocation to be created.
polygon Valid identifier for the NavMesh node.

Returns

NavMeshLocation Object containing the desired position and NavMesh node.

Description

Returns a valid NavMeshLocation for a position and a polygon provided by the user.

The returned position will be the point on the surface of the required NavMesh polygon that is closest to the specified position.

Other methods for obtaining reliable positions on the NavMesh are: NavMeshQuery.MapLocation, NavMeshQuery.MoveLocation and NavMeshQuery.GetPortalPoints.