Add AstarGrid2D headline to 2D Navigation Overview #10135
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Resolves godotengine#9668 by adding in the request description. This PR adds a short description for AStarGrid2D of its function and use case that was previously missing in the 2D navigation overview page.
mhilbrunner
reviewed
Oct 23, 2024
| ``AstarGrid2D`` objects provide an option to find the shortest path between two points on a partial 2D grid. | ||
|
|
||
| The AStarGrid2D class is best suited for cell-based 2D gameplay that only require actors to move between distinct positions on a grid. | ||
| AStarGrid2D is better used over AStar2D when applicable as it only requires the region of the grid to be set, rather than manually creating and connecting individual points. |
There was a problem hiding this comment.
Hi, hello and welcome 👋 Well spotted, adding this is useful!
I found the long description in the class reference easier to parse and understand the pros/cons:
AStarGrid2D is a variant of AStar2D that is specialized for partial 2D grids. It is simpler to use because it doesn't require you to manually create points and connect them together. This class also supports multiple types of heuristics, modes for diagonal movement, and a jumping mode to speed up calculation
mhilbrunner
added
enhancement
area:manual
smix8
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #9668 by adding in the requested description.
This PR adds a short description for AStarGrid2D of its function and use case that was previously missing in the 2D navigation overview page.