struct in UnityEngine.Experimental.AI
Object used for doing navigation operations in a NavMeshWorld.
NavMeshQuery operations can be executed inside jobs (IJob, IJobParallelFor), as opposed to the operations in the NavMesh-related structures.
To obtain a path between two locations on the NavMesh, you must create a NavMeshQuery with a pathNodePoolSize
value in the range from 1 to 65,535. After creating a NavMeshQuery, you must call the following methods in this order: BeginFindPath
, UpdateFindPath
(can be repeated), EndFindPath
, GetPathResult
. These methods store state data within the NavMeshQuery. Other methods can be called in any order since they do not change state data.
All methods throw exceptions if any of their parameters are not valid when executed in the Editor.
Note: The intended feature set for NavMeshQuery is not yet fully complete.
NavMeshQuery | Creates the NavMeshQuery object and allocates memory to store NavMesh node information, if required. |
BeginFindPath | Initiates a pathfinding operation between two locations on the NavMesh. |
CreateLocation | Returns a valid NavMeshLocation for a position and a polygon provided by the user. |
Dispose | Destroys the NavMeshQuery and deallocates all memory used by it. |
EndFindPath | Obtains the number of nodes in the path that has been computed during a successful NavMeshQuery.UpdateFindPath operation. |
GetAgentTypeIdForPolygon | Returns the identifier of the agent type the NavMesh was baked for or for which the link has been configured. |
GetEdgesAndNeighbors | Retrieves the vertices of a given node and the identifiers of all the navigation nodes to which it connects. |
GetPathResult | Copies into the provided array the list of NavMesh nodes that form the path found by the NavMeshQuery operation. |
GetPolygonType | Returns whether the NavMesh node is a polygon or a link. |
GetPortalPoints | Obtains the end points of the line segment common to two adjacent NavMesh nodes. |
IsValid | Returns true if the node referenced by the specified PolygonId is active in the NavMesh. |
MapLocation | Finds the closest point and PolygonId on the NavMesh for a given world position. |
MoveLocation | Translates a NavMesh location to another position without losing contact with the surface. |
MoveLocations | Translates a series of NavMesh locations to other positions without losing contact with the surface. |
MoveLocationsInSameAreas | Translates a series of NavMesh locations to other positions without losing contact with the surface, given one common area filter for all of them. |
PolygonLocalToWorldMatrix | Returns the transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only). |
PolygonWorldToLocalMatrix | Returns the inverse transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only). |
Raycast | Trace a line between two points on the NavMesh. |
UpdateFindPath | Continues a path search that is in progress. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.