summaryrefslogtreecommitdiff
path: root/doc/classes/TileSet.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/TileSet.xml')
-rw-r--r--doc/classes/TileSet.xml112
1 files changed, 85 insertions, 27 deletions
diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index 7121bc8b9c..ffd15e8d8b 100644
--- a/doc/classes/TileSet.xml
+++ b/doc/classes/TileSet.xml
@@ -44,6 +44,14 @@
<description>
</description>
</method>
+ <method name="autotile_get_size" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="autotile_set_bitmask_mode">
<return type="void">
</return>
@@ -54,11 +62,21 @@
<description>
</description>
</method>
+ <method name="autotile_set_size">
+ <return type="void">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <argument index="1" name="size" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
<method name="clear">
<return type="void">
</return>
<description>
- Clear all tiles.
+ Clears all tiles.
</description>
</method>
<method name="create_tile">
@@ -67,7 +85,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Create a new tile which will be referenced by the given ID.
+ Creates a new tile with the given ID.
</description>
</method>
<method name="find_tile_by_name" qualifiers="const">
@@ -76,21 +94,21 @@
<argument index="0" name="name" type="String">
</argument>
<description>
- Find the first tile matching the given name.
+ Returns the first tile matching the given name.
</description>
</method>
<method name="get_last_unused_tile_id" qualifiers="const">
<return type="int">
</return>
<description>
- Return the ID following the last currently used ID, useful when creating a new tile.
+ Returns the ID following the last currently used ID, useful when creating a new tile.
</description>
</method>
<method name="get_tiles_ids" qualifiers="const">
<return type="Array">
</return>
<description>
- Return an array of all currently used tile IDs.
+ Returns an array of all currently used tile IDs.
</description>
</method>
<method name="remove_tile">
@@ -99,7 +117,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Remove the tile referenced by the given ID.
+ Removes the given tile ID.
</description>
</method>
<method name="tile_add_shape">
@@ -116,6 +134,7 @@
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
+ Adds a shape to the tile.
</description>
</method>
<method name="tile_get_light_occluder" qualifiers="const">
@@ -124,7 +143,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the light occluder of the tile.
+ Returns the tile's light occluder.
</description>
</method>
<method name="tile_get_material" qualifiers="const">
@@ -133,7 +152,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the material of the tile.
+ Returns the tile's material.
</description>
</method>
<method name="tile_get_modulate" qualifiers="const">
@@ -142,6 +161,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's modulation color.
</description>
</method>
<method name="tile_get_name" qualifiers="const">
@@ -150,7 +170,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the name of the tile.
+ Returns the tile's name.
</description>
</method>
<method name="tile_get_navigation_polygon" qualifiers="const">
@@ -159,7 +179,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the navigation polygon of the tile.
+ Returns the navigation polygon of the tile.
</description>
</method>
<method name="tile_get_navigation_polygon_offset" qualifiers="const">
@@ -168,7 +188,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the offset of the tile's navigation polygon.
+ Returns the offset of the tile's navigation polygon.
</description>
</method>
<method name="tile_get_normal_map" qualifiers="const">
@@ -177,6 +197,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's normal map texture.
</description>
</method>
<method name="tile_get_occluder_offset" qualifiers="const">
@@ -185,7 +206,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the offset of the tile's light occluder.
+ Returns the offset of the tile's light occluder.
</description>
</method>
<method name="tile_get_region" qualifiers="const">
@@ -194,7 +215,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the tile sub-region in the texture.
+ Returns the tile sub-region in the texture.
</description>
</method>
<method name="tile_get_shape" qualifiers="const">
@@ -205,6 +226,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns a tile's given shape.
</description>
</method>
<method name="tile_get_shape_count" qualifiers="const">
@@ -213,6 +235,18 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the number of shapes assigned to a tile.
+ </description>
+ </method>
+ <method name="tile_get_shape_offset" qualifiers="const">
+ <return type="Vector2">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <argument index="1" name="shape_id" type="int">
+ </argument>
+ <description>
+ Returns the offset of a tile's shape.
</description>
</method>
<method name="tile_get_shape_one_way" qualifiers="const">
@@ -223,6 +257,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the one-way collision value of a tile's shape.
</description>
</method>
<method name="tile_get_shape_transform" qualifiers="const">
@@ -233,6 +268,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the [Transform2D] of a tile's shape.
</description>
</method>
<method name="tile_get_shapes" qualifiers="const">
@@ -241,7 +277,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the array of shapes of the tile.
+ Returns an array of the tile's shapes.
</description>
</method>
<method name="tile_get_texture" qualifiers="const">
@@ -250,7 +286,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the texture of the tile.
+ Returns the tile's texture.
</description>
</method>
<method name="tile_get_texture_offset" qualifiers="const">
@@ -259,7 +295,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Return the texture offset of the tile.
+ Returns the texture offset of the tile.
</description>
</method>
<method name="tile_get_tile_mode" qualifiers="const">
@@ -268,6 +304,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's [enum TileMode].
</description>
</method>
<method name="tile_get_z_index" qualifiers="const">
@@ -276,6 +313,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's z-index (drawing layer).
</description>
</method>
<method name="tile_set_light_occluder">
@@ -286,7 +324,7 @@
<argument index="1" name="light_occluder" type="OccluderPolygon2D">
</argument>
<description>
- Set a light occluder for the tile.
+ Sets a light occluder for the tile.
</description>
</method>
<method name="tile_set_material">
@@ -297,7 +335,7 @@
<argument index="1" name="material" type="ShaderMaterial">
</argument>
<description>
- Set the material of the tile.
+ Sets the tile's material.
</description>
</method>
<method name="tile_set_modulate">
@@ -308,6 +346,7 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
+ Sets the tile's modulation color.
</description>
</method>
<method name="tile_set_name">
@@ -318,7 +357,7 @@
<argument index="1" name="name" type="String">
</argument>
<description>
- Set the name of the tile, for descriptive purposes.
+ Sets the tile's name.
</description>
</method>
<method name="tile_set_navigation_polygon">
@@ -329,7 +368,7 @@
<argument index="1" name="navigation_polygon" type="NavigationPolygon">
</argument>
<description>
- Set a navigation polygon for the tile.
+ Sets the tile's navigation polygon.
</description>
</method>
<method name="tile_set_navigation_polygon_offset">
@@ -340,7 +379,7 @@
<argument index="1" name="navigation_polygon_offset" type="Vector2">
</argument>
<description>
- Set an offset for the tile's navigation polygon.
+ Sets an offset for the tile's navigation polygon.
</description>
</method>
<method name="tile_set_normal_map">
@@ -351,6 +390,7 @@
<argument index="1" name="normal_map" type="Texture">
</argument>
<description>
+ Sets the tile's normal map texture.
</description>
</method>
<method name="tile_set_occluder_offset">
@@ -361,7 +401,7 @@
<argument index="1" name="occluder_offset" type="Vector2">
</argument>
<description>
- Set an offset for the tile's light occluder.
+ Sets an offset for the tile's light occluder.
</description>
</method>
<method name="tile_set_region">
@@ -372,7 +412,7 @@
<argument index="1" name="region" type="Rect2">
</argument>
<description>
- Set the tile sub-region in the texture. This is common in texture atlases.
+ Sets the tile's sub-region in the texture. This is common in texture atlases.
</description>
</method>
<method name="tile_set_shape">
@@ -385,6 +425,20 @@
<argument index="2" name="shape" type="Shape2D">
</argument>
<description>
+ Sets a shape for the tile, enabling collision.
+ </description>
+ </method>
+ <method name="tile_set_shape_offset">
+ <return type="void">
+ </return>
+ <argument index="0" name="id" type="int">
+ </argument>
+ <argument index="1" name="shape_id" type="int">
+ </argument>
+ <argument index="2" name="shape_offset" type="Vector2">
+ </argument>
+ <description>
+ Sets the offset of a tile's shape.
</description>
</method>
<method name="tile_set_shape_one_way">
@@ -397,6 +451,7 @@
<argument index="2" name="one_way" type="bool">
</argument>
<description>
+ Enables one-way collision on a tile's shape.
</description>
</method>
<method name="tile_set_shape_transform">
@@ -409,6 +464,7 @@
<argument index="2" name="shape_transform" type="Transform2D">
</argument>
<description>
+ Sets a [Transform2D] on a tile's shape.
</description>
</method>
<method name="tile_set_shapes">
@@ -419,7 +475,7 @@
<argument index="1" name="shapes" type="Array">
</argument>
<description>
- Set an array of shapes for the tile, enabling physics to collide with it.
+ Sets an array of shapes for the tile, enabling collision.
</description>
</method>
<method name="tile_set_texture">
@@ -430,7 +486,7 @@
<argument index="1" name="texture" type="Texture">
</argument>
<description>
- Set the texture of the tile.
+ Sets the tile's texture.
</description>
</method>
<method name="tile_set_texture_offset">
@@ -441,7 +497,7 @@
<argument index="1" name="texture_offset" type="Vector2">
</argument>
<description>
- Set the texture offset of the tile.
+ Sets the tile's texture offset.
</description>
</method>
<method name="tile_set_tile_mode">
@@ -452,6 +508,7 @@
<argument index="1" name="tilemode" type="int" enum="TileSet.TileMode">
</argument>
<description>
+ Sets the tile's [enum TileMode].
</description>
</method>
<method name="tile_set_z_index">
@@ -462,6 +519,7 @@
<argument index="1" name="z_index" type="int">
</argument>
<description>
+ Sets the tile's drawing index.
</description>
</method>
</methods>
@@ -492,7 +550,7 @@
</constant>
<constant name="AUTO_TILE" value="1" enum="TileMode">
</constant>
- <constant name="ANIMATED_TILE" value="2" enum="TileMode">
+ <constant name="ATLAS_TILE" value="2" enum="TileMode">
</constant>
</constants>
</class>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-03 17:07:45 +0000