2021-05-07 21:41:39 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 08:44:37 +08:00
<class name= "TileSetSource" inherits= "Resource" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2021-05-07 21:41:39 +08:00
<brief_description >
2021-09-06 17:56:31 +08:00
Exposes a set of tiles for a [TileSet] resource.
2021-05-07 21:41:39 +08:00
</brief_description>
<description >
2021-09-06 17:56:31 +08:00
Exposes a set of tiles for a [TileSet] resource.
Tiles in a source are indexed with two IDs, coordinates ID (of type Vector2i) and an alternative ID (of type int), named according to their use in the [TileSetAtlasSource] class.
Depending on the TileSet source type, those IDs might have restrictions on their values, this is why the base [TileSetSource] class only exposes getters for them.
You can iterate over all tiles exposed by a TileSetSource by first iterating over coordinates IDs using [method get_tiles_count] and [method get_tile_id], then over alternative IDs using [method get_alternative_tiles_count] and [method get_alternative_tile_id].
2021-05-07 21:41:39 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2021-09-06 17:56:31 +08:00
<method name= "get_alternative_tile_id" qualifiers= "const" >
<return type= "int" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "atlas_coords" type= "Vector2i" />
<param index= "1" name= "index" type= "int" />
2021-09-06 17:56:31 +08:00
<description >
2022-08-09 23:19:47 +08:00
Returns the alternative ID for the tile with coordinates ID [param atlas_coords] at index [param index].
2021-09-06 17:56:31 +08:00
</description>
</method>
<method name= "get_alternative_tiles_count" qualifiers= "const" >
<return type= "int" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "atlas_coords" type= "Vector2i" />
2021-09-06 17:56:31 +08:00
<description >
2022-08-09 23:19:47 +08:00
Returns the number of alternatives tiles for the coordinates ID [param atlas_coords].
2021-09-06 17:56:31 +08:00
For [TileSetAtlasSource], this always return at least 1, as the base tile with ID 0 is always part of the alternatives list.
Returns -1 if there is not tile at the given coords.
</description>
</method>
<method name= "get_tile_id" qualifiers= "const" >
<return type= "Vector2i" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "index" type= "int" />
2021-09-06 17:56:31 +08:00
<description >
2022-08-09 23:19:47 +08:00
Returns the tile coordinates ID of the tile with index [param index].
2021-09-06 17:56:31 +08:00
</description>
</method>
<method name= "get_tiles_count" qualifiers= "const" >
<return type= "int" />
<description >
Returns how many tiles this atlas source defines (not including alternative tiles).
</description>
</method>
<method name= "has_alternative_tile" qualifiers= "const" >
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "atlas_coords" type= "Vector2i" />
<param index= "1" name= "alternative_tile" type= "int" />
2021-09-06 17:56:31 +08:00
<description >
2022-08-09 23:19:47 +08:00
Returns if the base tile at coordinates [param atlas_coords] has an alternative with ID [param alternative_tile].
2021-09-06 17:56:31 +08:00
</description>
</method>
<method name= "has_tile" qualifiers= "const" >
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "atlas_coords" type= "Vector2i" />
2021-09-06 17:56:31 +08:00
<description >
2022-08-09 23:19:47 +08:00
Returns if this atlas has a tile with coordinates ID [param atlas_coords].
2021-09-06 17:56:31 +08:00
</description>
</method>
2021-05-07 21:41:39 +08:00
</methods>
</class>