Browse Source

Document an example dictionary returned by `TileSet.tile_get_shapes()`

Hugo Locurcio 5 years ago
parent
commit
60bb80505f
1 changed files with 11 additions and 1 deletions
  1. 11 1
      doc/classes/TileSet.xml

+ 11 - 1
doc/classes/TileSet.xml

@@ -478,7 +478,17 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Returns an array of the tile's shapes.
+				Returns an array of dictionaries describing the tile's shapes.
+				[b]Dictionary structure in the array returned by this method:[/b]
+				[codeblock]
+				{
+				    "autotile_coord": Vector2,
+				    "one_way": bool,
+				    "one_way_margin": int,
+				    "shape": CollisionShape2D,
+				    "shape_transform": Transform2D,
+				}
+				[/codeblock]
 			</description>
 		</method>
 		<method name="tile_get_texture" qualifiers="const">