Version: 2020.1
LanguageEnglish
  • C#

NavMeshBuildSettings.ValidationReport

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 string[] ValidationReport(Bounds buildBounds);

Parameters

buildBounds Describes the volume to build NavMesh for.

Returns

string[] The list of violated constraints.

Description

Validates the properties of NavMeshBuildSettings.

Returns a string of violated constraints. - and suggestions for changes for the current values in the build settings and the provided bounds for building the NavMesh.

An empty array is returned if all internal constraints are satisfied.

Some of the settings which you can specify in the NavMeshBuildSettings struct are coupled to each other, meaning there are constraints on the values based on other values. For example, it’s not valid for agentClimb to be larger than agentHeight. Another invalid case is when the vertical size of the buildBounds exceeds the height of 65535 voxel units.

You can use this function to check if the values in NavMeshBuildSettings violate any of the constraints, before starting the NavMesh building process.

Ignoring the violated constraints might give unexpected results when building a NavMesh, but will still produce a NavMesh.

Did you find this page useful? Please give it a rating: