Version: 2021.3
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

NavMeshWorld

struct in UnityEngine.Experimental.AI

/

Implemented in:UnityEngine.AIModule

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

Description

Assembles together a collection of NavMesh surfaces and links that are used as a whole for performing navigation operations.

Operations are initialized against one world, can use only the NavMeshes inside that world and are not aware of the existence of any other NavMeshWorld.

Copying this object only produces a new reference to the same NavMesh data, it does not duplicate the data in memory.

Important note: Currently only a single NavMesh world can be used and a reference to it can be obtained through the NavMeshWorld.GetDefaultWorld method. In the future, multiple NavMesh worlds will be able to be created and any two of them will be completely isolated from each other.

Additional resources: NavMeshQuery.

Public Methods

AddDependencyTells the NavMesh world to halt any changes until the specified job is completed.
IsValidReturns true if the NavMeshWorld has been properly initialized.

Static Methods

GetDefaultWorldReturns a reference to the single NavMeshWorld that can currently exist and be used in Unity.