Documentation
¶
Overview ¶
GridMapEditorPlugin provides access to the [GridMap] editor functionality.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsEditorPlugin() EditorPlugin.Instance
- func (self Instance) AsGridMapEditorPlugin() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) ClearSelection()
- func (self Instance) GetCurrentGridMap() GridMap.Instance
- func (self Instance) GetSelectedCells() []any
- func (self Instance) GetSelectedPaletteItem() int
- func (self Instance) GetSelection() AABB.PositionSize
- func (self Instance) HasSelection() bool
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSelectedPaletteItem(item int)
- func (self Instance) SetSelection(begin Vector3i.XYZ, end Vector3i.XYZ)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEditorPlugin ¶
func (self *Extension[T]) AsEditorPlugin() EditorPlugin.Instance
func (*Extension[T]) AsGridMapEditorPlugin ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.GridMapEditorPlugin
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEditorPlugin ¶
func (self Instance) AsEditorPlugin() EditorPlugin.Instance
func (Instance) AsGridMapEditorPlugin ¶
func (Instance) ClearSelection ¶
func (self Instance) ClearSelection()
Deselects any currently selected cells.
func (Instance) GetCurrentGridMap ¶
Returns the [GridMap] node currently edited by the grid map editor.
func (Instance) GetSelectedCells ¶
Returns an array of [Vector3i]s with the selected cells' coordinates.
func (Instance) 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.
func (Instance) GetSelection ¶
func (self Instance) GetSelection() AABB.PositionSize
Returns the cell coordinate bounds of the current selection. Use Instance.HasSelection to check if there is an active selection.
func (Instance) HasSelection ¶
Returns true if there are selected cells.
func (Instance) SetSelectedPaletteItem ¶
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 (Instance) SetSelection ¶
Selects the cells inside the given bounds from 'begin' to 'end'.
Source Files