Inheritance #

GridMapEditorPlugin
Table of contents

GridMapEditorPlugin #

is_instantiable, Node, editor, not_builtin_classes

Editor for GridMap nodes.

GridMapEditorPlugin provides access to the GridMap editor functionality.

Members #

Methods #

func clear_selection() -> void#

Deselects any currently selected cells.

const func get_current_grid_map() -> GridMap#

Returns the GridMap node currently edited by the grid map editor.

const func get_selected_cells() -> Array#

Returns an array of Vector3is with the selected cells' coordinates.

const func get_selected_palette_item() -> int#

Returns the index of the selected 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.

const func get_selection() -> AABB#

Returns the cell coordinate bounds of the current selection. Use has_selection to check if there is an active selection.

const func has_selection() -> bool#

Returns true if there are selected cells.

const func set_selected_palette_item(item: int) -> void#

Selects the 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.

func set_selection(end: Vector3i) -> void#

Selects the cells inside the given bounds from begin to end.

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #