Add support for emitting a signal when entering a NavLink

1 files changed, 31 insertions, 0 deletions

diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml
index d9a1235bdd..c3f4809b5e 100644
--- a/doc/classes/NavigationAgent3D.xml
+++ b/doc/classes/NavigationAgent3D.xml
@@ -28,6 +28,12 @@
 				Returns which index the agent is currently on in the navigation path's [PackedVector3Array].
 			</description>
 		</method>
+		<method name="get_current_navigation_result" qualifiers="const">
+			<return type="NavigationPathQueryResult3D" />
+			<description>
+				Returns the path query result for the path the agent is currently following.
+			</description>
+		</method>
 		<method name="get_final_location">
 			<return type="Vector3" />
 			<description>
@@ -128,6 +134,9 @@
 		<member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0">
 			The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
 		</member>
+		<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" enum="NavigationPathQueryParameters3D.PathMetadataFlags" default="7">
+			Additional information to return with the navigation path.
+		</member>
 		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
 			The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]).
 			Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationMesh] resources with a different [member NavigationMesh.agent_radius] property and use different navigation maps for each actor size.
@@ -143,6 +152,17 @@
 		</member>
 	</members>
 	<signals>
+		<signal name="link_reached">
+			<param index="0" name="details" type="Dictionary" />
+			<description>
+				Notifies when a navigation link has been reached.
+				The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
+				- [code]location[/code]: The start location of the link that was reached.
+				- [code]type[/code]: Always [constant NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK].
+				- [code]rid[/code]: The [RID] of the link.
+				- [code]owner[/code]: The object which manages the link (usually [NavigationLink3D]).
+			</description>
+		</signal>
 		<signal name="navigation_finished">
 			<description>
 				Notifies when the final location is reached.
@@ -164,5 +184,16 @@
 				Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true.
 			</description>
 		</signal>
+		<signal name="waypoint_reached">
+			<param index="0" name="details" type="Dictionary" />
+			<description>
+				Notifies when a waypoint along the path has been reached.
+				The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
+				- [code]location[/code]: The location of the waypoint that was reached.
+				- [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint.
+				- [code]rid[/code]: The [RID] of the containing navigation primitive (region or link).
+				- [code]owner[/code]: The object which manages the containing navigation primitive (region or link).
+			</description>
+		</signal>
 	</signals>
 </class>