location | Position to be moved across the NavMesh surface. |
target | World position you require the agent to move to. |
areaMask | Bitmask with values of 1 set at the indices corresponding to areas that can be traversed, and with values of 0 for areas that should not be traversed. This parameter can be omitted, in which case it defaults to NavMesh.AllAreas. See Also: Areas and Costs. |
NavMeshLocation
A new location on the NavMesh placed as closely as possible to the specified target
position.
The start location
is returned when that start is inside an area which is not allowed by the areaMask
.
Translates a NavMesh location to another position without losing contact with the surface.
Returns the location on the NavMesh that is closest to the target
position and that also has a continuous connection on the NavMesh surface through the allowed area types all the way to the start position specified by the location
parameter. If the target
position is outside the edges of the surface or of its allowed areas, a position at the edge is returned.
The movement does not cross NavMeshLinks or Off-mesh Links.
The result might not be accurate (the closest) if the pathNodePoolSize
value in the NavMeshQuery initialization was not large enough to accommodate all the nodes that needed to be traversed in order to find a connection between location.position
and target
.
See Also: NavMeshQuery.MoveLocations, NavMeshQuery.MoveLocationsInSameAreas.
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.