Document NavigationServer API navigation agent callbacks
Document NavigationServer API navigation agent callbacks.
This commit is contained in:
parent
22a40365c0
commit
10c400ca82
2 changed files with 4 additions and 2 deletions
|
@ -44,7 +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.
|
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">
|
||||||
|
|
|
@ -44,7 +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.
|
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">
|
||||||
|
|
Loading…
Reference in a new issue