Replace references from TileMap to TileMapLayer in documentation #102561
+16
−16
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
Dowsley
commented
Feb 8, 2025
doc/classes/TileSet.xml
Outdated
| @@ -656,7 +656,7 @@ | |||
| </constant> | |||
| <constant name="TILE_SHAPE_ISOMETRIC" value="1" enum="TileShape"> | |||
| Diamond tile shape (for isometric look). | |||
| [b]Note:[/b] Isometric [TileSet] works best if [TileMap] and all its layers have Y-sort enabled. | |||
| [b]Note:[/b] Isometric [TileSet] works best if [TileMapLayer] has Y-sort enabled. | |||
There was a problem hiding this comment.
Need feedback on this change.
There was a problem hiding this comment.
All sibling TileMapLayers and their parent Node2D need Y-sort enabled.
There was a problem hiding this comment.
Wondering if [TileMapLayer]s will work.
KoBeWi
reviewed
Feb 8, 2025
doc/classes/TileSet.xml
Outdated
| @@ -1,7 +1,7 @@ | |||
| <?xml version="1.0" encoding="UTF-8" ?> | |||
| <class name="TileSet" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | |||
| <brief_description> | |||
| Tile library for tilemaps. | |||
| Tile library for tilemap layers. | |||
There was a problem hiding this comment.
This refers to tilemaps in general, not the class, so it was probably fine.
KoBeWi
reviewed
Feb 8, 2025
| @@ -503,8 +503,8 @@ | |||
| <param index="3" name="coords_to" type="Vector2i" /> | |||
| <description> | |||
| Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies. | |||
| This can be used to replace a tile in all TileMaps using this TileSet, as TileMap nodes will find and use the proxy's target tile when one is available. | |||
| Proxied tiles can be automatically replaced in TileMap nodes using the editor. | |||
| This can be used to replace a tile in all TileMaps using this TileSet, as TileMapLayer nodes will find and use the proxy's target tile when one is available. | |||
There was a problem hiding this comment.
Not sure if TileMapLayer still supports proxies.
CC @groud
There was a problem hiding this comment.
From what I see in latest docs, not anymore.
KoBeWi
reviewed
Feb 8, 2025
doc/classes/TileSetAtlasSource.xml
Outdated
| if not alternate_id & TileSetAtlasSource.TRANSFORM_FLIP_H: | ||
| # If tile is not already flipped, flip it. | ||
| $TileMap.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) | ||
| $TileMapLayer.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) |
There was a problem hiding this comment.
Suggested change
| $TileMapLayer.set_cell(0, Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) | |
| $TileMapLayer.set_cell(Vector2i(2, 2), source_id, atlas_coords, alternate_id | TileSetAtlasSource.TRANSFORM_FLIP_H) |
Dowsley
force-pushed
the
docs/update-tilemap-references
branch
from
2ba555e to
e53842e
Compare
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.
We have several important doc pages that still reference TileMap, when it is already deprecated, as well as code examples that do not work on the new TileMapLayers.
Pretty sure there are other places, but these are the most important since they're closely related to TileMapLayers.