reckfellENGINE

GridMapEditorPlugin

Editor for GridMap nodes.

On this page
class GridMapEditorPluginReckfellSharpEditorInherits EditorPlugin

Editor for GridMap nodes.

GridMapEditorPlugin provides access to the GridMap editor functionality.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

GridMapEditorPluginConstructor
# GridMapEditorPlugin
C#
public GridMapEditorPlugin();

Methods8

ClearSelectionvoid
# ClearSelection
C#
public void ClearSelection();

Deselects any currently selected cells.

GetCurrentGridMapGridMap
# GetCurrentGridMap
C#
public GridMap GetCurrentGridMap();

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

Returns GridMap
GetSelectedCellsReckfell.Collections.Array
# GetSelectedCells
C#
public Reckfell.Collections.Array GetSelectedCells();

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

Returns Reckfell.Collections.Array
GetSelectedPaletteItemint
# GetSelectedPaletteItem
C#
public int 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.

Returns int
GetSelectionAabb
# GetSelection
C#
public Aabb GetSelection();

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

Returns Aabb
HasSelectionbool
# HasSelection
C#
public bool HasSelection();

Returns true if there are selected cells.

Returns bool
SetSelectedPaletteItemvoid
# SetSelectedPaletteItem
C#
public void SetSelectedPaletteItem(int item);

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.

Parameters
NameTypeDefault
itemint—
SetSelectionvoid
# SetSelection
C#
public void SetSelection(Vector3I begin, Vector3I end);

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

Parameters
NameTypeDefault
beginVector3I—
endVector3I—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.