class in UnityEngine.AI
/
Implemented in:UnityEngine.AIModule
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.
CloseFor 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.
CloseSingleton class to access the baked NavMesh.
Use the NavMesh class to perform spatial queries such as pathfinding and walkability tests. This class also lets you set the pathfinding cost for specific area types, and tweak the global behavior of pathfinding and avoidance.
Before you can use spatial queries, you must first bake the NavMesh to your scene.
See also:
• Create a NavMesh – for more information on how to setup and bake NavMesh
• Areas and Costs – to learn how to use different Area types.
• NavMeshAgent – to learn how to control and move NavMesh Agents.
• NavMeshObstacle – to learn how to control NavMesh Obstacles using scripting.
• NavMeshLink – to learn how to control Off-Mesh Links using scripting.
AllAreas | Area mask constant that includes all NavMesh areas. |
avoidancePredictionTime | Describes how far in the future the agents predict collisions for avoidance. |
onPreUpdate | Set a function to be called before the NavMesh is updated during the frame update execution. |
pathfindingIterationsPerFrame | The maximum number of nodes processed for each frame during the asynchronous pathfinding process. |
AddLink | Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct. |
AddNavMeshData | Adds the specified NavMeshData to the game. |
CalculatePath | Calculate a path between two points and store the resulting path. |
CalculateTriangulation | Calculates triangulation of the current navmesh. |
CreateSettings | Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building. |
FindClosestEdge | Locate the closest NavMesh edge from a point on the NavMesh. |
GetAreaCost | Gets the cost for path finding over geometry of the area type. |
GetAreaFromName | Returns the area index for a named NavMesh area type. |
GetAreaNames | Get all the NavMesh area names. |
GetLinkOwner | Gets the object, if any, that is associated with the link instance. |
GetSettingsByID | Returns an existing entry of NavMesh build settings. |
GetSettingsByIndex | Returns an existing entry of NavMesh build settings by its ordered index. |
GetSettingsCount | Returns the number of registered NavMesh build settings. |
GetSettingsNameFromID | Returns the name associated with the NavMesh build settings matching the provided agent type ID. |
IsLinkActive | Determines whether the instance of the link can be used to calculate paths, and if NavMesh agents can move over it. |
IsLinkOccupied | Determines whether or not a NavMesh agent is currently using this link. |
IsLinkValid | Determines whether the link instance is part of the current data used for navigation. |
Raycast | Trace a line between two points on the NavMesh. |
RemoveAllNavMeshData | Removes all NavMesh surfaces and links from the game. |
RemoveLink | Removes a link from the NavMesh. |
RemoveNavMeshData | Removes the specified NavMeshDataInstance from the game, making it unavailable for agents and queries. |
RemoveSettings | Removes the build settings matching the agent type ID. |
SamplePosition | Finds the nearest point based on the NavMesh within a specified range. |
SetAreaCost | Sets the cost for finding path over geometry of the area type on all agents. |
SetLinkActive | Activates or deactivates the link instance. An active link instance can be traversed by agents and used to plan paths, but a deactivated link cannot. |
SetLinkOwner | Associates an object with the instance of a link. |
OnNavMeshPreUpdate | Registers callback methods to be invoked before the NavMesh system updates. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.