godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Merge pull request #106290 from smix8/navmanager

Browse Source 
Make NavigationServer backend engine selectable
This commit is contained in:
Thaddeus Crews
2025-10-30 10:46:00 -05:00
parent 9b0620bf5f 419fc6e22d
commit 879bd6eb94
13 changed files with 439 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/@GlobalScope.xml
View File

@@ -1608,9 +1608,15 @@
<member name="NavigationServer2D" type="NavigationServer2D" setter="" getter="">
The [NavigationServer2D] singleton.
</member>
<member name="NavigationServer2DManager" type="NavigationServer2DManager" setter="" getter="">
The [NavigationServer2DManager] singleton.
</member>
<member name="NavigationServer3D" type="NavigationServer3D" setter="" getter="">
The [NavigationServer3D] singleton.
</member>
<member name="NavigationServer3DManager" type="NavigationServer3DManager" setter="" getter="">
The [NavigationServer3DManager] singleton.
</member>
<member name="OS" type="OS" setter="" getter="">
The [OS] singleton.
</member>

30
doc/classes/NavigationServer2DManager.xml Normal file
View File

@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationServer2DManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A singleton for managing [NavigationServer2D] implementations.
</brief_description>
<description>
[NavigationServer2DManager] is the API for registering [NavigationServer2D] implementations and setting the default implementation.
[b]Note:[/b] It is not possible to switch servers at runtime. This class is only used on startup at the server initialization level.
</description>
<tutorials>
</tutorials>
<methods>
<method name="register_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="create_callback" type="Callable" />
<description>
Registers a [NavigationServer2D] implementation by passing a [param name] and a [Callable] that returns a [NavigationServer2D] object.
</description>
</method>
<method name="set_default_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="priority" type="int" />
<description>
Sets the default [NavigationServer2D] implementation to the one identified by [param name], if [param priority] is greater than the priority of the current default implementation.
</description>
</method>
</methods>
</class>

30
doc/classes/NavigationServer3DManager.xml Normal file
View File

@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationServer3DManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A singleton for managing [NavigationServer3D] implementations.
</brief_description>
<description>
[NavigationServer3DManager] is the API for registering [NavigationServer3D] implementations and setting the default implementation.
[b]Note:[/b] It is not possible to switch servers at runtime. This class is only used on startup at the server initialization level.
</description>
<tutorials>
</tutorials>
<methods>
<method name="register_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="create_callback" type="Callable" />
<description>
Registers a [NavigationServer3D] implementation by passing a [param name] and a [Callable] that returns a [NavigationServer3D] object.
</description>
</method>
<method name="set_default_server">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="priority" type="int" />
<description>
Sets the default [NavigationServer3D] implementation to the one identified by [param name], if [param priority] is greater than the priority of the current default implementation.
</description>
</method>
</methods>
</class>

14
doc/classes/ProjectSettings.xml
View File

@@ -2348,6 +2348,13 @@
<member name="navigation/2d/merge_rasterizer_cell_scale" type="float" setter="" getter="" default="1.0">
Default merge rasterizer cell scale for 2D navigation maps. See [method NavigationServer2D.map_set_merge_rasterizer_cell_scale].
</member>
<member name="navigation/2d/navigation_engine" type="String" setter="" getter="" default="&quot;DEFAULT&quot;">
Sets which navigation engine to use for 2D navigation.
[b]DEFAULT[/b] is equivalent to [b]GodotNavigation2D[/b], but may change in future releases. Select an explicit implementation if you want to ensure that your project stays on the same engine.
[b]GodotNavigation2D[/b] is Godot's internal 2D navigation engine.
[b]Dummy[/b] is a 2D navigation server that does nothing and returns only dummy values, effectively disabling all 2D navigation functionality.
Third-party modules can add other navigation engines to select with this setting.
</member>
<member name="navigation/2d/use_edge_connections" type="bool" setter="" getter="" default="true">
If enabled 2D navigation regions will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. This setting only affects World2D default navigation maps.
</member>
@@ -2375,6 +2382,13 @@
<member name="navigation/3d/merge_rasterizer_cell_scale" type="float" setter="" getter="" default="1.0">
Default merge rasterizer cell scale for 3D navigation maps. See [method NavigationServer3D.map_set_merge_rasterizer_cell_scale].
</member>
<member name="navigation/3d/navigation_engine" type="String" setter="" getter="" default="&quot;DEFAULT&quot;">
Sets which navigation engine to use for 3D navigation.
[b]DEFAULT[/b] is equivalent to [b]GodotNavigation3D[/b], but may change in future releases. Select an explicit implementation if you want to ensure that your project stays on the same engine.
[b]GodotNavigation3D[/b] is Godot's internal 3D navigation engine.
[b]Dummy[/b] is a 3D navigation server that does nothing and returns only dummy values, effectively disabling all 3D navigation functionality.
Third-party modules can add other navigation engines to select with this setting.
</member>
<member name="navigation/3d/use_edge_connections" type="bool" setter="" getter="" default="true">
If enabled 3D navigation regions will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. This setting only affects World3D default navigation maps.
</member>