Browse Source

doc: Clarifying NavigationAgent and NavigationAgent2D velocity_computed requires avoidance_enabled to be true to emit

(cherry picked from commit ed5b832a81bb7f67924282d2c3f96b8674ecbb7d)
BenniKane 3 years ago
parent
commit
6d9904f1a9
2 changed files with 2 additions and 2 deletions
  1. 1 1
      doc/classes/NavigationAgent.xml
  2. 1 1
      doc/classes/NavigationAgent2D.xml

+ 1 - 1
doc/classes/NavigationAgent.xml

@@ -169,7 +169,7 @@
 		<signal name="velocity_computed">
 			<argument index="0" name="safe_velocity" type="Vector3" />
 			<description>
-				Notifies when the collision avoidance velocity is calculated after a call to [method set_velocity].
+				Notifies when the collision avoidance velocity is calculated after a call to [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
 			</description>
 		</signal>
 	</signals>

+ 1 - 1
doc/classes/NavigationAgent2D.xml

@@ -163,7 +163,7 @@
 		<signal name="velocity_computed">
 			<argument index="0" name="safe_velocity" type="Vector2" />
 			<description>
-				Notifies when the collision avoidance velocity is calculated after a call to [method set_velocity].
+				Notifies when the collision avoidance velocity is calculated after a call to [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
 			</description>
 		</signal>
 	</signals>