Official Unity package for generating NavMeshes in runtime.

James Peret e3b29e3ce0 Fixed package display name and bumped version to 2019.3.1 %!s(int64=2) %!d(string=hai) anos
Assets 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
Documentation 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
Packages 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
.gitattributes 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
.gitignore 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
Assets.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
Documentation.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
LICENSE 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
LICENSE.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
Packages.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
ProjectSettings.zip 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
ProjectSettings.zip.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
README.md 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
README.md.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos
package.json e3b29e3ce0 Fixed package display name and bumped version to 2019.3.1 %!s(int64=2) %!d(string=hai) anos
package.json.meta 19964d2185 Initial commit %!s(int64=2) %!d(string=hai) anos

README.md

Please use the branch matching the version of your Unity editor: master for the latest released version, 2019.3, 2018.3 for up to 2018.4-LTS and 2019.2, 2018.2, 2018.1, 2017.2 for up to 2017.4-LTS, 2017.1, 5.6.

Components for Runtime NavMesh Building

Here we introduce four components for the navigation system:

  • NavMeshSurface – for building and enabling a NavMesh surface for one agent type.
  • NavMeshModifier – affects the NavMesh generation of NavMesh area types, based on the transform hierarchy.
  • NavMeshModifierVolume – affects the NavMesh generation of NavMesh area types, based on volume.
  • NavMeshLink – connects same or different NavMesh surfaces for one agent type.

These components comprise the high level controls for building and using NavMeshes at runtime as well as edit time.

Detailed information can be found in the Documentation section or in the NavMesh building components section of the Unity Manual.

How To Get Started

Download and install Unity 5.6 or newer.

Clone or download this repository and open the project in Unity. Alternatively, you can copy the contents of Assets/NavMeshComponents to an existing project. Make sure to select a branch of the repository that matches the Unity version.

Additional examples are available in the Assets/Examples folder. The examples are provided "as is". They are neither generic nor robust, but serve as inspiration.

Note: During the beta cycle features and API are subject to change.\ Make sure to backup an existing project before opening it with a beta build.

FAQ

Q: Can I bake a NavMesh at runtime?
A: Yes.

Q: Can I use NavMesh'es for more than one agent size?
A: Yes.

Q: Can I put a NavMesh in a prefab?
A: Yes - with some limitations.

Q: How do I connect two NavMesh surfaces?
A: Use the NavMeshLink to connect the two sides.

Q: How do I query the NavMesh for one specific size of agent?
A: Use the NavMeshQuery filter when querying the NavMesh.

Q: What's the deal with the 'DefaultExecutionOrder' attribute?
A: It gives a way of controlling the order of execution of scripts - specifically it allows us to build a NavMesh before the (native) NavMeshAgent component is enabled.

Q: What's the use of the new delegate 'NavMesh.onPreUpdate'?
A: It allows you to hook in to controlling the NavMesh data and links set up before the navigation update loop is called on the native side.

Q: Can I do moving NavMesh platforms?
A: No - new API is required for consistently moving platforms carrying agents.

Q: Is OffMeshLink now obsolete?
A: No - you can still use OffMeshLink - however you'll find that NavMeshLink is more flexible and have less overhead.

Q: What happened to HeightMesh and Auto Generated OffMeshLinks?
A: They're not supported in the new NavMesh building feature. HeightMesh will be added at some point. Auto OffMeshLink generation will possibly be replaced with a solution that allows better control of placement.