Merge pull request #82561 from ershn/fix_navigation_agents_is_target_…

…reached_behavior

Make `target_desired_distance` affect the navigation of `NavigationAgent2D/3D`

doc/classes/NavigationAgent2D.xml

@@ -84,8 +84,8 @@
  <method name="is_navigation_finished">
  <return type="bool" />
  <description>
- Returns [code]true[/code] if the end of the currently loaded navigation path has been reached.
- [b]Note:[/b] While true prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
+ Returns [code]true[/code] if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.
+ [b]Note:[/b] While [code]true[/code] prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
  </description>
  </method>
  <method name="is_target_reachable">
@@ -97,7 +97,7 @@
  <method name="is_target_reached" qualifiers="const">
  <return type="bool" />
  <description>
- Returns true if [member target_position] is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See [method get_final_position].
+ Returns [code]true[/code] if the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
  </description>
  </method>
  <method name="set_avoidance_layer_value">
@@ -180,7 +180,7 @@
  The distance to search for other agents.
  </member>
  <member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="20.0">
- The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the next point on each physics frame update.
+ The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update.
  </member>
  <member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="100.0">
  The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
@@ -199,7 +199,9 @@
  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.
  </member>
  <member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="10.0">
- The distance threshold before the final target point is considered to be reached. This allows agents to not have to hit the point of the final target exactly, but only to reach its general area. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.
+ The distance threshold before the target is considered to be reached. On reaching the target, [signal target_reached] is emitted and navigation ends (see [method is_navigation_finished] and [signal navigation_finished]).
+ You can make navigation end early by setting this property to a value greater than [member path_desired_distance] (navigation will end before reaching the last waypoint).
+ You can also make navigation end closer to the target than each individual path position by setting this property to a value lower than [member path_desired_distance] (navigation won't immediately end when reaching the last waypoint). However, if the value set is too low, the agent will be stuck in a repath loop because it will constantly overshoot the distance to the target on each physics frame update.
  </member>
  <member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2(0, 0)">
  If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
@@ -218,7 +220,7 @@
  <signal name="link_reached">
  <param index="0" name="details" type="Dictionary" />
  <description>
- Notifies when a navigation link has been reached.
+ Signals that the agent reached a navigation link. Emitted when the agent moves within [member path_desired_distance] of the next position of the path when that position is a navigation link.
  The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
  - [code]position[/code]: The start position of the link that was reached.
  - [code]type[/code]: Always [constant NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK].
@@ -230,7 +232,8 @@
  </signal>
  <signal name="navigation_finished">
  <description>
- Emitted once per loaded path when the agent internal navigation path index reaches the last index of the loaded path array. The agent internal navigation path index can be received with [method get_current_navigation_path_index].
+ Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path.
+ This signal will be emitted just after [signal target_reached] when the target is reachable.
  </description>
  </signal>
  <signal name="path_changed">
@@ -243,7 +246,9 @@
  </signal>
  <signal name="target_reached">
  <description>
- Emitted once per loaded path when the agent's global position is the first time within [member target_desired_distance] to the [member target_position].
+ Signals that the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. This signal is emitted only once per loaded path.
+ This signal will be emitted just before [signal navigation_finished] when the target is reachable.
+ It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
  </description>
  </signal>
  <signal name="velocity_computed">
@@ -255,7 +260,7 @@
  <signal name="waypoint_reached">
  <param index="0" name="details" type="Dictionary" />
  <description>
- Notifies when a waypoint along the path has been reached.
+ Signals that the agent reached a waypoint. Emitted when the agent moves within [member path_desired_distance] of the next position of the path.
  The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
  - [code]position[/code]: The position of the waypoint that was reached.
  - [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint.

doc/classes/NavigationAgent3D.xml

@@ -84,8 +84,8 @@
  <method name="is_navigation_finished">
  <return type="bool" />
  <description>
- Returns [code]true[/code] if the end of the currently loaded navigation path has been reached.
- [b]Note:[/b] While true prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
+ Returns [code]true[/code] if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.
+ [b]Note:[/b] While [code]true[/code] prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
  </description>
  </method>
  <method name="is_target_reachable">
@@ -97,7 +97,7 @@
  <method name="is_target_reached" qualifiers="const">
  <return type="bool" />
  <description>
- Returns true if [member target_position] is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See [method get_final_position].
+ Returns [code]true[/code] if the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
  </description>
  </method>
  <method name="set_avoidance_layer_value">
@@ -183,7 +183,7 @@
  The distance to search for other agents.
  </member>
  <member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="1.0">
- The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the next point on each physics frame update.
+ The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update.
  </member>
  <member name="path_height_offset" type="float" setter="set_path_height_offset" getter="get_path_height_offset" default="0.0">
  The height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents.
@@ -205,7 +205,9 @@
  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.
  </member>
  <member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="1.0">
- The distance threshold before the final target point is considered to be reached. This allows agents to not have to hit the point of the final target exactly, but only to reach its general area. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.
+ The distance threshold before the target is considered to be reached. On reaching the target, [signal target_reached] is emitted and navigation ends (see [method is_navigation_finished] and [signal navigation_finished]).
+ You can make navigation end early by setting this property to a value greater than [member path_desired_distance] (navigation will end before reaching the last waypoint).
+ You can also make navigation end closer to the target than each individual path position by setting this property to a value lower than [member path_desired_distance] (navigation won't immediately end when reaching the last waypoint). However, if the value set is too low, the agent will be stuck in a repath loop because it will constantly overshoot the distance to the target on each physics frame update.
  </member>
  <member name="target_position" type="Vector3" setter="set_target_position" getter="get_target_position" default="Vector3(0, 0, 0)">
  If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
@@ -228,7 +230,7 @@
  <signal name="link_reached">
  <param index="0" name="details" type="Dictionary" />
  <description>
- Notifies when a navigation link has been reached.
+ Signals that the agent reached a navigation link. Emitted when the agent moves within [member path_desired_distance] of the next position of the path when that position is a navigation link.
  The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
  - [code]position[/code]: The start position of the link that was reached.
  - [code]type[/code]: Always [constant NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK].
@@ -240,7 +242,8 @@
  </signal>
  <signal name="navigation_finished">
  <description>
- Emitted once per loaded path when the agent internal navigation path index reaches the last index of the loaded path array. The agent internal navigation path index can be received with [method get_current_navigation_path_index].
+ Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path.
+ This signal will be emitted just after [signal target_reached] when the target is reachable.
  </description>
  </signal>
  <signal name="path_changed">
@@ -253,7 +256,9 @@
  </signal>
  <signal name="target_reached">
  <description>
- Emitted once per loaded path when the agent's global position is the first time within [member target_desired_distance] to the [member target_position].
+ Signals that the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. This signal is emitted only once per loaded path.
+ This signal will be emitted just before [signal navigation_finished] when the target is reachable.
+ It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
  </description>
  </signal>
  <signal name="velocity_computed">
@@ -265,7 +270,7 @@
  <signal name="waypoint_reached">
  <param index="0" name="details" type="Dictionary" />
  <description>
- Notifies when a waypoint along the path has been reached.
+ Signals that the agent reached a waypoint. Emitted when the agent moves within [member path_desired_distance] of the next position of the path.
  The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
  - [code]position[/code]: The position of the waypoint that was reached.
  - [code]type[/code]: The type of navigation primitive (region or link) that contains this waypoint.