NavMesh building components provide you with additional controls for building (also known as baking) and using NavMeshes at run time and in the Unity Editor.
NavMesh Modifiers are not in the Unity standard install; see documentation on high-level NavMesh building components for information on how to access them.
agentTypeID
– ID describing the Agent type the NavMesh should be built for.collectObjects
– Defines how input geometry is collected from the Scene, one of UnityEngine.AI.CollectObjects:
All
– Use all objects in the scene.Volume
– Use all GameObjects in the Scene that touch the bounding volume (see size
and center
)Children
– use all objects which are children to the Game Object where the NavMesh Surface is attached to.size
– Dimensions of the build volume. The size is not affected by scaling.center
– Center of the build volume relative to the transform center.layerMask
– Bitmask defining the layers on which the GameObjects must be to be included in the baking.useGeometry
– Defines which geometry is used for baking, one of UnityEngine.NavMeshCollectGeometry
:
RenderMeshes
– Use geometry from render meshes and terrainsPhysicsColliders
– Use geometry from colliders and terrains.defaultArea
– Default area type for all input geometries, unless otherwise specified.ignoreNavMeshAgent
– True if GameObjects with a Nav Mesh Agent component should be ignored as input.ignoreNavMeshObstacle
– True if GameObjects with a Nav Mesh Obstacle component should be ignored as input.overrideTileSize
– True if tile size is set.tileSize
– Tile size in voxels (the component description includes information on how to choose tile size).overrideVoxelSize
– True if the voxel size is set.voxelSize
– Size of the voxel in world units (the component description includes information on how to choose tile size).buildHeightMesh
– Not implemented.bakedNavMeshData
– Reference to the NavMeshData the surface uses, or null if not set.activeSurfaces
– List of all active NavMeshSurfaces.
Note: The above values affect how the bake results, and so you must call Bake()
to include them.
void Bake ()
Bakes a new NavMeshData based on the parameters set on NavMesh Surface. The data can be accessed via bakedNavMeshData
.
overrideArea
– True if the modifier overrides area type.area
– New area type to apply.ignoreFromBuild
– True if the GameObject which contains the modifier and its children should be not be used to NavMesh baking.activeModifiers
– List of all active NavMeshModifiers.bool AffectsAgentType(int agentTypeID)
Returns true if the modifier applies to the specified Agent type, otherwise false.
size
– Size of the bounding volume in local space units. Transform affects the size.center
– Center of the bounding volume in local space units. Transform affects the center.area
– Area type to apply for the NavMesh areas that are inside the bounding volume.bool AffectsAgentType(int agentTypeID)
Returns true of the the modifier applies for the specified Agent type.
agentTypeID
– The type of Agent that can use the link.startPoint
– Start point of the link in local space units. Transform affects the location.endPoint
– End point of the link in local space units. Transform affects the location.width
– Width of the link in world length units.bidirectional
– If true, the link can be traversed both ways. If false, the link can be traversed only from start to end.autoUpdate
– If true, the link updates the end points to follow the transform of the GameObject every frame.area
– Area type of the link (used for pathfinding cost).void UpdateLink()
Updates the link to match the associated transform. This is useful for updating a link, for example after changing the transform position, but is not necessary if the autoUpdate
property is enabled. However calling UpdateLink
can have a much smaller performance impact if you rarely change the link transform.
2017–05–26 Page published with limited editorial review
New feature in 5.6
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?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
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:
Thanks for helping to make the Unity documentation better!
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.