From 10d3f0826eab1da9cda8fa680d3d56a49fccf9ce Mon Sep 17 00:00:00 2001 From: Relintai Date: Fri, 29 Jul 2022 09:07:02 +0200 Subject: [PATCH] Ported: Document NavigationServer API navigation agent callbacks - smix8 https://github.com/godotengine/godot/commit/96e865dfb3fac0bbda60651178d18dfac4cfe296 --- doc/classes/Navigation2DServer.xml | 2 ++ doc/classes/NavigationServer.xml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 26bfdb59d..0bef2edac 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -44,6 +44,8 @@ + 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]. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index b95d99d25..683417398 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -43,6 +43,8 @@ + 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].