Clarify NavigationServer created regions

Clarify that NavigationServer create navigation regions do not join a navigation map automatically like a NavigationRegion node would. The server API created regions need a manual map assignment with region_set_map().
This commit is contained in:
smix8
2023-01-03 03:33:53 +01:00
parent 945853908b
commit 9b190a7254

View File

@@ -34,9 +34,9 @@ Regions can be enabled / disabled and if disabled will not contribute to future
Creating new navigation regions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New navigation regions will automatically register to the default world navigation map.
New NavigationRegion nodes will automatically register to the default world navigation map for their 2D/3D dimension.
The region RID can be obtained from NavigationRegion Nodes with ``get_region_rid()``.
The region RID can then be obtained from NavigationRegion Nodes with ``get_region_rid()``.
.. tabs::
.. code-tab:: gdscript GDScript
@@ -47,6 +47,8 @@ The region RID can be obtained from NavigationRegion Nodes with ``get_region_rid
New regions can also be created with the NavigationServer API and added to any existing map.
If regions are created with the NavigationServer API directly they need to be assigned a navigation map manually.
.. tabs::
.. code-tab:: gdscript GDScript