Make NavigationServer backend engine selectable
Adds engine backend selection for NavigationServers, aka allows to swap navigation module for other backend implementations.
This commit is contained in:
30
doc/classes/NavigationServer3DManager.xml
Normal file
30
doc/classes/NavigationServer3DManager.xml
Normal 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>
|
||||
Reference in New Issue
Block a user