:github_url: hide .. meta:: :keywords: tilemap .. 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/modules/gridmap/doc_classes/GridMapEditorPlugin.xml. .. _class_GridMapEditorPlugin: GridMapEditorPlugin =================== **Inherits:** :ref:`EditorPlugin` **<** :ref:`Node` **<** :ref:`Object` Editor for :ref:`GridMap` nodes. .. rst-class:: classref-introduction-group Description ----------- GridMapEditorPlugin provides access to the :ref:`GridMap` editor functionality. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_selection`\ (\ ) | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GridMap` | :ref:`get_current_grid_map`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_selected_cells`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_palette_item`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`get_selection`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_selection`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_selected_palette_item`\ (\ item\: :ref:`int`\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_selection`\ (\ begin\: :ref:`Vector3i`, end\: :ref:`Vector3i`\ ) | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GridMapEditorPlugin_method_clear_selection: .. rst-class:: classref-method |void| **clear_selection**\ (\ ) :ref:`🔗` Deselects any currently selected cells. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_get_current_grid_map: .. rst-class:: classref-method :ref:`GridMap` **get_current_grid_map**\ (\ ) |const| :ref:`🔗` Returns the :ref:`GridMap` node currently edited by the grid map editor. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_get_selected_cells: .. rst-class:: classref-method :ref:`Array` **get_selected_cells**\ (\ ) |const| :ref:`🔗` Returns an array of :ref:`Vector3i`\ s with the selected cells' coordinates. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_get_selected_palette_item: .. rst-class:: classref-method :ref:`int` **get_selected_palette_item**\ (\ ) |const| :ref:`🔗` Returns the index of the selected :ref:`MeshLibrary` item in the grid map editor's palette or ``-1`` if no item is selected. \ **Note:** The indices might not be in the same order as they appear in the editor's interface. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_get_selection: .. rst-class:: classref-method :ref:`AABB` **get_selection**\ (\ ) |const| :ref:`🔗` Returns the cell coordinate bounds of the current selection. Use :ref:`has_selection()` to check if there is an active selection. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_has_selection: .. rst-class:: classref-method :ref:`bool` **has_selection**\ (\ ) |const| :ref:`🔗` Returns ``true`` if there are selected cells. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_set_selected_palette_item: .. rst-class:: classref-method |void| **set_selected_palette_item**\ (\ item\: :ref:`int`\ ) |const| :ref:`🔗` Selects the :ref:`MeshLibrary` item with the given index in the grid map editor's palette. If a negative index is given, no item will be selected. If a value greater than the last index is given, the last item will be selected. \ **Note:** The indices might not be in the same order as they appear in the editor's interface. .. rst-class:: classref-item-separator ---- .. _class_GridMapEditorPlugin_method_set_selection: .. rst-class:: classref-method |void| **set_selection**\ (\ begin\: :ref:`Vector3i`, end\: :ref:`Vector3i`\ ) :ref:`🔗` Selects the cells inside the given bounds from ``begin`` to ``end``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`