Document MeshLibrary navmesh export (#5863)

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
This commit is contained in:
smix8
2022-06-08 13:31:52 +02:00
committed by GitHub
parent 203fbd35c0
commit 869830c6ba
2 changed files with 26 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@@ -62,6 +62,32 @@ Materials
Only the materials from within the meshes are used when generating the mesh
library. Materials set on the node will be ignored.
NavigationMeshes
----------------
Like all mesh instances, MeshLibrary items can be assigned a :ref:`class_NavigationMesh`
resource, which can be created manually, or baked as described below.
To create the NavigationMesh from a MeshLibrary scene export, place a
:ref:`class_NavigationRegion3D` child node below the main MeshInstance for the GridMap
item. Add a valid NavigationMesh resource to the NavigationRegion3D and some source
geometry nodes below and bake the NavigationMesh.
.. note::
With small grid cells it is often necessary to reduce the NavigationMesh properties
for agent radius and region minimum size.
.. image:: img/meshlibrary_scene.png
Nodes below the NavigationRegion3D are ignored for the MeshLibrary scene export, so
additional nodes can be added as source geometry just for baking the navmesh.
.. warning::
The baked cell size of the NavigationMesh must match the NavigationServer map cell
size to properly merge the navigation meshes of different grid cells.
Exporting the MeshLibrary
-------------------------