High Level API Components for Runtime NavMesh Building
C#
Latest commit 32c3812 Jan 18, 2017 @jakobhu jakobhu committed on GitHub Update README.md
fix typo

README.md

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.

Documentation (draft)

https://docs.google.com/document/d/1usMrwMHTPNBFyT1hZRt-nQZzRDTciIQRVzmA7MQsFNw

How To Get Started

Download and install Unity 5.6.0b2 or newer.

Clone or download this repository and open the project using the feature build. Alternatively, you can copy the contents of Assets/NavMeshComponents to an existing project.

Additional examples are available in the Assets/Examples folder.

Note: During the beta cycle features and API are subject to change. Back up existing projects before using. Make sure to backup an existing project before opening it with this build.

FAQ

Q: Can I bake 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.