summaryrefslogtreecommitdiff
path: root/doc/classes/TileSet.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-16 09:40:51 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-07-16 09:42:24 +0200
commit60bb80505f538e320e8c81a5af286347e83757a1 (patch)
treec3a4de56b58fe67aa2fe9e6618cbf00872cb38b2 /doc/classes/TileSet.xml
parent9e34ba48556b71f1f672b5be47d12b0e3f679b86 (diff)
Document an example dictionary returned by `TileSet.tile_get_shapes()`
Diffstat (limited to 'doc/classes/TileSet.xml')
-rw-r--r--doc/classes/TileSet.xml12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index 9a78e45d46..4991a1e58b 100644
--- a/doc/classes/TileSet.xml
+++ b/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">