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.

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

Added note to TileMap.get_used_cells_by_id() #3518

Closed
wants to merge 1 commit into from

Conversation

tylerecouture
Copy link

Added: Note: The tile id is referred to as the tile index in other methods.
godotengine/godot-proposals#814

Added: Note: The tile ``id`` is referred to as the tile ``index`` in other methods. 
godotengine/godot-proposals#814
@akien-mga
Copy link
Member

See the comment in the file's header:

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TileMap.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

There's already a PR on the engine repository to address that proposal: godotengine/godot#38635.

@tylerecouture
Copy link
Author

That renames the method for a future version. I'm just trying to clarify the docs for the current version.

@akien-mga
Copy link
Member

That makes sense indeed for 3.2. This should be changed in the source file here: https://github.com/godotengine/godot/blob/master/doc/classes/TileMap.xml
Otherwise changes made here would be lost next time the class reference is generated.

@Calinou
Copy link
Member

Calinou commented May 12, 2020

For reference, this was superseded by godotengine/godot#38686.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants