Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NavMeshBuilder.BuildNavMeshData

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

public static method BuildNavMeshData(buildSettings: AI.NavMeshBuildSettings, sources: List<NavMeshBuildSource>, localBounds: Bounds, position: Vector3, rotation: Quaternion): AI.NavMeshData;
public static AI.NavMeshData BuildNavMeshData(AI.NavMeshBuildSettings buildSettings, List<NavMeshBuildSource> sources, Bounds localBounds, Vector3 position, Quaternion rotation);

Parameters

buildSettingsSettings for the bake process, see NavMeshBuildSettings.
sourcesList of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid.
localBoundsBounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no bounds, i.e. the NavMesh will cover all the inputs.
positionCenter of the NavMeshData. This specifies the origin for the NavMesh tiles (See Also: NavMeshBuildSettings.tileSize).
rotationOrientation of the NavMeshData, you can use this to generate NavMesh with an arbitrary up-vector – e.g. for walkable vertical surfaces.

Returns

NavMeshData Returns a newly built NavMeshData, or null if the NavMeshData was empty or an error occurred. The newly built NavMeshData, or null if the NavMeshData was empty or an error occurred.

Description

Builds a NavMesh data object from the provided input sources.

Note: that NavMeshBuilder.BuildNavMeshData has same effect as creating a new empty NavMeshData and calling NavMeshBuilder.UpdateNavMeshData.