Class GridMapEditorPlugin

Editor for GridMap nodes.

Inheritance

EditorPlugin

Node

Object

GridMapEditorPlugin

Remarks

GridMapEditorPlugin provides access to the GridMap editor functionality.

Methods

clear_selection

Deselects any currently selected cells.

void clear_selection

get_current_grid_map

Qualifiers: const

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

GridMap get_current_grid_map

get_selected_cells

Qualifiers: const

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

Array get_selected_cells

get_selected_palette_item

Qualifiers: const

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.

int get_selected_palette_item

get_selection

Qualifiers: const

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

AABB get_selection

has_selection

Qualifiers: const

Returns true if there are selected cells.

bool has_selection

set_selected_palette_item(int)

Qualifiers: const

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.

void set_selected_palette_item(int item)

Parameters

item int

set_selection(Vector3i, Vector3i)

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

void set_selection(Vector3i begin, Vector3i end)

Parameters

begin Vector3i

end Vector3i