Table of Contents

Class GridMapEditorPlugin

Namespace
Godot
Assembly
GodotSharpEditor.dll

GridMapEditorPlugin provides access to the GridMap editor functionality.

public class GridMapEditorPlugin : EditorPlugin, IDisposable
Inheritance
GridMapEditorPlugin
Implements
Inherited Members

Constructors

GridMapEditorPlugin() 

public GridMapEditorPlugin()

Methods

ClearSelection()

Deselects any currently selected cells.

public void ClearSelection()

GetCurrentGridMap()

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

public GridMap GetCurrentGridMap()

Returns

GridMap

GetSelectedCells()

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

public Array GetSelectedCells()

Returns

Array

GetSelectedPaletteItem()

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.

public int GetSelectedPaletteItem()

Returns

int

GetSelection()

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

public Aabb GetSelection()

Returns

Aabb

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

HasSelection()

Returns true if there are selected cells.

public bool HasSelection()

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetSelectedPaletteItem(int)

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.

public void SetSelectedPaletteItem(int item)

Parameters

item int

SetSelection(Vector3I, Vector3I)

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

public void SetSelection(Vector3I begin, Vector3I end)

Parameters

begin Vector3I
end Vector3I
Edit this page