Skip to content

Update NavigationPathQueryObjects to explain all (new) options #11044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update NavigationPathQueryObjects to explain all (new) options #11044

wants to merge 1 commit into from
+245 −8

Conversation

smix8
Copy link
Contributor

@smix8 smix8 commented Jun 22, 2025 •
edited
Loading

Updates NavigationPathQueryObjects to explain all (new) options (or flesh out existing).

.. available for NavigationPathQueryParameters2D / NavigationPathQueryParameters3D.

  • How to do a basic NavigationServer path query using parameters and result objects.
  • What all the different path post-processing options do and how they should be used.
  • Path simplification.
  • Path metadata.
  • Filtering regions with the exclude or include filters.
  • Clipping paths and setting search limits.

path_postprocess_diff

This is for Godot 4.5 only as some of the options are not available in older Godot versions or behave differently.

@Mickeon Mickeon added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:navigation labels Jun 22, 2025
Mickeon
Mickeon reviewed Jun 22, 2025
View reviewed changes
tutorials/navigation/navigation_using_navigationagents.rst
Comment on lines +6 to +8
.. tip::

For more advanced uses consider :ref:`doc_navigation_using_navigationpathqueryobjects` over NavigationAgent nodes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels like this tip is better suited to the bottom of this section.
It's not even begun talking about navigation agents and the page is already suggesting to rethink your choice

tutorials/navigation/navigation_using_navigationpathqueryobjects.rst Outdated
Comment on lines 6 to 13
.. tip::

Path query parameters expose various options to improve pathfinding performance or lower memory consumptions.

They cater to more advanced pathfinding needs that the high-level nodes can not always cover.

See the respective option sections below.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't sound like a tip. It's describing exactly what these objects are for, I assume. Not sure what to do about that.

@skyace65
Copy link
Contributor

Is this only applicable to 4.5?

@smix8
Copy link
Contributor Author

smix8 commented Jun 23, 2025

Is this only applicable to 4.5?

This is for Godot 4.5 only as some of the options are not available in older Godot versions or behave differently.

I was sneaky and placed that note at the very bottom below the image :D

AThousandShips
AThousandShips reviewed Jun 23, 2025
View reviewed changes
@skyace65 skyace65 added this to the 4.5 milestone Jun 23, 2025
@smix8 smix8 force-pushed the path_queries branch 2 times, most recently from 0f1b7e5 to b988f8b Compare June 24, 2025 20:16
AThousandShips
AThousandShips approved these changes Jun 25, 2025
View reviewed changes
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM style wise

AThousandShips
AThousandShips approved these changes Jun 25, 2025
View reviewed changes
@smix8
Update NavigationPathQueryObjects to explain all (new) options
bdd8917 
Updates NavigationPathQueryObjects to explain all (new) options.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mickeon Mickeon Mickeon left review comments

@AThousandShips AThousandShips AThousandShips approved these changes

Assignees
No one assigned
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:navigation
Projects
None yet
Milestone
4.5
Development

Successfully merging this pull request may close these issues.
4 participants
@smix8 @skyace65 @Mickeon @AThousandShips