Browse Source

Document shape metadata for `TileMap`

(cherry picked from commit 0c2dbd01dc407fd8b60de56a32a3d2a8a716ed9c)
Andrii Doroshenko (Xrayez) 4 years ago
parent
commit
0ff0fdef5c
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/TileMap.xml

+ 1 - 0
doc/classes/TileMap.xml

@@ -5,6 +5,7 @@
 	</brief_description>
 	</brief_description>
 	<description>
 	<description>
 		Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
 		Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
+		When doing physics queries against the tilemap, the cell coordinates are encoded as [code]metadata[/code] for each detected collision shape returned by methods such as [method Physics2DDirectSpaceState.intersect_shape], [method Physics2DDirectBodyState.get_contact_collider_shape_metadata], etc.
 	</description>
 	</description>
 	<tutorials>
 	<tutorials>
 		<link title="Using Tilemaps">https://docs.godotengine.org/en/3.2/tutorials/2d/using_tilemaps.html</link>
 		<link title="Using Tilemaps">https://docs.godotengine.org/en/3.2/tutorials/2d/using_tilemaps.html</link>