Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 13:21:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Ported: Document NavigationServer API navigation agent callbacks - smix8

Browse Source 
96e865dfb3
This commit is contained in:
Relintai 2022-07-29 09:07:02 +02:00
parent 6a01f2b717
commit 10d3f0826e
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/Navigation2DServer.xml
View File

@ -44,6 +44,8 @@
<argument index="2" name="method" type="StringName" /> <argument index="2" name="method" type="StringName" />
<argument index="3" name="userdata" type="Variant" default="null" /> <argument index="3" name="userdata" type="Variant" default="null" />
<description> <description>
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> </description>
</method> </method>
<method name="agent_set_map" qualifiers="const"> <method name="agent_set_map" qualifiers="const">

2
doc/classes/NavigationServer.xml
View File

@ -43,6 +43,8 @@
<argument index="2" name="method" type="StringName" /> <argument index="2" name="method" type="StringName" />
<argument index="3" name="userdata" type="Variant" default="null" /> <argument index="3" name="userdata" type="Variant" default="null" />
<description> <description>
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> </description>
</method> </method>
<method name="agent_set_map" qualifiers="const"> <method name="agent_set_map" qualifiers="const">