public struct NavWorld : IDisposable, IEquatable<NavWorld>

The navigation mesh world assembles together a collection of NavMesh surfaces and links that are used as a whole for performing navigation operations. NavWorld operations can be executed inside jobs (IJob, IJobFor), as opposed to the operations in the NavMesh-related structures.

Operations are initialized against one world, can use only the NavMeshes inside that world and aren't aware of the existence of any other NavWorld.

Copying this object produces only a new reference to the same NavMesh data. It doesn't duplicate the data in memory. Use NavWorld.Equals or the operator to determine whether two NavWorld handles refer to the same navigation data.

Every call to NavWorld.GetDefaultWorld produces a handle that you must release with NavWorld.Dispose when you stop using it. Obtain the handle once and keep it for as long as you run queries, rather than requesting a new one on every frame.

To obtain a path between two locations on the NavMesh, first create a NavQueryBuffer with a value in the range from 1 to 65,535, then call the following NavWorld methods in this order: , , , . You can call repeatedly. These methods store their intermediate state within the NavQueryBuffer. Other methods can be called in any order since they don't change state data.

All methods throw exceptions if any of their parameters aren't valid when executed in the Editor.

NavWorld.IsValid checks a NavWorld, a NavNode, or a NavLocation, so you can call it beforehand when their validity isn't already guaranteed. It doesn't cover every argument that a method validates, such as the size of an array or the agent type behind a location. These checks are optional: skip them when the surrounding code already produces valid arguments and you don't want to pay for the verification on every call.

Important: You can use only a single NavMesh world. Obtain a reference to it through the NavWorld.GetDefaultWorld method.