The NavMeshBuildSettings struct allows you to specify a collection of settings which describe the dimensions and limitations of a particular agent type.
You might want to define multiple NavMeshBuildSettings if your game involves characters with large differences in height, width or climbing ability.
You can also use this struct to control the precision and granularity of the build process, by setting the voxel and tile sizes. Some of the values are coupled, meaning there are constraints on the values based on other values. For example, it’s not valid for agentClimb to be larger than agentHeight.
To help diagnose violations of these rules, a special method ValidationReport can be evaluated.
agentClimb | The maximum vertical step size an agent can take. |
agentHeight | The height of the agent for baking in world units. |
agentRadius | The radius of the agent for baking in world units. |
agentSlope | The maximum slope angle which is walkable (angle in degrees). |
agentTypeID | The agent type ID the NavMesh will be baked for. |
debug | Options for collecting debug data during the build process. |
maxJobWorkers | The maximum number of worker threads that the build process can utilize when building a NavMesh with these settings. |
minRegionArea | The approximate minimum area of individual NavMesh regions. |
overrideTileSize | Enables overriding the default tile size. See Also: tileSize. |
overrideVoxelSize | Enables overriding the default voxel size. See Also: voxelSize. |
tileSize | Sets the tile size in voxel units. |
voxelSize | Sets the voxel size in world length units. |
ValidationReport | Validates the properties of NavMeshBuildSettings. |
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.