godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TileMap.xml

285 lines
13 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="TileMap" inherits="Node2D" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Node for 2D tile-based maps.
</brief_description>
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Add link titles for all links in the class reference This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-05 12:43:40 +00:00
<link title="Using Tilemaps">https://docs.godotengine.org/en/latest/tutorials/2d/using_tilemaps.html</link>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link>
<link title="2D Isometric Demo">https://godotengine.org/asset-library/asset/112</link>
<link title="2D Hexagonal Demo">https://godotengine.org/asset-library/asset/111</link>
<link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link>
<link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link>
<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="add_layer">
<return type="void" />
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
<argument index="0" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Adds a layer at the given position [code]to_position[/code] in the array. If [code]to_position[/code] is -1, adds it at the end of the array.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Vector2/Vector3/TileMap wording fixes
2018-05-13 00:58:45 +00:00
Clears all cells.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Improve TileMap physics for moving platforms and conveyor belts like movements
2021-09-15 13:23:58 +00:00
<method name="clear_layer">
<return type="void" />
<argument index="0" name="layer" type="int" />
<description>
Clears all cells on the given layer.
</description>
</method>
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
<method name="fix_invalid_tiles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
<description>
[DOCS] Vector2/Vector3/TileMap wording fixes
2018-05-13 00:58:45 +00:00
Clears cells that do not exist in the tileset.
TileMap: add fix_invalid_tiles
2018-02-24 05:56:48 +00:00
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_alternative_tile" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the tile alternative ID of the cell on layer [code]layer[/code] at [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_atlas_coords" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 10:10:09 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the tile atlas coordinates ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy].
doc: Sync classref with current source Fix various code formatting issues and argument names.
2018-12-27 10:10:09 +00:00
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_cell_source_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="coords" type="Vector2i" />
<argument index="2" name="use_proxies" type="bool" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the tile source ID of the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. If [code]use_proxies[/code] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy].
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
Improve TileMap physics for moving platforms and conveyor belts like movements
2021-09-15 13:23:58 +00:00
<method name="get_coords_for_body_rid">
<return type="Vector2i" />
<argument index="0" name="body" type="RID" />
<description>
Script interface improvements for test body motion -Physics servers test body motion use a class to hold parameters instead of multiple arguments to make it more readable and flexible since there are many options -Improved documentation for test body motion and kinematic collision -Removed read-only properties for body motion results (not handled in scripts, so they should be get_ methods only instead)
2021-09-30 18:28:57 +00:00
Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile.
Improve TileMap physics for moving platforms and conveyor belts like movements
2021-09-15 13:23:58 +00:00
</description>
</method>
Add modulate property to TileMap layers
2021-10-10 15:04:25 +00:00
<method name="get_layer_modulate" qualifiers="const">
<return type="Color" />
<argument index="0" name="layer" type="int" />
<description>
Returns a TileMap layer's modulate.
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="get_layer_name" qualifiers="const">
<return type="String" />
<argument index="0" name="layer" type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a TileMap layer's name.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
<method name="get_layer_y_sort_origin" qualifiers="const">
<return type="int" />
<argument index="0" name="layer" type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a TileMap layer's Y sort origin.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
<method name="get_layer_z_index" qualifiers="const">
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<return type="int" />
<argument index="0" name="layer" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a TileMap layer's Z-index value.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="get_layers_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_neighbor_cell" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="coords" type="Vector2i" />
<argument index="1" name="neighbor" type="int" enum="TileSet.CellNeighbor" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the neighboring cell to the one at coordinates [code]coords[/code], indentified by the [code]neighbor[/code] direction. This method takes into account the different layouts a TileMap can take.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<method name="get_surrounding_tiles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i[]" />
<argument index="0" name="coords" type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns the list of all neighbourings cells to the one at [code]coords[/code]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_used_cells" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i[]" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a [Vector2] 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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_used_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns a rectangle enclosing the used (non-empty) tiles of the map, including all layers.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="is_layer_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="layer" type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if a layer is enabled.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
<method name="is_layer_y_sort_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="layer" type="int" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Returns if a layer Y-sorts its tiles.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="map_to_world" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
<argument index="0" name="map_position" type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update TileMap to use Vector2i instead of two ints
2020-06-30 06:34:15 +00:00
Returns the local position corresponding to the given tilemap (grid-based) coordinates.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<method name="move_layer">
<return type="void" />
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="to_position" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Moves the layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
<method name="remove_layer">
<return type="void" />
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
<argument index="0" name="layer" type="int" />
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Moves the layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array.
Implement properties arrays in the Inspector.
2021-08-31 08:48:45 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_cell">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<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" />
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets the tile indentifiers for the cell on layer [code]layer[/code] at coordinates [code]coords[/code]. Each tile of the [TileSet] is identified using three parts:
- The source indentifier [code]source_id[/code] identifies a [TileSetSource] identifier. See [method TileSet.set_source_id],
- The atlas coordinates identifier [code]atlas_coords[/code] identifies a tile coordinates in the atlas (if the source is a [TileSetAtlasSource]. For [TileSetScenesCollectionSource] it should be 0),
- The alternative tile identifier [code]alternative_tile[/code] identifies a tile alternative the source is a [TileSetAtlasSource], and the scene for a [TileSetScenesCollectionSource].
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="set_layer_enabled">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="bool" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Enables or disables the layer [code]layer[/code]. A disabled layer is not processed at all (no rendering, no physics, etc...).
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
Add modulate property to TileMap layers
2021-10-10 15:04:25 +00:00
<method name="set_layer_modulate">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="enabled" type="Color" />
<description>
Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate.
</description>
</method>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<method name="set_layer_name">
<return type="void" />
<argument index="0" name="layer" type="int" />
<argument index="1" name="name" type="String" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets a layer's name. This is mostly useful in the editor.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</description>
</method>
<method name="set_layer_y_sort_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<argument index="0" name="layer" type="int" />
<argument index="1" name="y_sort_enabled" type="bool" />
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
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 behvaior.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</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>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
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.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</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" />
Defer TileMap::update_dirty_quadrants once again. This fixes #20323. #11077 is now technically re-broken, but you can now call update_dirty_quadrants as workaround.
2018-07-22 13:26:14 +00:00
<description>
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Sets a layers Z-index value. This Z-index is added to each tile's Z-index value.
Defer TileMap::update_dirty_quadrants once again. This fixes #20323. #11077 is now technically re-broken, but you can now call update_dirty_quadrants as workaround.
2018-07-22 13:26:14 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="world_to_map" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="world_position" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Docs: Fix TileMap::world_to_map description
2019-01-19 14:23:49 +00:00
Returns the tilemap (grid-based) coordinates corresponding to the given local position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size" default="16">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Improve TileMap physics for moving platforms and conveyor belts like movements
2021-09-15 13:23:58 +00:00
<member name="collision_animatable" type="bool" setter="set_collision_animatable" getter="is_collision_animatable" default="false">
If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform.
[b]Note:[/b] Enabling [code]collision_animatable[/code] may have a small performance impact, only do it if the TileMap is moving and has colliding tiles.
</member>
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
<member name="collision_visibility_mode" type="int" setter="set_collision_visibility_mode" getter="get_collision_visibility_mode" enum="TileMap.VisibilityMode" default="0">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Show or hide the TileMap's collision shapes. If set to [code]VISIBILITY_MODE_DEFAULT[/code], this depends on the show collision debug settings.
Implements TileMap layers and move TileSetPlugins's functions to the TileMap node instead
2021-07-28 16:10:01 +00:00
</member>
<member name="navigation_visibility_mode" type="int" setter="set_navigation_visibility_mode" getter="get_navigation_visibility_mode" enum="TileMap.VisibilityMode" default="0">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Show or hide the TileMap's collision shapes. If set to [code]VISIBILITY_MODE_DEFAULT[/code], this depends on the show navigation debug settings.
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
The assigned [TileSet].
</member>
</members>
<signals>
Rework the TileSet resource and TileMap nodes: - Move most properties from TileMap to TileSet, - Make TileSet more flexible, supporting more feature (several collision layers, etc...), - Fusion both the TileMap and TileSet editor, - Implement TileSetSources, and thus a new way to index tiles in the TileSet, - Rework the TileSet and TileMap editors completely, - Implement an editor zoom widget (and use it in several places)
2021-05-07 13:41:39 +00:00
<signal name="changed">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Update TileMap to use Vector2i instead of two ints
2020-06-30 06:34:15 +00:00
Emitted when the [TileSet] of this TileMap changes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
<constant name="VISIBILITY_MODE_DEFAULT" value="0" enum="VisibilityMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Use the debug settings to determine visibility.
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
</constant>
<constant name="VISIBILITY_MODE_FORCE_HIDE" value="2" enum="VisibilityMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Always hide.
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
</constant>
<constant name="VISIBILITY_MODE_FORCE_SHOW" value="1" enum="VisibilityMode">
Tiles renames/bugfixing and documentation
2021-09-06 09:56:31 +00:00
Always show.
Restore a way to show collsion/navigation on TileMap. Also remove an unused function.
2021-05-24 10:33:22 +00:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>