asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document NavigationServer API navigation agent callbacks

Browse source 
Document NavigationServer API navigation agent callbacks.

(cherry picked from commit 10c400ca82)
This commit is contained in:
smix8 2022-06-14 16:49:02 +02:00 committed by Rémi Verschelde
parent b0a8bcdf49
commit 96e865dfb3
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/classes/Navigation2DServer.xml
View file

@ -44,7 +44,8 @@
<argument index="2" name="method" type="String" />
<argument index="3" name="userdata" type="Variant" default="null" />
<description>
Callback called at the end of the RVO process.
Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name.
[b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code].
</description>
</method>
<method name="agent_set_map" qualifiers="const">

3
doc/classes/NavigationServer.xml
View file

@ -43,7 +43,8 @@
<argument index="2" name="method" type="String" />
<argument index="3" name="userdata" type="Variant" default="null" />
<description>
Callback called at the end of the RVO process.
Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name.
[b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code].
</description>
</method>
<method name="agent_set_map" qualifiers="const">