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

NavMeshQuery.GetPathResult

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 int GetPathResult(NativeSlice<PolygonId> path);

Parameters

path Data array to be filled with the sequence of NavMesh nodes that comprises the found path.

Returns

int Number of path nodes successfully copied into the provided array.

Description

Copies into the provided array the list of NavMesh nodes that form the path found by the NavMeshQuery operation.

Must be called at the end of a successful NavMeshQuery.BeginFindPath - NavMeshQuery.UpdateFindPath - NavMeshQuery.EndFindPath sequence in order to obtain the resulting path.

Can be called multiple times as long as NavMeshQuery.BeginFindPath has not been called for that same query.

If the resulting path, stored in the query, is longer than the length of the provided array, the nodes are still copied (from the beginning of the path up to the array's length).

Important: If the start NavMesh node of the path has been removed by a NavMesh modification since the initial BeginFindPath call of the pathfinding operation, the returned path will be empty.