Skip to content

Commit be7b640

Browse files
committed
Merge pull request #102776 from timothyqiu/tile-coordinate-range
Document the valid range of tile coordinates in TileMapLayer
2 parents 5f7ea83 + 9fbceb7 commit be7b640

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

doc/classes/TileMap.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other.
88
For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a [TileSetScenesCollectionSource] may be initialized after their parent. This is only queued when inside the scene tree.
99
To force an update earlier on, call [method update_internals].
10+
[b]Note:[/b] For performance and compatibility reasons, the coordinates serialized by [TileMap] are limited to 16-bit signed integers, i.e. the range for X and Y coordinates is from [code]-32768[/code] to [code]32767[/code]. When saving tile data, tiles outside this range are wrapped.
1011
</description>
1112
<tutorials>
1213
<link title="Using Tilemaps">$DOCS_URL/tutorials/2d/using_tilemaps.html</link>

doc/classes/TileMapLayer.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
Node for 2D tile-based maps. A [TileMapLayer] uses a [TileSet] which contain a list of tiles which are used to create grid-based maps. Unlike the [TileMap] node, which is deprecated, [TileMapLayer] has only one layer of tiles. You can use several [TileMapLayer] to achieve the same result as a [TileMap] node.
88
For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a [TileSetScenesCollectionSource] may be initialized after their parent. This is only queued when inside the scene tree.
99
To force an update earlier on, call [method update_internals].
10+
[b]Note:[/b] For performance and compatibility reasons, the coordinates serialized by [TileMapLayer] are limited to 16-bit signed integers, i.e. the range for X and Y coordinates is from [code]-32768[/code] to [code]32767[/code]. When saving tile data, tiles outside this range are wrapped.
1011
</description>
1112
<tutorials>
1213
<link title="Using Tilemaps">$DOCS_URL/tutorials/2d/using_tilemaps.html</link>

0 commit comments

Comments
 (0)