Improve TileMapLayer get surrounding cells description
#98587
Merged
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
skyace65
added
documentation
cherrypick:4.3
skyace65
force-pushed
the
SurroundingCells
branch
from
92a1ce8 to
b168882
Compare
Mickeon
reviewed
Nov 10, 2024
| @@ -120,7 +120,7 @@ | |||
| <return type="Vector2i[]" /> | |||
| <param index="0" name="coords" type="Vector2i" /> | |||
| <description> | |||
| Returns the list of all neighboring cells to the one at [param coords]. | |||
| Returns the list of all neighboring cells to the one at [param coords]. Any neighboring cell is one that is touching edges, so for a square cell 4 cells would be returned, for a hexagon 6 cells are returned. | |||
There was a problem hiding this comment.
Although TileMapLayer's entire documentation is somewhat shoddy, if we want to go this route you may as well mention TileSet's tile_shape which affects this method directly, and perhaps get_neighbor_cell().
Even as is, there's something "awkward to read" about this description I can't quite put my finger on. I have no suggestions.
There was a problem hiding this comment.
tile_shape could be referenced optionally. I don't think this reads particularly awkward.
mhilbrunner
approved these changes
Nov 11, 2024
AThousandShips
changed the title
TileMapLayer get surrounding cells description
|
Thanks! |
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.
Clarifies what cells are counted as neighbors. Closes godotengine/godot-docs#9779.