From ed5b832a81bb7f67924282d2c3f96b8674ecbb7d Mon Sep 17 00:00:00 2001
From: BenniKane <bennikane@gmail.com>
Date: Thu, 1 Sep 2022 10:07:00 -0500
Subject: doc: Clarifying NavigationAgent and NavigationAgent2D
 velocity_computed requires avoidance_enabled to be true to emit

---
 doc/classes/NavigationAgent2D.xml | 2 +-
 doc/classes/NavigationAgent3D.xml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'doc/classes')

diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml
index bf3aff2c58..3437e0eca4 100644
--- a/doc/classes/NavigationAgent2D.xml
+++ b/doc/classes/NavigationAgent2D.xml
@@ -165,7 +165,7 @@
 		<signal name="velocity_computed">
 			<param index="0" name="safe_velocity" type="Vector3" />
 			<description>
-				Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity].
+				Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
 			</description>
 		</signal>
 	</signals>
diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml
index 7c48f0b52b..3bb5b361ca 100644
--- a/doc/classes/NavigationAgent3D.xml
+++ b/doc/classes/NavigationAgent3D.xml
@@ -171,7 +171,7 @@
 		<signal name="velocity_computed">
 			<param index="0" name="safe_velocity" type="Vector3" />
 			<description>
-				Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity].
+				Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
 			</description>
 		</signal>
 	</signals>
-- 
cgit v1.2.3