Skip to content
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

Improve TileMapLayer get surrounding cells description #98587

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Improve TileMapLayer get surrounding cells description #98587

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/classes/TileMapLayer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

tile_shape could be referenced optionally. I don't think this reads particularly awkward.

</description>
</method>
<method name="get_used_cells" qualifiers="const">
Expand Down
Loading