Skip to content

Commit ca2cfc8

Browse files
committed
Updated README with supported version number.
1 parent 32dccf2 commit ca2cfc8

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

README.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,54 @@
1-
⚠️ This branch might require features only available starting with **Unity 2017.2**.
1+
> 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)).
22
33
# Components for Runtime NavMesh Building
44

55
Here we introduce four components for the navigation system:
66

7-
* __NavMeshSurface__ – for building and enabling a navmesh surface for one agent type.
8-
* __NavMeshModifier__ – affects the navmesh generation of navmesh area types, based on the transform hierarchy.
9-
* __NavMeshModifierVolume__ – affects the navmesh generation of navmesh area types, based on volume.
10-
* __NavMeshLink__ – connects same or different navmesh surfaces for one agent type.
7+
* __NavMeshSurface__ – for building and enabling a NavMesh surface for one agent type.
8+
* __NavMeshModifier__ – affects the NavMesh generation of NavMesh area types, based on the transform hierarchy.
9+
* __NavMeshModifierVolume__ – affects the NavMesh generation of NavMesh area types, based on volume.
10+
* __NavMeshLink__ – connects same or different NavMesh surfaces for one agent type.
1111

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

14-
### Documentation (draft)
15-
16-
https://docs.google.com/document/d/1usMrwMHTPNBFyT1hZRt-nQZzRDTciIQRVzmA7MQsFNw
14+
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.
1715

1816
# How To Get Started
1917

20-
Download and install the latest release of Unity 5.6.
18+
Download and install Unity 5.6 or newer.
2119

22-
Clone or download this repository and open the project using the feature build.
23-
Alternatively, you can copy the contents of `Assets/NavMeshComponents` to an existing project.
20+
Clone or download this repository and open the project in Unity.
21+
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.
2422

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

28-
_Note: During the beta cycle features and API are subject to change. Back up existing projects before using.
29-
**Make sure to backup an existing project before opening it with this build**_.
26+
_Note: During the beta cycle features and API are subject to change.\
27+
**Make sure to backup an existing project before opening it with a beta build.**_
3028

3129
# FAQ
3230

33-
Q: Can I bake navmesh at runtime?
34-
A: yes
31+
Q: Can I bake a NavMesh at runtime?
32+
A: Yes.
3533

36-
Q: Can I use navmesh'es for more than one agent size?
37-
A: yes
34+
Q: Can I use NavMesh'es for more than one agent size?
35+
A: Yes.
3836

39-
Q: Can I put a navmesh in a prefab?
40-
A: yes - with some limitations.
37+
Q: Can I put a NavMesh in a prefab?
38+
A: Yes - with some limitations.
4139

42-
Q: How do i connect two navmesh surfaces?
43-
A: Use the NavMeshLink to connect the two sides
40+
Q: How do I connect two NavMesh surfaces?
41+
A: Use the NavMeshLink to connect the two sides.
4442

45-
Q: How do i query the navmesh for one specific size of agent?
46-
A: Use the NavMeshQuery filter when querying the navmesh
43+
Q: How do I query the NavMesh for one specific size of agent?
44+
A: Use the NavMeshQuery filter when querying the NavMesh.
4745

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

5250
Q: What's the use of the new delegate 'NavMesh.onPreUpdate'?
53-
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.
51+
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.
5452

5553
Q: Can I do moving NavMesh platforms?
5654
A: No - new API is required for consistently moving platforms carrying agents.
@@ -59,4 +57,4 @@ Q: Is OffMeshLink now obsolete?
5957
A: No - you can still use OffMeshLink - however you'll find that NavMeshLink is more flexible and have less overhead.
6058

6159
Q: What happened to HeightMesh and Auto Generated OffMeshLinks?
62-
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.
60+
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.

0 commit comments

Comments
 (0)