summaryrefslogtreecommitdiff
path: root/doc/classes/TileMap.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/TileMap.xml')
-rw-r--r--doc/classes/TileMap.xml152
1 files changed, 98 insertions, 54 deletions
diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml
index 5a4068ec86..f3c64c3c7d 100644
--- a/doc/classes/TileMap.xml
+++ b/doc/classes/TileMap.xml
@@ -18,111 +18,153 @@
</tutorials>
<methods>
<method name="clear">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clears all cells.
</description>
</method>
<method name="fix_invalid_tiles">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clears cells that do not exist in the tileset.
</description>
</method>
<method name="get_cell_alternative_tile" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
+ <return type="int" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="coords" type="Vector2i" />
+ <argument index="2" name="use_proxies" type="bool" />
<description>
</description>
</method>
<method name="get_cell_atlas_coords" qualifiers="const">
- <return type="Vector2i">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
+ <return type="Vector2i" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="coords" type="Vector2i" />
+ <argument index="2" name="use_proxies" type="bool" />
<description>
</description>
</method>
<method name="get_cell_source_id" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
+ <return type="int" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="coords" type="Vector2i" />
+ <argument index="2" name="use_proxies" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="get_layer_name" qualifiers="const">
+ <return type="String" />
+ <argument index="0" name="layer" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="get_layer_y_sort_origin" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="layer" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="get_layer_z_indexd" qualifiers="const">
+ <return type="int" />
+ <argument index="0" name="layer" type="int" />
<description>
</description>
</method>
<method name="get_neighbor_cell" qualifiers="const">
- <return type="Vector2i">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
- <argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor">
- </argument>
+ <return type="Vector2i" />
+ <argument index="0" name="coords" type="Vector2i" />
+ <argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" />
<description>
</description>
</method>
<method name="get_surrounding_tiles">
- <return type="Vector2i[]">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
+ <return type="Vector2i[]" />
+ <argument index="0" name="coords" type="Vector2i" />
<description>
</description>
</method>
<method name="get_used_cells" qualifiers="const">
- <return type="Vector2i[]">
- </return>
+ <return type="Vector2i[]" />
+ <argument index="0" name="layer" type="int" />
<description>
Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]).
</description>
</method>
<method name="get_used_rect">
- <return type="Rect2">
- </return>
+ <return type="Rect2" />
<description>
Returns a rectangle enclosing the used (non-empty) tiles of the map.
</description>
</method>
+ <method name="is_layer_enabled" qualifiers="const">
+ <return type="bool" />
+ <argument index="0" name="layer" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="is_layer_y_sort_enabled" qualifiers="const">
+ <return type="bool" />
+ <argument index="0" name="layer" type="int" />
+ <description>
+ </description>
+ </method>
<method name="map_to_world" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="map_position" type="Vector2i">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="map_position" type="Vector2i" />
<description>
Returns the local position corresponding to the given tilemap (grid-based) coordinates.
</description>
</method>
<method name="set_cell">
- <return type="void">
- </return>
- <argument index="0" name="coords" type="Vector2i">
- </argument>
- <argument index="1" name="source_id" type="int" default="-1">
- </argument>
- <argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)">
- </argument>
- <argument index="3" name="alternative_tile" type="int" default="-1">
- </argument>
+ <return type="void" />
+ <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="-1" />
<description>
Sets the tile index for the cell given by a Vector2i.
</description>
</method>
- <method name="update_dirty_quadrants">
- <return type="void">
- </return>
+ <method name="set_layer_enabled">
+ <return type="void" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="enabled" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="set_layer_name">
+ <return type="void" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="name" type="String" />
+ <description>
+ </description>
+ </method>
+ <method name="set_layer_y_sort_enabled">
+ <return type="void" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="y_sort_enabled" type="bool" />
+ <description>
+ </description>
+ </method>
+ <method name="set_layer_y_sort_origin">
+ <return type="void" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="y_sort_origin" type="int" />
+ <description>
+ </description>
+ </method>
+ <method name="set_layer_z_index">
+ <return type="void" />
+ <argument index="0" name="layer" type="int" />
+ <argument index="1" name="z_index" type="int" />
<description>
- Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified.
</description>
</method>
<method name="world_to_map" qualifiers="const">
- <return type="Vector2i">
- </return>
- <argument index="0" name="world_position" type="Vector2">
- </argument>
+ <return type="Vector2i" />
+ <argument index="0" name="world_position" type="Vector2" />
<description>
Returns the tilemap (grid-based) coordinates corresponding to the given local position.
</description>
@@ -132,9 +174,11 @@
<member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16">
The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size.
</member>
- <member name="show_collision" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0">
+ <member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0">
+ </member>
+ <member name="layers_count" type="int" setter="set_layers_count" getter="get_layers_count" default="1">
</member>
- <member name="show_navigation" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0">
+ <member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0">
</member>
<member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset">
The assigned [TileSet].
generated by cgit v1.2.3 (git 2.25.1) at 2025-01-09 04:23:55 +0000