godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

397
classes/class_tilesetatlassource.rst
View File

@@ -14,6 +14,8 @@ TileSetAtlasSource
Exposes a 2D atlas texture as a set of tiles for a :ref:`TileSet<class_TileSet>` resource.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -27,315 +29,416 @@ Each tile alternate has a set of properties that is defined by the source's :ref
As TileData properties are stored directly in the TileSetAtlasSource resource, their properties might also be set using ``TileSetAtlasSource.set("<coords_x>:<coords_y>/<alternative_id>/<tile_data_property>")``.
.. rst-class:: classref-reftable-group
Properties
----------
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`margins<class_TileSetAtlasSource_property_margins>` | ``Vector2i(0, 0)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`separation<class_TileSetAtlasSource_property_separation>` | ``Vector2i(0, 0)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_TileSetAtlasSource_property_texture>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`texture_region_size<class_TileSetAtlasSource_property_texture_region_size>` | ``Vector2i(16, 16)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`use_texture_padding<class_TileSetAtlasSource_property_use_texture_padding>` | ``true`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
.. table::
:widths: auto
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`margins<class_TileSetAtlasSource_property_margins>` | ``Vector2i(0, 0)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`separation<class_TileSetAtlasSource_property_separation>` | ``Vector2i(0, 0)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_TileSetAtlasSource_property_texture>` | |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`texture_region_size<class_TileSetAtlasSource_property_texture_region_size>` | ``Vector2i(16, 16)`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
| :ref:`bool<class_bool>` | :ref:`use_texture_padding<class_TileSetAtlasSource_property_use_texture_padding>` | ``true`` |
+-----------------------------------+-----------------------------------------------------------------------------------+----------------------+
.. rst-class:: classref-reftable-group
Methods
-------
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_alternative_tile<class_TileSetAtlasSource_method_create_alternative_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_id_override=-1 **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_tile<class_TileSetAtlasSource_method_create_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size=Vector2i(1, 1) **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_atlas_grid_size<class_TileSetAtlasSource_method_get_atlas_grid_size>` **(** **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_next_alternative_tile_id<class_TileSetAtlasSource_method_get_next_alternative_tile_id>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_runtime_texture<class_TileSetAtlasSource_method_get_runtime_texture>` **(** **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2i<class_Rect2i>` | :ref:`get_runtime_tile_texture_region<class_TileSetAtlasSource_method_get_runtime_tile_texture_region>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tile_animation_columns<class_TileSetAtlasSource_method_get_tile_animation_columns>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_frame_duration<class_TileSetAtlasSource_method_get_tile_animation_frame_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tile_animation_frames_count<class_TileSetAtlasSource_method_get_tile_animation_frames_count>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_animation_separation<class_TileSetAtlasSource_method_get_tile_animation_separation>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_speed<class_TileSetAtlasSource_method_get_tile_animation_speed>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_total_duration<class_TileSetAtlasSource_method_get_tile_animation_total_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_at_coords<class_TileSetAtlasSource_method_get_tile_at_coords>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TileData<class_TileData>` | :ref:`get_tile_data<class_TileSetAtlasSource_method_get_tile_data>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_size_in_atlas<class_TileSetAtlasSource_method_get_tile_size_in_atlas>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2i<class_Rect2i>` | :ref:`get_tile_texture_region<class_TileSetAtlasSource_method_get_tile_texture_region>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame=0 **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_tiles_to_be_removed_on_change<class_TileSetAtlasSource_method_get_tiles_to_be_removed_on_change>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2i<class_Vector2i>` margins, :ref:`Vector2i<class_Vector2i>` separation, :ref:`Vector2i<class_Vector2i>` texture_region_size **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_room_for_tile<class_TileSetAtlasSource_method_has_room_for_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` animation_columns, :ref:`Vector2i<class_Vector2i>` animation_separation, :ref:`int<class_int>` frames_count, :ref:`Vector2i<class_Vector2i>` ignored_tile=Vector2i(-1, -1) **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_tile_in_atlas<class_TileSetAtlasSource_method_move_tile_in_atlas>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i<class_Vector2i>` new_size=Vector2i(-1, -1) **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_alternative_tile<class_TileSetAtlasSource_method_remove_alternative_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tile<class_TileSetAtlasSource_method_remove_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_alternative_tile_id<class_TileSetAtlasSource_method_set_alternative_tile_id>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile, :ref:`int<class_int>` new_id **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_columns<class_TileSetAtlasSource_method_set_tile_animation_columns>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_columns **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_frame_duration<class_TileSetAtlasSource_method_set_tile_animation_frame_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index, :ref:`float<class_float>` duration **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_frames_count<class_TileSetAtlasSource_method_set_tile_animation_frames_count>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frames_count **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_separation<class_TileSetAtlasSource_method_set_tile_animation_separation>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` separation **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_speed<class_TileSetAtlasSource_method_set_tile_animation_speed>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`float<class_float>` speed **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_alternative_tile<class_TileSetAtlasSource_method_create_alternative_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_id_override=-1 **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_tile<class_TileSetAtlasSource_method_create_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size=Vector2i(1, 1) **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_atlas_grid_size<class_TileSetAtlasSource_method_get_atlas_grid_size>` **(** **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_next_alternative_tile_id<class_TileSetAtlasSource_method_get_next_alternative_tile_id>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_runtime_texture<class_TileSetAtlasSource_method_get_runtime_texture>` **(** **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2i<class_Rect2i>` | :ref:`get_runtime_tile_texture_region<class_TileSetAtlasSource_method_get_runtime_tile_texture_region>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tile_animation_columns<class_TileSetAtlasSource_method_get_tile_animation_columns>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_frame_duration<class_TileSetAtlasSource_method_get_tile_animation_frame_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_tile_animation_frames_count<class_TileSetAtlasSource_method_get_tile_animation_frames_count>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_animation_separation<class_TileSetAtlasSource_method_get_tile_animation_separation>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_speed<class_TileSetAtlasSource_method_get_tile_animation_speed>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tile_animation_total_duration<class_TileSetAtlasSource_method_get_tile_animation_total_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_at_coords<class_TileSetAtlasSource_method_get_tile_at_coords>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TileData<class_TileData>` | :ref:`get_tile_data<class_TileSetAtlasSource_method_get_tile_data>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`get_tile_size_in_atlas<class_TileSetAtlasSource_method_get_tile_size_in_atlas>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2i<class_Rect2i>` | :ref:`get_tile_texture_region<class_TileSetAtlasSource_method_get_tile_texture_region>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame=0 **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_tiles_to_be_removed_on_change<class_TileSetAtlasSource_method_get_tiles_to_be_removed_on_change>` **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2i<class_Vector2i>` margins, :ref:`Vector2i<class_Vector2i>` separation, :ref:`Vector2i<class_Vector2i>` texture_region_size **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_room_for_tile<class_TileSetAtlasSource_method_has_room_for_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` animation_columns, :ref:`Vector2i<class_Vector2i>` animation_separation, :ref:`int<class_int>` frames_count, :ref:`Vector2i<class_Vector2i>` ignored_tile=Vector2i(-1, -1) **)** |const| |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`move_tile_in_atlas<class_TileSetAtlasSource_method_move_tile_in_atlas>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i<class_Vector2i>` new_size=Vector2i(-1, -1) **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_alternative_tile<class_TileSetAtlasSource_method_remove_alternative_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tile<class_TileSetAtlasSource_method_remove_tile>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_alternative_tile_id<class_TileSetAtlasSource_method_set_alternative_tile_id>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile, :ref:`int<class_int>` new_id **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_columns<class_TileSetAtlasSource_method_set_tile_animation_columns>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_columns **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_frame_duration<class_TileSetAtlasSource_method_set_tile_animation_frame_duration>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index, :ref:`float<class_float>` duration **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_frames_count<class_TileSetAtlasSource_method_set_tile_animation_frames_count>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frames_count **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_separation<class_TileSetAtlasSource_method_set_tile_animation_separation>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` separation **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tile_animation_speed<class_TileSetAtlasSource_method_set_tile_animation_speed>` **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`float<class_float>` speed **)** |
+-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_TileSetAtlasSource_property_margins:
- :ref:`Vector2i<class_Vector2i>` **margins**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``Vector2i(0, 0)`` |
+-----------+--------------------+
| *Setter* | set_margins(value) |
+-----------+--------------------+
| *Getter* | get_margins() |
+-----------+--------------------+
:ref:`Vector2i<class_Vector2i>` **margins** = ``Vector2i(0, 0)``
.. rst-class:: classref-property-setget
- void **set_margins** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_margins** **(** **)**
Margins, in pixels, to offset the origin of the grid in the texture.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_property_separation:
- :ref:`Vector2i<class_Vector2i>` **separation**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``Vector2i(0, 0)`` |
+-----------+-----------------------+
| *Setter* | set_separation(value) |
+-----------+-----------------------+
| *Getter* | get_separation() |
+-----------+-----------------------+
:ref:`Vector2i<class_Vector2i>` **separation** = ``Vector2i(0, 0)``
.. rst-class:: classref-property-setget
- void **set_separation** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_separation** **(** **)**
Separation, in pixels, between each tile texture region of the grid.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_property_texture:
- :ref:`Texture2D<class_Texture2D>` **texture**
.. rst-class:: classref-property
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
:ref:`Texture2D<class_Texture2D>` **texture**
.. rst-class:: classref-property-setget
- void **set_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** **)**
The atlas texture.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_property_texture_region_size:
- :ref:`Vector2i<class_Vector2i>` **texture_region_size**
.. rst-class:: classref-property
+-----------+--------------------------------+
| *Default* | ``Vector2i(16, 16)`` |
+-----------+--------------------------------+
| *Setter* | set_texture_region_size(value) |
+-----------+--------------------------------+
| *Getter* | get_texture_region_size() |
+-----------+--------------------------------+
:ref:`Vector2i<class_Vector2i>` **texture_region_size** = ``Vector2i(16, 16)``
.. rst-class:: classref-property-setget
- void **set_texture_region_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_texture_region_size** **(** **)**
The base tile size in the texture (in pixel). This size must be bigger than the TileSet's ``tile_size`` value.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_property_use_texture_padding:
- :ref:`bool<class_bool>` **use_texture_padding**
.. rst-class:: classref-property
+-----------+--------------------------------+
| *Default* | ``true`` |
+-----------+--------------------------------+
| *Setter* | set_use_texture_padding(value) |
+-----------+--------------------------------+
| *Getter* | get_use_texture_padding() |
+-----------+--------------------------------+
:ref:`bool<class_bool>` **use_texture_padding** = ``true``
.. rst-class:: classref-property-setget
- void **set_use_texture_padding** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_use_texture_padding** **(** **)**
If ``true``, generates an internal texture with an additional one pixel padding around each tile. Texture padding avoids a common artifact where lines appear between tiles.
Disabling this setting might lead a small performance improvement, as generating the internal texture requires both memory and processing time when the TileSetAtlasSource resource is modified.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_TileSetAtlasSource_method_create_alternative_tile:
- :ref:`int<class_int>` **create_alternative_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_id_override=-1 **)**
.. rst-class:: classref-method
:ref:`int<class_int>` **create_alternative_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_id_override=-1 **)**
Creates an alternative tile for the tile at coordinates ``atlas_coords``. If ``alternative_id_override`` is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise.
Returns the new alternative identifier, or -1 if the alternative could not be created with a provided ``alternative_id_override``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_create_tile:
- void **create_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size=Vector2i(1, 1) **)**
.. rst-class:: classref-method
void **create_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size=Vector2i(1, 1) **)**
Creates a new tile at coordinates ``atlas_coords`` with the given ``size``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_atlas_grid_size:
- :ref:`Vector2i<class_Vector2i>` **get_atlas_grid_size** **(** **)** |const|
.. rst-class:: classref-method
:ref:`Vector2i<class_Vector2i>` **get_atlas_grid_size** **(** **)** |const|
Returns the atlas grid size, which depends on how many tiles can fit in the texture. It thus depends on the Texture's size, the atlas ``margins`` the tiles' ``texture_region_size``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_next_alternative_tile_id:
- :ref:`int<class_int>` **get_next_alternative_tile_id** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`int<class_int>` **get_next_alternative_tile_id** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns the alternative ID a following call to :ref:`create_alternative_tile<class_TileSetAtlasSource_method_create_alternative_tile>` would return.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_runtime_texture:
- :ref:`Texture2D<class_Texture2D>` **get_runtime_texture** **(** **)** |const|
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **get_runtime_texture** **(** **)** |const|
If :ref:`use_texture_padding<class_TileSetAtlasSource_property_use_texture_padding>` is ``false``, returns :ref:`texture<class_TileSetAtlasSource_property_texture>`. Otherwise, returns and internal :ref:`ImageTexture<class_ImageTexture>` created that includes the padding.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_runtime_tile_texture_region:
- :ref:`Rect2i<class_Rect2i>` **get_runtime_tile_texture_region** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame **)** |const|
.. rst-class:: classref-method
:ref:`Rect2i<class_Rect2i>` **get_runtime_tile_texture_region** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame **)** |const|
Returns the region of the tile at coordinates ``atlas_coords`` for the given ``frame`` inside the texture returned by :ref:`get_runtime_texture<class_TileSetAtlasSource_method_get_runtime_texture>`.
\ **Note:** If :ref:`use_texture_padding<class_TileSetAtlasSource_property_use_texture_padding>` is ``false``, returns the same as :ref:`get_tile_texture_region<class_TileSetAtlasSource_method_get_tile_texture_region>`.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_columns:
- :ref:`int<class_int>` **get_tile_animation_columns** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`int<class_int>` **get_tile_animation_columns** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns how many columns the tile at ``atlas_coords`` has in its animation layout.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_frame_duration:
- :ref:`float<class_float>` **get_tile_animation_frame_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index **)** |const|
.. rst-class:: classref-method
:ref:`float<class_float>` **get_tile_animation_frame_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index **)** |const|
Returns the animation frame duration of frame ``frame_index`` for the tile at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_frames_count:
- :ref:`int<class_int>` **get_tile_animation_frames_count** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`int<class_int>` **get_tile_animation_frames_count** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns how many animation frames has the tile at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_separation:
- :ref:`Vector2i<class_Vector2i>` **get_tile_animation_separation** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`Vector2i<class_Vector2i>` **get_tile_animation_separation** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_speed:
- :ref:`float<class_float>` **get_tile_animation_speed** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`float<class_float>` **get_tile_animation_speed** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns the animation speed of the tile at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_animation_total_duration:
- :ref:`float<class_float>` **get_tile_animation_total_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`float<class_float>` **get_tile_animation_total_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns the sum of the sum of the frame durations of the tile at coordinates ``atlas_coords``. This value needs to be divided by the animation speed to get the actual animation loop duration.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_at_coords:
- :ref:`Vector2i<class_Vector2i>` **get_tile_at_coords** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`Vector2i<class_Vector2i>` **get_tile_at_coords** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
If there is a tile covering the ``atlas_coords`` coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns ``Vector2i(-1, -1)`` otherwise.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_data:
- :ref:`TileData<class_TileData>` **get_tile_data** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |const|
.. rst-class:: classref-method
:ref:`TileData<class_TileData>` **get_tile_data** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)** |const|
Returns the :ref:`TileData<class_TileData>` object for the given atlas coordinates and alternative ID.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_size_in_atlas:
- :ref:`Vector2i<class_Vector2i>` **get_tile_size_in_atlas** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
.. rst-class:: classref-method
:ref:`Vector2i<class_Vector2i>` **get_tile_size_in_atlas** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)** |const|
Returns the size of the tile (in the grid coordinates system) at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tile_texture_region:
- :ref:`Rect2i<class_Rect2i>` **get_tile_texture_region** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame=0 **)** |const|
.. rst-class:: classref-method
:ref:`Rect2i<class_Rect2i>` **get_tile_texture_region** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame=0 **)** |const|
Returns a tile's texture region in the atlas texture. For animated tiles, a ``frame`` argument might be provided for the different frames of the animation.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_get_tiles_to_be_removed_on_change:
- :ref:`PackedVector2Array<class_PackedVector2Array>` **get_tiles_to_be_removed_on_change** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2i<class_Vector2i>` margins, :ref:`Vector2i<class_Vector2i>` separation, :ref:`Vector2i<class_Vector2i>` texture_region_size **)**
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` **get_tiles_to_be_removed_on_change** **(** :ref:`Texture2D<class_Texture2D>` texture, :ref:`Vector2i<class_Vector2i>` margins, :ref:`Vector2i<class_Vector2i>` separation, :ref:`Vector2i<class_Vector2i>` texture_region_size **)**
Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: ``texture``, ``margins``, ``separation`` or ``texture_region_size``. This can be used to undo changes that would have caused tiles data loss.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_has_room_for_tile:
- :ref:`bool<class_bool>` **has_room_for_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` animation_columns, :ref:`Vector2i<class_Vector2i>` animation_separation, :ref:`int<class_int>` frames_count, :ref:`Vector2i<class_Vector2i>` ignored_tile=Vector2i(-1, -1) **)** |const|
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_room_for_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` animation_columns, :ref:`Vector2i<class_Vector2i>` animation_separation, :ref:`int<class_int>` frames_count, :ref:`Vector2i<class_Vector2i>` ignored_tile=Vector2i(-1, -1) **)** |const|
Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If ``ignored_tile`` is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_move_tile_in_atlas:
- void **move_tile_in_atlas** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i<class_Vector2i>` new_size=Vector2i(-1, -1) **)**
.. rst-class:: classref-method
void **move_tile_in_atlas** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` new_atlas_coords=Vector2i(-1, -1), :ref:`Vector2i<class_Vector2i>` new_size=Vector2i(-1, -1) **)**
Move the tile and its alternatives at the ``atlas_coords`` coordinates to the ``new_atlas_coords`` coordinates with the ``new_size`` size. This functions will fail if a tile is already present in the given area.
@@ -343,71 +446,103 @@ If ``new_atlas_coords`` is ``Vector2i(-1, -1)``, keeps the tile's coordinates. I
To avoid an error, first check if a move is possible using :ref:`has_room_for_tile<class_TileSetAtlasSource_method_has_room_for_tile>`.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_remove_alternative_tile:
- void **remove_alternative_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)**
.. rst-class:: classref-method
void **remove_alternative_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile **)**
Remove a tile's alternative with alternative ID ``alternative_tile``.
Calling this function with ``alternative_tile`` equals to 0 will fail, as the base tile alternative cannot be removed.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_remove_tile:
- void **remove_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)**
.. rst-class:: classref-method
void **remove_tile** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords **)**
Remove a tile and its alternative at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_alternative_tile_id:
- void **set_alternative_tile_id** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile, :ref:`int<class_int>` new_id **)**
.. rst-class:: classref-method
void **set_alternative_tile_id** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` alternative_tile, :ref:`int<class_int>` new_id **)**
Change a tile's alternative ID from ``alternative_tile`` to ``new_id``.
Calling this function with ``new_id`` of 0 will fail, as the base tile alternative cannot be moved.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_tile_animation_columns:
- void **set_tile_animation_columns** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_columns **)**
.. rst-class:: classref-method
void **set_tile_animation_columns** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_columns **)**
Sets the number of columns in the animation layout of the tile at coordinates ``atlas_coords``. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_tile_animation_frame_duration:
- void **set_tile_animation_frame_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index, :ref:`float<class_float>` duration **)**
.. rst-class:: classref-method
void **set_tile_animation_frame_duration** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frame_index, :ref:`float<class_float>` duration **)**
Sets the animation frame ``duration`` of frame ``frame_index`` for the tile at coordinates ``atlas_coords``.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_tile_animation_frames_count:
- void **set_tile_animation_frames_count** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frames_count **)**
.. rst-class:: classref-method
void **set_tile_animation_frames_count** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`int<class_int>` frames_count **)**
Sets how many animation frames the tile at coordinates ``atlas_coords`` has.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_tile_animation_separation:
- void **set_tile_animation_separation** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` separation **)**
.. rst-class:: classref-method
void **set_tile_animation_separation** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`Vector2i<class_Vector2i>` separation **)**
Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates ``atlas_coords`` has.
.. rst-class:: classref-item-separator
----
.. _class_TileSetAtlasSource_method_set_tile_animation_speed:
- void **set_tile_animation_speed** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`float<class_float>` speed **)**
.. rst-class:: classref-method
void **set_tile_animation_speed** **(** :ref:`Vector2i<class_Vector2i>` atlas_coords, :ref:`float<class_float>` speed **)**
Sets the animation speed of the tile at coordinates ``atlas_coords`` has.