Files
godot-docs/classes/class_tilemaplayergroup.rst
2024-02-24 03:20:02 +00:00

70 lines
2.8 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileMapLayerGroup.xml.
.. _class_TileMapLayerGroup:
TileMapLayerGroup
=================
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`TileMap<class_TileMap>`
Groups a set of tile map layers together, allowing them to share a provided :ref:`TileSet<class_TileSet>`.
.. rst-class:: classref-introduction-group
Description
-----------
Groups together tile map layers as part or the same map, replacing the :ref:`TileMap<class_TileMap>` node. Child layers will use this node's :ref:`tile_set<class_TileMapLayerGroup_property_tile_set>`.
The editor also uses **TileMapLayerGroup** as a way to store which layers are selected in a given group. This allows highlighting the currently selected layers.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------+------------------------------------------------------------+
| :ref:`TileSet<class_TileSet>` | :ref:`tile_set<class_TileMapLayerGroup_property_tile_set>` |
+-------------------------------+------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_TileMapLayerGroup_property_tile_set:
.. rst-class:: classref-property
:ref:`TileSet<class_TileSet>` **tile_set**
.. rst-class:: classref-property-setget
- |void| **set_tileset**\ (\ value\: :ref:`TileSet<class_TileSet>`\ )
- :ref:`TileSet<class_TileSet>` **get_tileset**\ (\ )
The assigned :ref:`TileSet<class_TileSet>`. This TileSet will be applied to all child layers.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`