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

Shouldn't Area2D Make Reference to TileMapLayer Instead of TileMap? #10599

Open
CouchSloth opened this issue Feb 2, 2025 · 4 comments
Open
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository enhancement topic:2d

Comments

@CouchSloth
Copy link

Your Godot version: 4.3 Stable

Since 'TileMap is deprecated, wouldn't it be best to update Area2D documents to reflect that? Or changing it to reference both TileMapLayer and TileMap?
Unless there has been a change on how Area2D and TileMapLayers interact compared to TileMap.

Image

Image

With TileMapLayer being where a lot of effort and utility has been put into, it would be nice to see it referenced more in documentation. Especially since TileMapLayer does not seem to inherit from TileMap.

Image

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/classes/class_area2d.html

@tetrapod00 tetrapod00 added enhancement area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository labels Feb 2, 2025
@tetrapod00
Copy link
Contributor

I'm not a 2D expert, but assuming that it works as a drop-in replacement, it seems like it's time to update all these links to TileMap in the class reference. There are more cases than just this Area2D class.
One instance was already changed in godotengine/godot#98782.

@CouchSloth
Copy link
Author

I imagine there are a lot, such as TileSet still references TileMap and not TileMapLayer in the documentation here but the "Using TileSets" it is properly updated. However, I just noticed this one since I'm working through some StackOverflow questions.
It seems to be an issue where the tutorials are updated but the documents have fallen behind on updates and usefulness.

@tetrapod00
Copy link
Contributor

The TileSet class reference is actually updated in the latest branch. Since the class reference source is in the main godot repo, not here, and that repo is a lot more conservative with cherrypicking changes back a version, I'm not actually certain that 4.3 will end up getting that change. If it does, it might come whenever the 4.3.1 patch update happens.

@CouchSloth
Copy link
Author

I'm glad it is updated in the latest branch. This still has the same issues of TileSet was not updated with it with 4.3. I do hope that it is updated in the patch because it means that the documents can reference the right object moving forward instead of a deprecated object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository enhancement topic:2d
Projects
None yet
Development

No branches or pull requests

2 participants