⚠️ This branch might require features only available starting with **Unity 2017.2**.
> This branch requires **Unity 2017.2**. For older or future versions of Unity please use a matching branch ([master](../..), [5.6](../../tree/5.6), [2017.1](../../tree/2017.1), [2018.1](../../tree/2018.1)).
# 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.
* __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](Documentation) section or in the [NavMesh building components](https://docs.unity3d.com/Manual/NavMesh-BuildingComponents.html) section of the Unity Manual.
# How To Get Started
Download and install the latest release of Unity 5.6.
Download and install Unity 5.6 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.
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. Back up existing projects before using.
**Make sure to backup an existing project before opening it with this build**_.
_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 navmesh at runtime?
A: yes
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 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: 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 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: 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.
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.
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.
...
...
@@ -59,4 +57,4 @@ 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.
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.
