Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-22 17:17:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updates to the LayeredTileMap modules's docs.

Browse Source
This commit is contained in:
Relintai 2024-03-10 10:29:38 +01:00
parent b3a5b516f7
commit f54b3c8a45
7 changed files with 347 additions and 347 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
modules/layered_tile_map/doc_classes/LayeredTileData.xml
View File

@ -1,78 +1,78 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TileData" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="LayeredTileData" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Settings for a single tile in a [LayeredTileSet].
</brief_description>
<description>
[TileData] object represents a single tile in a [LayeredTileSet]. It is usually edited using the tileset editor, but it can be modified at runtime using [method LayeredTileMap._tile_data_runtime_update].
[LayeredTileData] object represents a single tile in a [LayeredTileSet]. It is usually edited using the tileset editor, but it can be modified at runtime using [method LayeredTileMap._tile_data_runtime_update].
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_collision_polygon">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<argument index="0" name="layer_id" type="int" />
<description>
Adds a collision polygon to the tile on the given LayeredTileSet physics layer.
</description>
</method>
<method name="get_collision_polygon_one_way_margin" qualifiers="const">
<return type="float" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<description>
Returns the one-way margin (for one-way platforms) of the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="get_collision_polygon_points" qualifiers="const">
<return type="PoolVector2Array" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<description>
Returns the points of the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="get_collision_polygons_count" qualifiers="const">
<return type="int" />
<param index="0" name="layer_id" type="int" />
<argument index="0" name="layer_id" type="int" />
<description>
Returns how many polygons the tile has for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="get_constant_angular_velocity" qualifiers="const">
<return type="float" />
<param index="0" name="layer_id" type="int" />
<argument index="0" name="layer_id" type="int" />
<description>
Returns the constant angular velocity applied to objects colliding with this tile.
</description>
</method>
<method name="get_constant_linear_velocity" qualifiers="const">
<return type="Vector2" />
<param index="0" name="layer_id" type="int" />
<argument index="0" name="layer_id" type="int" />
<description>
Returns the constant linear velocity applied to objects colliding with this tile.
</description>
</method>
<method name="get_custom_data" qualifiers="const">
<return type="Variant" />
<param index="0" name="layer_name" type="String" />
<argument index="0" name="layer_name" type="String" />
<description>
Returns the custom data value for custom data layer named [param layer_name].
</description>
</method>
<method name="get_custom_data_by_layer_id" qualifiers="const">
<return type="Variant" />
<param index="0" name="layer_id" type="int" />
<argument index="0" name="layer_id" type="int" />
<description>
Returns the custom data value for custom data layer with index [param layer_id].
</description>
</method>
<method name="get_navigation_polygon" qualifiers="const">
<return type="NavigationPolygon" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="flip_h" type="bool" default="false" />
<param index="2" name="flip_v" type="bool" default="false" />
<param index="3" name="transpose" type="bool" default="false" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="flip_h" type="bool" default="false" />
<argument index="2" name="flip_v" type="bool" default="false" />
<argument index="3" name="transpose" type="bool" default="false" />
<description>
Returns the navigation polygon of the tile for the LayeredTileSet navigation layer with index [param layer_id].
[param flip_h], [param flip_v], and [param transpose] allow transforming the returned polygon.
@ -80,10 +80,10 @@
</method>
<method name="get_occluder" qualifiers="const">
<return type="OccluderPolygon2D" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="flip_h" type="bool" default="false" />
<param index="2" name="flip_v" type="bool" default="false" />
<param index="3" name="transpose" type="bool" default="false" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="flip_h" type="bool" default="false" />
<argument index="2" name="flip_v" type="bool" default="false" />
<argument index="3" name="transpose" type="bool" default="false" />
<description>
Returns the occluder polygon of the tile for the LayeredTileSet occlusion layer with index [param layer_id].
[param flip_h], [param flip_v], and [param transpose] allow transforming the returned polygon.
@ -91,114 +91,114 @@
</method>
<method name="get_terrain_peering_bit" qualifiers="const">
<return type="int" />
<param index="0" name="peering_bit" type="int" enum="LayeredTileSet.CellNeighbor" />
<argument index="0" name="peering_bit" type="int" enum="LayeredTileSet.CellNeighbor" />
<description>
Returns the tile's terrain bit for the given [param peering_bit] direction.
</description>
</method>
<method name="is_collision_polygon_one_way" qualifiers="const">
<return type="bool" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<description>
Returns whether one-way collisions are enabled for the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="remove_collision_polygon">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<description>
Removes the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_collision_polygon_one_way">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<param index="2" name="one_way" type="bool" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<argument index="2" name="one_way" type="bool" />
<description>
Enables/disables one-way collisions on the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_collision_polygon_one_way_margin">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<param index="2" name="one_way_margin" type="float" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<argument index="2" name="one_way_margin" type="float" />
<description>
Enables/disables one-way collisions on the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_collision_polygon_points">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygon_index" type="int" />
<param index="2" name="polygon" type="PoolVector2Array" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygon_index" type="int" />
<argument index="2" name="polygon" type="PoolVector2Array" />
<description>
Sets the points of the polygon at index [param polygon_index] for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_collision_polygons_count">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="polygons_count" type="int" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="polygons_count" type="int" />
<description>
Sets the polygons count for LayeredTileSet physics layer with index [param layer_id].
</description>
</method>
<method name="set_constant_angular_velocity">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="velocity" type="float" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="velocity" type="float" />
<description>
Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile.
</description>
</method>
<method name="set_constant_linear_velocity">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="velocity" type="Vector2" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="velocity" type="Vector2" />
<description>
Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts.
</description>
</method>
<method name="set_custom_data">
<return type="void" />
<param index="0" name="layer_name" type="String" />
<param index="1" name="value" type="Variant" />
<argument index="0" name="layer_name" type="String" />
<argument index="1" name="value" type="Variant" />
<description>
Sets the tile's custom data value for the LayeredTileSet custom data layer with name [param layer_name].
</description>
</method>
<method name="set_custom_data_by_layer_id">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="value" type="Variant" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="value" type="Variant" />
<description>
Sets the tile's custom data value for the LayeredTileSet custom data layer with index [param layer_id].
</description>
</method>
<method name="set_navigation_polygon">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="navigation_polygon" type="NavigationPolygon" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="navigation_polygon" type="NavigationPolygon" />
<description>
Sets the navigation polygon for the LayeredTileSet navigation layer with index [param layer_id].
</description>
</method>
<method name="set_occluder">
<return type="void" />
<param index="0" name="layer_id" type="int" />
<param index="1" name="occluder_polygon" type="OccluderPolygon2D" />
<argument index="0" name="layer_id" type="int" />
<argument index="1" name="occluder_polygon" type="OccluderPolygon2D" />
<description>
Sets the occluder for the LayeredTileSet occlusion layer with index [param layer_id].
</description>
</method>
<method name="set_terrain_peering_bit">
<return type="void" />
<param index="0" name="peering_bit" type="int" enum="LayeredTileSet.CellNeighbor" />
<param index="1" name="terrain" type="int" />
<argument index="0" name="peering_bit" type="int" enum="LayeredTileSet.CellNeighbor" />
<argument index="1" name="terrain" type="int" />
<description>
Sets the tile's terrain bit for the given [param peering_bit] direction.
</description>
@ -212,7 +212,7 @@
If [code]true[/code], the tile will have its texture flipped vertically.
</member>
<member name="material" type="Material" setter="set_material" getter="get_material">
The [Material] to use for this [TileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader.
The [Material] to use for this [LayeredTileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader.
</member>
<member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)" keywords="color, colour">
Color modulation of the tile.

184
modules/layered_tile_map/doc_classes/LayeredTileMap.xml
View File

@ -20,11 +20,11 @@
<methods>
<method name="_tile_data_runtime_update" qualifiers="virtual">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="tile_data" type="TileData" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="tile_data" type="LayeredTileData" />
<description>
Called with a TileData object about to be used internally by the LayeredTileMap, allowing its modification at runtime.
Called with a LayeredTileData object about to be used internally by the LayeredTileMap, allowing its modification at runtime.
This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [param coords] and [param layer].
[b]Warning:[/b] The [param tile_data] object's sub-resources are the same as the one in the LayeredTileSet. Modifying them might impact the whole LayeredTileSet. Instead, make sure to duplicate those resources.
[b]Note:[/b] If the properties of [param tile_data] object should change over time, use [method notify_runtime_tile_data_update] to notify the LayeredTileMap it needs an update.
@ -32,8 +32,8 @@
</method>
<method name="_use_tile_data_runtime_update" qualifiers="virtual">
<return type="bool" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<description>
Should return [code]true[/code] if the tile at coordinates [param coords] on layer [param layer] requires a runtime update.
[b]Warning:[/b] Make sure this function only return [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty.
@ -42,7 +42,7 @@
</method>
<method name="add_layer">
<return type="void" />
<param index="0" name="to_position" type="int" />
<argument index="0" name="to_position" type="int" />
<description>
Adds a layer at the given position [param to_position] in the array. If [param to_position] is negative, the position is counted from the end, with [code]-1[/code] adding the layer at the end of the array.
</description>
@ -55,7 +55,7 @@
</method>
<method name="clear_layer">
<return type="void" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Clears all cells on the given layer.
If [param layer] is negative, the layers are accessed from the last one.
@ -63,8 +63,8 @@
</method>
<method name="erase_cell">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<description>
Erases the cell on layer [param layer] at coordinates [param coords].
If [param layer] is negative, the layers are accessed from the last one.
@ -78,16 +78,16 @@
</method>
<method name="force_update" deprecated="Use [method notify_runtime_tile_data_update] and/or [method update_internals] instead.">
<return type="void" />
<param index="0" name="layer" type="int" default="-1" />
<argument index="0" name="layer" type="int" default="-1" />
<description>
Forces the LayeredTileMap and the layer [param layer] to update.
</description>
</method>
<method name="get_cell_alternative_tile" qualifiers="const">
<return type="int" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="use_proxies" type="bool" default="false" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" default="false" />
<description>
Returns the tile alternative ID of the cell on layer [param layer] at [param coords]. If [param use_proxies] is [code]false[/code], ignores the [LayeredTileSet]'s tile proxies, returning the raw alternative identifier. See [method LayeredTileSet.map_tile_proxy].
If [param layer] is negative, the layers are accessed from the last one.
@ -95,9 +95,9 @@
</method>
<method name="get_cell_atlas_coords" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="use_proxies" type="bool" default="false" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" default="false" />
<description>
Returns the tile atlas coordinates ID of the cell on layer [param layer] at coordinates [param coords]. If [param use_proxies] is [code]false[/code], ignores the [LayeredTileSet]'s tile proxies, returning the raw alternative identifier. See [method LayeredTileSet.map_tile_proxy].
If [param layer] is negative, the layers are accessed from the last one.
@ -105,9 +105,9 @@
</method>
<method name="get_cell_source_id" qualifiers="const">
<return type="int" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="use_proxies" type="bool" default="false" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" default="false" />
<description>
Returns the tile source ID of the cell on layer [param layer] at coordinates [param coords]. Returns [code]-1[/code] if the cell does not exist.
If [param use_proxies] is [code]false[/code], ignores the [LayeredTileSet]'s tile proxies, returning the raw alternative identifier. See [method LayeredTileSet.map_tile_proxy].
@ -115,12 +115,12 @@
</description>
</method>
<method name="get_cell_tile_data" qualifiers="const">
<return type="TileData" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="use_proxies" type="bool" default="false" />
<return type="LayeredTileData" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" default="false" />
<description>
Returns the [TileData] object associated with the given cell, or [code]null[/code] if the cell does not exist or is not a [LayeredTileSetAtlasSource].
Returns the [LayeredTileData] object associated with the given cell, or [code]null[/code] if the cell does not exist or is not a [LayeredTileSetAtlasSource].
If [param layer] is negative, the layers are accessed from the last one.
If [param use_proxies] is [code]false[/code], ignores the [LayeredTileSet]'s tile proxies, returning the raw alternative identifier. See [method LayeredTileSet.map_tile_proxy].
[codeblock]
@ -136,21 +136,21 @@
</method>
<method name="get_coords_for_body_rid">
<return type="Vector2i" />
<param index="0" name="body" type="RID" />
<argument index="0" name="body" type="RID" />
<description>
Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile.
</description>
</method>
<method name="get_layer_for_body_rid">
<return type="int" />
<param index="0" name="body" type="RID" />
<argument index="0" name="body" type="RID" />
<description>
Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile.
</description>
</method>
<method name="get_layer_modulate" qualifiers="const">
<return type="Color" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns a LayeredTileMap layer's modulate.
If [param layer] is negative, the layers are accessed from the last one.
@ -158,7 +158,7 @@
</method>
<method name="get_layer_name" qualifiers="const">
<return type="String" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns a LayeredTileMap layer's name.
If [param layer] is negative, the layers are accessed from the last one.
@ -166,7 +166,7 @@
</method>
<method name="get_layer_navigation_map" qualifiers="const">
<return type="RID" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified LayeredTileMap layer [param layer].
By default the LayeredTileMap uses the default [World2D] navigation map for the first LayeredTileMap layer. For each additional LayeredTileMap layer a new navigation map is created for the additional layer.
@ -176,7 +176,7 @@
</method>
<method name="get_layer_y_sort_origin" qualifiers="const">
<return type="int" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns a LayeredTileMap layer's Y sort origin.
If [param layer] is negative, the layers are accessed from the last one.
@ -184,7 +184,7 @@
</method>
<method name="get_layer_z_index" qualifiers="const">
<return type="int" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns a LayeredTileMap layer's Z-index value.
If [param layer] is negative, the layers are accessed from the last one.
@ -198,23 +198,23 @@
</method>
<method name="get_navigation_map" qualifiers="const" deprecated="Use [method get_layer_navigation_map] instead.">
<return type="RID" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified LayeredTileMap layer [param layer].
</description>
</method>
<method name="get_neighbor_cell" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="coords" type="Vector2i" />
<param index="1" name="neighbor" type="int" enum="LayeredTileSet.CellNeighbor" />
<argument index="0" name="coords" type="Vector2i" />
<argument index="1" name="neighbor" type="int" enum="LayeredTileSet.CellNeighbor" />
<description>
Returns the neighboring cell to the one at coordinates [param coords], identified by the [param neighbor] direction. This method takes into account the different layouts a LayeredTileMap can take.
</description>
</method>
<method name="get_pattern">
<return type="LayeredTileMapPattern" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords_array" type="Vector2i[]" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords_array" type="Vector2i[]" />
<description>
Creates a new [LayeredTileMapPattern] from the given layer and set of cells.
If [param layer] is negative, the layers are accessed from the last one.
@ -222,14 +222,14 @@
</method>
<method name="get_surrounding_cells">
<return type="Vector2i[]" />
<param index="0" name="coords" type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<description>
Returns the list of all neighbourings cells to the one at [param coords].
</description>
</method>
<method name="get_used_cells" qualifiers="const">
<return type="Vector2i[]" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns a [Vector2i] array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is [code]Vector2(-1, -1)[/code] and its alternative identifier is -1.
If [param layer] is negative, the layers are accessed from the last one.
@ -237,10 +237,10 @@
</method>
<method name="get_used_cells_by_id" qualifiers="const">
<return type="Vector2i[]" />
<param index="0" name="layer" type="int" />
<param index="1" name="source_id" type="int" default="-1" />
<param index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="3" name="alternative_tile" type="int" default="-1" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="source_id" type="int" default="-1" />
<argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="3" name="alternative_tile" type="int" default="-1" />
<description>
Returns a [Vector2i] array with the positions of all cells containing a tile in the given layer. Tiles may be filtered according to their source ([param source_id]), their atlas coordinates ([param atlas_coords]) or alternative id ([param alternative_tile]).
If a parameter has its value set to the default one, this parameter is not used to filter a cell. Thus, if all parameters have their respective default value, this method returns the same result as [method get_used_cells].
@ -256,7 +256,7 @@
</method>
<method name="is_layer_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns if a layer is enabled.
If [param layer] is negative, the layers are accessed from the last one.
@ -264,14 +264,14 @@
</method>
<method name="is_layer_navigation_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns if a layer's built-in navigation regions generation is enabled.
</description>
</method>
<method name="is_layer_y_sort_enabled" qualifiers="const">
<return type="bool" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Returns if a layer Y-sorts its tiles.
If [param layer] is negative, the layers are accessed from the last one.
@ -279,39 +279,39 @@
</method>
<method name="local_to_map" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="local_position" type="Vector2" />
<argument index="0" name="local_position" type="Vector2" />
<description>
Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node2D.to_local] before passing it to this method. See also [method map_to_local].
</description>
</method>
<method name="map_pattern">
<return type="Vector2i" />
<param index="0" name="position_in_tilemap" type="Vector2i" />
<param index="1" name="coords_in_pattern" type="Vector2i" />
<param index="2" name="pattern" type="LayeredTileMapPattern" />
<argument index="0" name="position_in_tilemap" type="Vector2i" />
<argument index="1" name="coords_in_pattern" type="Vector2i" />
<argument index="2" name="pattern" type="LayeredTileMapPattern" />
<description>
Returns for the given coordinate [param coords_in_pattern] in a [LayeredTileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [param position_in_tilemap] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code].
</description>
</method>
<method name="map_to_local" qualifiers="const">
<return type="Vector2" />
<param index="0" name="map_position" type="Vector2i" />
<argument index="0" name="map_position" type="Vector2i" />
<description>
Returns the centered position of a cell in the LayeredTileMap's local coordinate space. To convert the returned value into global coordinates, use [method Node2D.to_global]. See also [method local_to_map].
[b]Note:[/b] This may not correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_origin] property of individual tiles.
[b]Note:[/b] This may not correspond to the visual position of the tile, i.e. it ignores the [member LayeredTileData.texture_origin] property of individual tiles.
</description>
</method>
<method name="move_layer">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the layer at index [param layer] to the given position [param to_position] in the array.
</description>
</method>
<method name="notify_runtime_tile_data_update">
<return type="void" />
<param index="0" name="layer" type="int" default="-1" />
<argument index="0" name="layer" type="int" default="-1" />
<description>
Notifies the LayeredTileMap node that calls to [method _use_tile_data_runtime_update] or [method _tile_data_runtime_update] will lead to different results. This will thus trigger a LayeredTileMap update.
If [param layer] is provided, only notifies changes for the given layer. Providing the [param layer] argument (when applicable) is usually preferred for performance reasons.
@ -321,18 +321,18 @@
</method>
<method name="remove_layer">
<return type="void" />
<param index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int" />
<description>
Removes the layer at index [param layer].
</description>
</method>
<method name="set_cell">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="coords" type="Vector2i" />
<param index="2" name="source_id" type="int" default="-1" />
<param index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="4" name="alternative_tile" type="int" default="0" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="source_id" type="int" default="-1" />
<argument index="3" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="4" name="alternative_tile" type="int" default="0" />
<description>
Sets the tile identifiers for the cell on layer [param layer] at coordinates [param coords]. Each tile of the [LayeredTileSet] is identified using three parts:
- The source identifier [param source_id] identifies a [LayeredTileSetSource] identifier. See [method LayeredTileSet.set_source_id],
@ -344,11 +344,11 @@
</method>
<method name="set_cells_terrain_connect">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="cells" type="Vector2i[]" />
<param index="2" name="terrain_set" type="int" />
<param index="3" name="terrain" type="int" />
<param index="4" name="ignore_empty_terrains" type="bool" default="true" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="cells" type="Vector2i[]" />
<argument index="2" name="terrain_set" type="int" />
<argument index="3" name="terrain" type="int" />
<argument index="4" name="ignore_empty_terrains" type="bool" default="true" />
<description>
Update all the cells in the [param cells] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions.
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
@ -358,11 +358,11 @@
</method>
<method name="set_cells_terrain_path">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="path" type="Vector2i[]" />
<param index="2" name="terrain_set" type="int" />
<param index="3" name="terrain" type="int" />
<param index="4" name="ignore_empty_terrains" type="bool" default="true" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="path" type="Vector2i[]" />
<argument index="2" name="terrain_set" type="int" />
<argument index="3" name="terrain" type="int" />
<argument index="4" name="ignore_empty_terrains" type="bool" default="true" />
<description>
Update all the cells in the [param path] coordinates array so that they use the given [param terrain] for the given [param terrain_set]. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions.
If [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.
@ -372,8 +372,8 @@
</method>
<method name="set_layer_enabled">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="bool" />
<description>
Enables or disables the layer [param layer]. A disabled layer is not processed at all (no rendering, no physics, etc...).
If [param layer] is negative, the layers are accessed from the last one.
@ -381,8 +381,8 @@
</method>
<method name="set_layer_modulate">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="modulate" type="Color" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="modulate" type="Color" />
<description>
Sets a layer's color. It will be multiplied by tile's color and LayeredTileMap's modulate.
If [param layer] is negative, the layers are accessed from the last one.
@ -390,8 +390,8 @@
</method>
<method name="set_layer_name">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="name" type="String" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="name" type="String" />
<description>
Sets a layer's name. This is mostly useful in the editor.
If [param layer] is negative, the layers are accessed from the last one.
@ -399,16 +399,16 @@
</method>
<method name="set_layer_navigation_enabled">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="enabled" type="bool" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="bool" />
<description>
Enables or disables a layer's built-in navigation regions generation. Disable this if you need to bake navigation regions from a LayeredTileMap using a [NavigationRegion2D] node.
</description>
</method>
<method name="set_layer_navigation_map">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="map" type="RID" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="map" type="RID" />
<description>
Assigns [param map] as a [NavigationServer2D] navigation map for the specified LayeredTileMap layer [param layer].
By default the LayeredTileMap uses the default [World2D] navigation map for the first LayeredTileMap layer. For each additional LayeredTileMap layer a new navigation map is created for the additional layer.
@ -418,8 +418,8 @@
</method>
<method name="set_layer_y_sort_enabled">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="y_sort_enabled" type="bool" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="y_sort_enabled" type="bool" />
<description>
Enables or disables a layer's Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted.
Y-sorted layers should usually be on different Z-index values than not Y-sorted layers, otherwise, each of those layer will be Y-sorted as whole with the Y-sorted one. This is usually an undesired behavior.
@ -428,8 +428,8 @@
</method>
<method name="set_layer_y_sort_origin">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="y_sort_origin" type="int" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="y_sort_origin" type="int" />
<description>
Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value.
This allows, for example, to fake a different height level on each layer. This can be useful for top-down view games.
@ -438,8 +438,8 @@
</method>
<method name="set_layer_z_index">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="z_index" type="int" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="z_index" type="int" />
<description>
Sets a layers Z-index value. This Z-index is added to each tile's Z-index value.
If [param layer] is negative, the layers are accessed from the last one.
@ -447,17 +447,17 @@
</method>
<method name="set_navigation_map" deprecated="Use [method set_layer_navigation_map] instead.">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="map" type="RID" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="map" type="RID" />
<description>
Assigns [param map] as a [NavigationServer2D] navigation map for the specified LayeredTileMap layer [param layer].
</description>
</method>
<method name="set_pattern">
<return type="void" />
<param index="0" name="layer" type="int" />
<param index="1" name="position" type="Vector2i" />
<param index="2" name="pattern" type="LayeredTileMapPattern" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="position" type="Vector2i" />
<argument index="2" name="pattern" type="LayeredTileMapPattern" />
<description>
Paste the given [LayeredTileMapPattern] at the given [param position] and [param layer] in the tile map.
If [param layer] is negative, the layers are accessed from the last one.

22
modules/layered_tile_map/doc_classes/LayeredTileMapPattern.xml
View File

@ -12,21 +12,21 @@
<methods>
<method name="get_cell_alternative_tile" qualifiers="const">
<return type="int" />
<param index="0" name="coords" type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<description>
Returns the tile alternative ID of the cell at [param coords].
</description>
</method>
<method name="get_cell_atlas_coords" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="coords" type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<description>
Returns the tile atlas coordinates ID of the cell at [param coords].
</description>
</method>
<method name="get_cell_source_id" qualifiers="const">
<return type="int" />
<param index="0" name="coords" type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<description>
Returns the tile source ID of the cell at [param coords].
</description>
@ -45,7 +45,7 @@
</method>
<method name="has_cell" qualifiers="const">
<return type="bool" />
<param index="0" name="coords" type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<description>
Returns whether the pattern has a tile at the given coordinates.
</description>
@ -58,25 +58,25 @@
</method>
<method name="remove_cell">
<return type="void" />
<param index="0" name="coords" type="Vector2i" />
<param index="1" name="update_size" type="bool" />
<argument index="0" name="coords" type="Vector2i" />
<argument index="1" name="update_size" type="bool" />
<description>
Remove the cell at the given coordinates.
</description>
</method>
<method name="set_cell">
<return type="void" />
<param index="0" name="coords" type="Vector2i" />
<param index="1" name="source_id" type="int" default="-1" />
<param index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="3" name="alternative_tile" type="int" default="-1" />
<argument index="0" name="coords" type="Vector2i" />
<argument index="1" name="source_id" type="int" default="-1" />
<argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="3" name="alternative_tile" type="int" default="-1" />
<description>
Sets the tile identifiers for the cell at coordinates [param coords]. See [method LayeredTileMap.set_cell].
</description>
</method>
<method name="set_size">
<return type="void" />
<param index="0" name="size" type="Vector2i" />
<argument index="0" name="size" type="Vector2i" />
<description>
Sets the size of the pattern.
</description>

232
modules/layered_tile_map/doc_classes/LayeredTileSet.xml
View File

@ -23,7 +23,7 @@
<methods>
<method name="add_custom_data_layer">
<return type="void" />
<param index="0" name="to_position" type="int" default="-1" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
Adds a custom data layer to the LayeredTileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Custom data layers allow assigning custom properties to atlas tiles.
@ -31,7 +31,7 @@
</method>
<method name="add_navigation_layer">
<return type="void" />
<param index="0" name="to_position" type="int" default="-1" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
Adds a navigation layer to the LayeredTileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Navigation layers allow assigning a navigable area to atlas tiles.
@ -39,7 +39,7 @@
</method>
<method name="add_occlusion_layer">
<return type="void" />
<param index="0" name="to_position" type="int" default="-1" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
Adds an occlusion layer to the LayeredTileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Occlusion layers allow assigning occlusion polygons to atlas tiles.
@ -47,15 +47,15 @@
</method>
<method name="add_pattern">
<return type="int" />
<param index="0" name="pattern" type="LayeredTileMapPattern" />
<param index="1" name="index" type="int" default="-1" />
<argument index="0" name="pattern" type="LayeredTileMapPattern" />
<argument index="1" name="index" type="int" default="-1" />
<description>
Adds a [LayeredTileMapPattern] to be stored in the LayeredTileSet resource. If provided, insert it at the given [param index].
</description>
</method>
<method name="add_physics_layer">
<return type="void" />
<param index="0" name="to_position" type="int" default="-1" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
Adds a physics layer to the LayeredTileSet at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
Physics layers allow assigning collision polygons to atlas tiles.
@ -63,8 +63,8 @@
</method>
<method name="add_source">
<return type="int" />
<param index="0" name="source" type="LayeredTileSetSource" />
<param index="1" name="atlas_source_id_override" type="int" default="-1" />
<argument index="0" name="source" type="LayeredTileSetSource" />
<argument index="1" name="atlas_source_id_override" type="int" default="-1" />
<description>
Adds a [LayeredTileSetSource] to the LayeredTileSet. If [param atlas_source_id_override] is not -1, also set its source ID. Otherwise, a unique identifier is automatically generated.
The function returns the added source ID or -1 if the source could not be added.
@ -73,15 +73,15 @@
</method>
<method name="add_terrain">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="to_position" type="int" default="-1" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="to_position" type="int" default="-1" />
<description>
Adds a new terrain to the given terrain set [param terrain_set] at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
</description>
</method>
<method name="add_terrain_set">
<return type="void" />
<param index="0" name="to_position" type="int" default="-1" />
<argument index="0" name="to_position" type="int" default="-1" />
<description>
Adds a new terrain set at the given position [param to_position] in the array. If [param to_position] is -1, adds it at the end of the array.
</description>
@ -100,9 +100,9 @@
</method>
<method name="get_alternative_level_tile_proxy">
<return type="Array" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="alternative_from" type="int" />
<description>
Returns the alternative-level proxy for the given identifiers. The returned array contains the three proxie's target identifiers (source ID, atlas coords ID and alternative tile ID).
If the LayeredTileSet has no proxy for the given identifiers, returns an empty Array.
@ -110,8 +110,8 @@
</method>
<method name="get_coords_level_tile_proxy">
<return type="Array" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<description>
Returns the coordinate-level proxy for the given identifiers. The returned array contains the two target identifiers of the proxy (source ID and atlas coordinates ID).
If the LayeredTileSet has no proxy for the given identifiers, returns an empty Array.
@ -119,21 +119,21 @@
</method>
<method name="get_custom_data_layer_by_name" qualifiers="const">
<return type="int" />
<param index="0" name="layer_name" type="String" />
<argument index="0" name="layer_name" type="String" />
<description>
Returns the index of the custom data layer identified by the given name.
</description>
</method>
<method name="get_custom_data_layer_name" qualifiers="const">
<return type="String" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the name of the custom data layer identified by the given index.
</description>
</method>
<method name="get_custom_data_layer_type" qualifiers="const">
<return type="int" enum="Variant.Type" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the type of the custom data layer identified by the given index.
</description>
@ -146,15 +146,15 @@
</method>
<method name="get_navigation_layer_layer_value" qualifiers="const">
<return type="bool" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_number" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_number" type="int" />
<description>
Returns whether or not the specified navigation layer of the LayeredTileSet navigation data layer identified by the given [param layer_index] is enabled, given a navigation_layers [param layer_number] between 1 and 32.
</description>
</method>
<method name="get_navigation_layer_layers" qualifiers="const">
<return type="int" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the navigation layers (as in the Navigation server) of the given LayeredTileSet navigation layer.
</description>
@ -173,14 +173,14 @@
</method>
<method name="get_occlusion_layer_light_mask" qualifiers="const">
<return type="int" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the light mask of the occlusion layer.
</description>
</method>
<method name="get_occlusion_layer_sdf_collision" qualifiers="const">
<return type="bool" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns if the occluders from this layer use [code]sdf_collision[/code].
</description>
@ -193,7 +193,7 @@
</method>
<method name="get_pattern">
<return type="LayeredTileMapPattern" />
<param index="0" name="index" type="int" default="-1" />
<argument index="0" name="index" type="int" default="-1" />
<description>
Returns the [LayeredTileMapPattern] at the given [param index].
</description>
@ -206,21 +206,21 @@
</method>
<method name="get_physics_layer_collision_layer" qualifiers="const">
<return type="int" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the collision layer (as in the physics server) bodies on the given LayeredTileSet's physics layer are in.
</description>
</method>
<method name="get_physics_layer_collision_mask" qualifiers="const">
<return type="int" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the collision mask of bodies on the given LayeredTileSet's physics layer.
</description>
</method>
<method name="get_physics_layer_physics_material" qualifiers="const">
<return type="PhysicsMaterial" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Returns the physics material of bodies on the given LayeredTileSet's physics layer.
</description>
@ -233,7 +233,7 @@
</method>
<method name="get_source" qualifiers="const">
<return type="LayeredTileSetSource" />
<param index="0" name="source_id" type="int" />
<argument index="0" name="source_id" type="int" />
<description>
Returns the [LayeredTileSetSource] with ID [param source_id].
</description>
@ -246,14 +246,14 @@
</method>
<method name="get_source_id" qualifiers="const">
<return type="int" />
<param index="0" name="index" type="int" />
<argument index="0" name="index" type="int" />
<description>
Returns the source ID for source with index [param index].
</description>
</method>
<method name="get_source_level_tile_proxy">
<return type="int" />
<param index="0" name="source_from" type="int" />
<argument index="0" name="source_from" type="int" />
<description>
Returns the source-level proxy for the given source identifier.
If the LayeredTileSet has no proxy for the given identifier, returns -1.
@ -261,23 +261,23 @@
</method>
<method name="get_terrain_color" qualifiers="const">
<return type="Color" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<description>
Returns a terrain's color.
</description>
</method>
<method name="get_terrain_name" qualifiers="const">
<return type="String" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<description>
Returns a terrain's name.
</description>
</method>
<method name="get_terrain_set_mode" qualifiers="const">
<return type="int" enum="LayeredTileSet.TerrainMode" />
<param index="0" name="terrain_set" type="int" />
<argument index="0" name="terrain_set" type="int" />
<description>
Returns a terrain set mode.
</description>
@ -290,47 +290,47 @@
</method>
<method name="get_terrains_count" qualifiers="const">
<return type="int" />
<param index="0" name="terrain_set" type="int" />
<argument index="0" name="terrain_set" type="int" />
<description>
Returns the number of terrains in the given terrain set.
</description>
</method>
<method name="has_alternative_level_tile_proxy">
<return type="bool" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="alternative_from" type="int" />
<description>
Returns if there is an alternative-level proxy for the given identifiers.
</description>
</method>
<method name="has_coords_level_tile_proxy">
<return type="bool" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<description>
Returns if there is a coodinates-level proxy for the given identifiers.
</description>
</method>
<method name="has_source" qualifiers="const">
<return type="bool" />
<param index="0" name="source_id" type="int" />
<argument index="0" name="source_id" type="int" />
<description>
Returns if this LayeredTileSet has a source for the given source ID.
</description>
</method>
<method name="has_source_level_tile_proxy">
<return type="bool" />
<param index="0" name="source_from" type="int" />
<argument index="0" name="source_from" type="int" />
<description>
Returns if there is a source-level proxy for the given source ID.
</description>
</method>
<method name="map_tile_proxy" qualifiers="const">
<return type="Array" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="alternative_from" type="int" />
<description>
According to the configured proxies, maps the provided identifiers to a new set of identifiers. The source ID, atlas coordinates ID and alternative tile ID are returned as a 3 elements Array.
This function first look for matching alternative-level proxies, then coordinates-level proxies, then source-level proxies.
@ -339,142 +339,142 @@
</method>
<method name="move_custom_data_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the custom data layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="move_navigation_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the navigation layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="move_occlusion_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the occlusion layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="move_physics_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the physics layer at index [param layer_index] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="move_terrain">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="to_position" type="int" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<argument index="2" name="to_position" type="int" />
<description>
Moves the terrain at index [param terrain_index] for terrain set [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="move_terrain_set">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="to_position" type="int" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="to_position" type="int" />
<description>
Moves the terrain set at index [param terrain_set] to the given position [param to_position] in the array. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_alternative_level_tile_proxy">
<return type="void" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="alternative_from" type="int" />
<description>
Removes an alternative-level proxy for the given identifiers.
</description>
</method>
<method name="remove_coords_level_tile_proxy">
<return type="void" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<description>
Removes a coordinates-level proxy for the given identifiers.
</description>
</method>
<method name="remove_custom_data_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Removes the custom data layer at index [param layer_index]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_navigation_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Removes the navigation layer at index [param layer_index]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_occlusion_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Removes the occlusion layer at index [param layer_index]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_pattern">
<return type="void" />
<param index="0" name="index" type="int" />
<argument index="0" name="index" type="int" />
<description>
Remove the [LayeredTileMapPattern] at the given index.
</description>
</method>
<method name="remove_physics_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<argument index="0" name="layer_index" type="int" />
<description>
Removes the physics layer at index [param layer_index]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_source">
<return type="void" />
<param index="0" name="source_id" type="int" />
<argument index="0" name="source_id" type="int" />
<description>
Removes the source with the given source ID.
</description>
</method>
<method name="remove_source_level_tile_proxy">
<return type="void" />
<param index="0" name="source_from" type="int" />
<argument index="0" name="source_from" type="int" />
<description>
Removes a source-level tile proxy.
</description>
</method>
<method name="remove_terrain">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<description>
Removes the terrain at index [param terrain_index] in the given terrain set [param terrain_set]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="remove_terrain_set">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<argument index="0" name="terrain_set" type="int" />
<description>
Removes the terrain set at index [param terrain_set]. Also updates the atlas tiles accordingly.
</description>
</method>
<method name="set_alternative_level_tile_proxy">
<return type="void" />
<param index="0" name="source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="alternative_from" type="int" />
<param index="3" name="source_to" type="int" />
<param index="4" name="coords_to" type="Vector2i" />
<param index="5" name="alternative_to" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="alternative_from" type="int" />
<argument index="3" name="source_to" type="int" />
<argument index="4" name="coords_to" type="Vector2i" />
<argument index="5" name="alternative_to" type="int" />
<description>
Create an alternative-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers.
This can be used to replace a tile in all LayeredTileMaps using this LayeredTileSet, as LayeredTileMap nodes will find and use the proxy's target tile when one is available.
@ -483,10 +483,10 @@
</method>
<method name="set_coords_level_tile_proxy">
<return type="void" />
<param index="0" name="p_source_from" type="int" />
<param index="1" name="coords_from" type="Vector2i" />
<param index="2" name="source_to" type="int" />
<param index="3" name="coords_to" type="Vector2i" />
<argument index="0" name="p_source_from" type="int" />
<argument index="1" name="coords_from" type="Vector2i" />
<argument index="2" name="source_to" type="int" />
<argument index="3" name="coords_to" type="Vector2i" />
<description>
Creates a coordinates-level proxy for the given identifiers. A proxy will map set of tile identifiers to another set of identifiers. The alternative tile ID is kept the same when using coordinates-level proxies.
This can be used to replace a tile in all LayeredTileMaps using this LayeredTileSet, as LayeredTileMap nodes will find and use the proxy's target tile when one is available.
@ -495,89 +495,89 @@
</method>
<method name="set_custom_data_layer_name">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_name" type="String" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_name" type="String" />
<description>
Sets the name of the custom data layer identified by the given index. Names are identifiers of the layer therefore if the name is already taken it will fail and raise an error.
</description>
</method>
<method name="set_custom_data_layer_type">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_type" type="int" enum="Variant.Type" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_type" type="int" enum="Variant.Type" />
<description>
Sets the type of the custom data layer identified by the given index.
</description>
</method>
<method name="set_navigation_layer_layer_value">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer_number" type="int" />
<param index="2" name="value" type="bool" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer_number" type="int" />
<argument index="2" name="value" type="bool" />
<description>
Based on [param value], enables or disables the specified navigation layer of the LayeredTileSet navigation data layer identified by the given [param layer_index], given a navigation_layers [param layer_number] between 1 and 32.
</description>
</method>
<method name="set_navigation_layer_layers">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layers" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layers" type="int" />
<description>
Sets the navigation layers (as in the navigation server) for navigation regions in the given LayeredTileSet navigation layer.
</description>
</method>
<method name="set_occlusion_layer_light_mask">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="light_mask" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="light_mask" type="int" />
<description>
Sets the occlusion layer (as in the rendering server) for occluders in the given LayeredTileSet occlusion layer.
</description>
</method>
<method name="set_occlusion_layer_sdf_collision">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="sdf_collision" type="bool" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="sdf_collision" type="bool" />
<description>
Enables or disables SDF collision for occluders in the given LayeredTileSet occlusion layer.
</description>
</method>
<method name="set_physics_layer_collision_layer">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="layer" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="layer" type="int" />
<description>
Sets the physics layer (as in the physics server) for bodies in the given LayeredTileSet physics layer.
</description>
</method>
<method name="set_physics_layer_collision_mask">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="mask" type="int" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="mask" type="int" />
<description>
Sets the physics layer (as in the physics server) for bodies in the given LayeredTileSet physics layer.
</description>
</method>
<method name="set_physics_layer_physics_material">
<return type="void" />
<param index="0" name="layer_index" type="int" />
<param index="1" name="physics_material" type="PhysicsMaterial" />
<argument index="0" name="layer_index" type="int" />
<argument index="1" name="physics_material" type="PhysicsMaterial" />
<description>
Sets the physics material for bodies in the given LayeredTileSet physics layer.
</description>
</method>
<method name="set_source_id">
<return type="void" />
<param index="0" name="source_id" type="int" />
<param index="1" name="new_source_id" type="int" />
<argument index="0" name="source_id" type="int" />
<argument index="1" name="new_source_id" type="int" />
<description>
Changes a source's ID.
</description>
</method>
<method name="set_source_level_tile_proxy">
<return type="void" />
<param index="0" name="source_from" type="int" />
<param index="1" name="source_to" type="int" />
<argument index="0" name="source_from" type="int" />
<argument index="1" name="source_to" type="int" />
<description>
Creates a source-level proxy for the given source ID. A proxy will map set of tile identifiers to another set of identifiers. Both the atlas coordinates ID and the alternative tile ID are kept the same when using source-level proxies.
This can be used to replace a source in all LayeredTileMaps using this LayeredTileSet, as LayeredTileMap nodes will find and use the proxy's target source when one is available.
@ -586,26 +586,26 @@
</method>
<method name="set_terrain_color">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="color" type="Color" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<argument index="2" name="color" type="Color" />
<description>
Sets a terrain's color. This color is used for identifying the different terrains in the LayeredTileSet editor.
</description>
</method>
<method name="set_terrain_name">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="terrain_index" type="int" />
<param index="2" name="name" type="String" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="terrain_index" type="int" />
<argument index="2" name="name" type="String" />
<description>
Sets a terrain's name.
</description>
</method>
<method name="set_terrain_set_mode">
<return type="void" />
<param index="0" name="terrain_set" type="int" />
<param index="1" name="mode" type="int" enum="LayeredTileSet.TerrainMode" />
<argument index="0" name="terrain_set" type="int" />
<argument index="1" name="mode" type="int" enum="LayeredTileSet.TerrainMode" />
<description>
Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains.
</description>

114
modules/layered_tile_map/doc_classes/LayeredTileSetAtlasSource.xml
View File

@ -7,8 +7,8 @@
An atlas is a grid of tiles laid out on a texture. Each tile in the grid must be exposed using [method create_tile]. Those tiles are then indexed using their coordinates in the grid.
Each tile can also have a size in the grid coordinates, making it more or less cells in the atlas.
Alternatives version of a tile can be created using [method create_alternative_tile], which are then indexed using an alternative ID. The main tile (the one in the grid), is accessed with an alternative ID equal to 0.
Each tile alternate has a set of properties that is defined by the source's [LayeredTileSet] layers. Those properties are stored in a TileData object that can be accessed and modified using [method get_tile_data].
As TileData properties are stored directly in the LayeredTileSetAtlasSource resource, their properties might also be set using [code]LayeredTileSetAtlasSource.set("&lt;coords_x&gt;:&lt;coords_y&gt;/&lt;alternative_id&gt;/&lt;tile_data_property&gt;")[/code].
Each tile alternate has a set of properties that is defined by the source's [LayeredTileSet] layers. Those properties are stored in a LayeredTileData object that can be accessed and modified using [method get_tile_data].
As LayeredTileData properties are stored directly in the LayeredTileSetAtlasSource resource, their properties might also be set using [code]LayeredTileSetAtlasSource.set("&lt;coords_x&gt;:&lt;coords_y&gt;/&lt;alternative_id&gt;/&lt;tile_data_property&gt;")[/code].
</description>
<tutorials>
</tutorials>
@ -21,8 +21,8 @@
</method>
<method name="create_alternative_tile">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_id_override" type="int" default="-1" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_id_override" type="int" default="-1" />
<description>
Creates an alternative tile for the tile at coordinates [param atlas_coords]. If [param 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 [param alternative_id_override].
@ -30,8 +30,8 @@
</method>
<method name="create_tile">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" default="Vector2i(1, 1)" />
<description>
Creates a new tile at coordinates [param atlas_coords] with the given [param size].
</description>
@ -44,7 +44,7 @@
</method>
<method name="get_next_alternative_tile_id" qualifiers="const">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the alternative ID a following call to [method create_alternative_tile] would return.
</description>
@ -57,8 +57,8 @@
</method>
<method name="get_runtime_tile_texture_region" qualifiers="const">
<return type="Rect2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame" type="int" />
<description>
Returns the region of the tile at coordinates [param atlas_coords] for the given [param frame] inside the texture returned by [method get_runtime_texture].
[b]Note:[/b] If [member use_texture_padding] is [code]false[/code], returns the same as [method get_tile_texture_region].
@ -66,102 +66,102 @@
</method>
<method name="get_tile_animation_columns" qualifiers="const">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns how many columns the tile at [param atlas_coords] has in its animation layout.
</description>
</method>
<method name="get_tile_animation_frame_duration" qualifiers="const">
<return type="float" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_index" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_index" type="int" />
<description>
Returns the animation frame duration of frame [param frame_index] for the tile at coordinates [param atlas_coords].
</description>
</method>
<method name="get_tile_animation_frames_count" qualifiers="const">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns how many animation frames has the tile at coordinates [param atlas_coords].
</description>
</method>
<method name="get_tile_animation_mode" qualifiers="const">
<return type="int" enum="LayeredTileSetAtlasSource.TileAnimationMode" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the tile animation mode of the tile at [param atlas_coords]. See also [method set_tile_animation_mode].
</description>
</method>
<method name="get_tile_animation_separation" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates [param atlas_coords].
</description>
</method>
<method name="get_tile_animation_speed" qualifiers="const">
<return type="float" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the animation speed of the tile at coordinates [param atlas_coords].
</description>
</method>
<method name="get_tile_animation_total_duration" qualifiers="const">
<return type="float" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the sum of the sum of the frame durations of the tile at coordinates [param atlas_coords]. This value needs to be divided by the animation speed to get the actual animation loop duration.
</description>
</method>
<method name="get_tile_at_coords" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
If there is a tile covering the [param atlas_coords] coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns [code]Vector2i(-1, -1)[/code] otherwise.
</description>
</method>
<method name="get_tile_data" qualifiers="const">
<return type="TileData" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<return type="LayeredTileData" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<description>
Returns the [TileData] object for the given atlas coordinates and alternative ID.
Returns the [LayeredTileData] object for the given atlas coordinates and alternative ID.
</description>
</method>
<method name="get_tile_size_in_atlas" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the size of the tile (in the grid coordinates system) at coordinates [param atlas_coords].
</description>
</method>
<method name="get_tile_texture_region" qualifiers="const">
<return type="Rect2i" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame" type="int" default="0" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame" type="int" default="0" />
<description>
Returns a tile's texture region in the atlas texture. For animated tiles, a [param frame] argument might be provided for the different frames of the animation.
</description>
</method>
<method name="get_tiles_to_be_removed_on_change">
<return type="PoolVector2Array" />
<param index="0" name="texture" type="Texture" />
<param index="1" name="margins" type="Vector2i" />
<param index="2" name="separation" type="Vector2i" />
<param index="3" name="texture_region_size" type="Vector2i" />
<argument index="0" name="texture" type="Texture" />
<argument index="1" name="margins" type="Vector2i" />
<argument index="2" name="separation" type="Vector2i" />
<argument index="3" name="texture_region_size" type="Vector2i" />
<description>
Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [param texture], [param margins], [param separation] or [param texture_region_size]. This can be used to undo changes that would have caused tiles data loss.
</description>
</method>
<method name="has_room_for_tile" qualifiers="const">
<return type="bool" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="size" type="Vector2i" />
<param index="2" name="animation_columns" type="int" />
<param index="3" name="animation_separation" type="Vector2i" />
<param index="4" name="frames_count" type="int" />
<param index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="size" type="Vector2i" />
<argument index="2" name="animation_columns" type="int" />
<argument index="3" name="animation_separation" type="Vector2i" />
<argument index="4" name="frames_count" type="int" />
<argument index="5" name="ignored_tile" type="Vector2i" default="Vector2i(-1, -1)" />
<description>
Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [param 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.
</description>
@ -174,9 +174,9 @@
</method>
<method name="move_tile_in_atlas">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<param index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="new_atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" />
<argument index="2" name="new_size" type="Vector2i" default="Vector2i(-1, -1)" />
<description>
Move the tile and its alternatives at the [param atlas_coords] coordinates to the [param new_atlas_coords] coordinates with the [param new_size] size. This functions will fail if a tile is already present in the given area.
If [param new_atlas_coords] is [code]Vector2i(-1, -1)[/code], keeps the tile's coordinates. If [param new_size] is [code]Vector2i(-1, -1)[/code], keeps the tile's size.
@ -185,8 +185,8 @@
</method>
<method name="remove_alternative_tile">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<description>
Remove a tile's alternative with alternative ID [param alternative_tile].
Calling this function with [param alternative_tile] equals to 0 will fail, as the base tile alternative cannot be removed.
@ -194,16 +194,16 @@
</method>
<method name="remove_tile">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Remove a tile and its alternative at coordinates [param atlas_coords].
</description>
</method>
<method name="set_alternative_tile_id">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<param index="2" name="new_id" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<argument index="2" name="new_id" type="int" />
<description>
Change a tile's alternative ID from [param alternative_tile] to [param new_id].
Calling this function with [param new_id] of 0 will fail, as the base tile alternative cannot be moved.
@ -211,49 +211,49 @@
</method>
<method name="set_tile_animation_columns">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_columns" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_columns" type="int" />
<description>
Sets the number of columns in the animation layout of the tile at coordinates [param atlas_coords]. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas.
</description>
</method>
<method name="set_tile_animation_frame_duration">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frame_index" type="int" />
<param index="2" name="duration" type="float" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frame_index" type="int" />
<argument index="2" name="duration" type="float" />
<description>
Sets the animation frame [param duration] of frame [param frame_index] for the tile at coordinates [param atlas_coords].
</description>
</method>
<method name="set_tile_animation_frames_count">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="frames_count" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="frames_count" type="int" />
<description>
Sets how many animation frames the tile at coordinates [param atlas_coords] has.
</description>
</method>
<method name="set_tile_animation_mode">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="mode" type="int" enum="LayeredTileSetAtlasSource.TileAnimationMode" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="mode" type="int" enum="LayeredTileSetAtlasSource.TileAnimationMode" />
<description>
Sets the tile animation mode of the tile at [param atlas_coords] to [param mode]. See also [method get_tile_animation_mode].
</description>
</method>
<method name="set_tile_animation_separation">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="separation" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="separation" type="Vector2i" />
<description>
Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates [param atlas_coords] has.
</description>
</method>
<method name="set_tile_animation_speed">
<return type="void" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="speed" type="float" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="speed" type="float" />
<description>
Sets the animation speed of the tile at coordinates [param atlas_coords] has.
</description>

26
modules/layered_tile_map/doc_classes/LayeredTileSetScenesCollectionSource.xml
View File

@ -12,8 +12,8 @@
<methods>
<method name="create_scene_tile">
<return type="int" />
<param index="0" name="packed_scene" type="PackedScene" />
<param index="1" name="id_override" type="int" default="-1" />
<argument index="0" name="packed_scene" type="PackedScene" />
<argument index="1" name="id_override" type="int" default="-1" />
<description>
Creates a scene-based tile out of the given scene.
Returns a newly generated unique ID.
@ -27,21 +27,21 @@
</method>
<method name="get_scene_tile_display_placeholder" qualifiers="const">
<return type="bool" />
<param index="0" name="id" type="int" />
<argument index="0" name="id" type="int" />
<description>
Returns whether the scene tile with [param id] displays a placeholder in the editor.
</description>
</method>
<method name="get_scene_tile_id">
<return type="int" />
<param index="0" name="index" type="int" />
<argument index="0" name="index" type="int" />
<description>
Returns the scene tile ID of the scene tile at [param index].
</description>
</method>
<method name="get_scene_tile_scene" qualifiers="const">
<return type="PackedScene" />
<param index="0" name="id" type="int" />
<argument index="0" name="id" type="int" />
<description>
Returns the [PackedScene] resource of scene tile with [param id].
</description>
@ -54,38 +54,38 @@
</method>
<method name="has_scene_tile_id">
<return type="bool" />
<param index="0" name="id" type="int" />
<argument index="0" name="id" type="int" />
<description>
Returns whether this LayeredTileSet source has a scene tile with [param id].
</description>
</method>
<method name="remove_scene_tile">
<return type="void" />
<param index="0" name="id" type="int" />
<argument index="0" name="id" type="int" />
<description>
Remove the scene tile with [param id].
</description>
</method>
<method name="set_scene_tile_display_placeholder">
<return type="void" />
<param index="0" name="id" type="int" />
<param index="1" name="display_placeholder" type="bool" />
<argument index="0" name="id" type="int" />
<argument index="1" name="display_placeholder" type="bool" />
<description>
Sets whether or not the scene tile with [param id] should display a placeholder in the editor. This might be useful for scenes that are not visible.
</description>
</method>
<method name="set_scene_tile_id">
<return type="void" />
<param index="0" name="id" type="int" />
<param index="1" name="new_id" type="int" />
<argument index="0" name="id" type="int" />
<argument index="1" name="new_id" type="int" />
<description>
Changes a scene tile's ID from [param id] to [param new_id]. This will fail if there is already a tile with an ID equal to [param new_id].
</description>
</method>
<method name="set_scene_tile_scene">
<return type="void" />
<param index="0" name="id" type="int" />
<param index="1" name="packed_scene" type="PackedScene" />
<argument index="0" name="id" type="int" />
<argument index="1" name="packed_scene" type="PackedScene" />
<description>
Assigns a [PackedScene] resource to the scene tile with [param id]. This will fail if the scene does not extend CanvasItem, as positioning properties are needed to place the scene on the LayeredTileMap.
</description>

14
modules/layered_tile_map/doc_classes/LayeredTileSetSource.xml
View File

@ -15,15 +15,15 @@
<methods>
<method name="get_alternative_tile_id" qualifiers="const">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="index" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="index" type="int" />
<description>
Returns the alternative ID for the tile with coordinates ID [param atlas_coords] at index [param index].
</description>
</method>
<method name="get_alternative_tiles_count" qualifiers="const">
<return type="int" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns the number of alternatives tiles for the coordinates ID [param atlas_coords].
For [LayeredTileSetAtlasSource], this always return at least 1, as the base tile with ID 0 is always part of the alternatives list.
@ -32,7 +32,7 @@
</method>
<method name="get_tile_id" qualifiers="const">
<return type="Vector2i" />
<param index="0" name="index" type="int" />
<argument index="0" name="index" type="int" />
<description>
Returns the tile coordinates ID of the tile with index [param index].
</description>
@ -45,15 +45,15 @@
</method>
<method name="has_alternative_tile" qualifiers="const">
<return type="bool" />
<param index="0" name="atlas_coords" type="Vector2i" />
<param index="1" name="alternative_tile" type="int" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<argument index="1" name="alternative_tile" type="int" />
<description>
Returns if the base tile at coordinates [param atlas_coords] has an alternative with ID [param alternative_tile].
</description>
</method>
<method name="has_tile" qualifiers="const">
<return type="bool" />
<param index="0" name="atlas_coords" type="Vector2i" />
<argument index="0" name="atlas_coords" type="Vector2i" />
<description>
Returns if this atlas has a tile with coordinates ID [param atlas_coords].
</description>