godotengine / godotengine/godot-docs

NavigationAgent - ending navigation early note is incorrect

Open
#10,915 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** 4.4.1

**Issue description:**
NavigationAgent2D and 3D both contain this note under the `target_desired_distance` property:

> You can make navigation end early by setting this property to a value greater than path_desired_distance (navigation will end before reaching the last waypoint).

I believe that instead of [`path_desired_distance`](https://docs.godotengine.org/en/stable/classes/class_navigationagent3d.html#class-navigationagent3d-property-path-desired-distance) the author actually meant [`distance_to_target()`](https://docs.godotengine.org/en/stable/classes/class_navigationagent3d.html#class-navigationagent3d-method-distance-to-target).

It doesn't make sense that navigation would end if the `target_desired_distance` is set to a value larger than `path_desired_distance` but smaller than `distance_to_target()`

**URL to the documentation page:**
- https://docs.godotengine.org/en/stable/classes/class_navigationagent3d.html
- https://docs.godotengine.org/en/stable/classes/class_navigationagent2d.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.