EditorCommandPalette

Documentation

Overview

Object that holds all the available Commands and their shortcuts text. These Commands can be accessed through Editor > Command Palette menu.

Command key names use slash delimiters to distinguish sections, for example: "example/command1" then example will be the section name.

package main

import "graphics.gd/classdb/EditorInterface"

func ExampleEditorCommandPalette() {
	var command_palette = EditorInterface.GetCommandPalette()
	// external_command is a function that will be called with the command is executed.
	command_palette.AddCommand("command", "test/command", func() {
		// do something
	})
}

Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.GetCommandPalette.

Index

• type Advanced
• type Any
• type Expanded
• type Extension
  • func (self *Extension[T]) AsAcceptDialog() AcceptDialog.Instance
  • func (self *Extension[T]) AsConfirmationDialog() ConfirmationDialog.Instance
  • func (self *Extension[T]) AsEditorCommandPalette() Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsViewport() Viewport.Instance
  • func (self *Extension[T]) AsWindow() Window.Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AddCommand(command_name string, key_name string, binded_callable func())
  • func (self Instance) AsAcceptDialog() AcceptDialog.Instance
  • func (self Instance) AsConfirmationDialog() ConfirmationDialog.Instance
  • func (self Instance) AsEditorCommandPalette() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsViewport() Viewport.Instance
  • func (self Instance) AsWindow() Window.Instance
  • func (self Instance) ID() ID
  • func (self Instance) MoreArgs() MoreArgs
  • func (self Instance) RemoveCommand(key_name string)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) Virtual(name string) reflect.Value
• type MoreArgs
  • func (self MoreArgs) AddCommand(command_name string, key_name string, binded_callable func(), ...)

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 Any

type Any interface {
	gd.IsClass
	AsEditorCommandPalette() Instance
}

type Expanded

type Expanded = MoreArgs

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsAcceptDialog

func (self *Extension[T]) AsAcceptDialog() AcceptDialog.Instance

func (*Extension[T]) AsConfirmationDialog

func (self *Extension[T]) AsConfirmationDialog() ConfirmationDialog.Instance

func (*Extension[T]) AsEditorCommandPalette

func (self *Extension[T]) AsEditorCommandPalette() Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsViewport

func (self *Extension[T]) AsViewport() Viewport.Instance

func (*Extension[T]) AsWindow

func (self *Extension[T]) AsWindow() Window.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.EditorCommandPalette

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 New

func New() Instance

func (Instance) AddCommand

func (self Instance) AddCommand(command_name string, key_name string, binded_callable func())

Adds a custom command to EditorCommandPalette.

- 'command_name': string (Name of the Command. This is displayed to the user.)

- 'key_name': string (Name of the key for a particular Command. This is used to uniquely identify the Command.)

- 'binded_callable': func (Callable of the Command. This will be executed when the Command is selected.)

- 'shortcut_text': string (Shortcut text of the Command if available.)

func (Instance) AsAcceptDialog

func (self Instance) AsAcceptDialog() AcceptDialog.Instance

func (Instance) AsConfirmationDialog

func (self Instance) AsConfirmationDialog() ConfirmationDialog.Instance

func (Instance) AsEditorCommandPalette

func (self Instance) AsEditorCommandPalette() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsViewport

func (self Instance) AsViewport() Viewport.Instance

func (Instance) AsWindow

func (self Instance) AsWindow() Window.Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) MoreArgs

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (Instance) RemoveCommand

func (self Instance) RemoveCommand(key_name string)

Removes the custom command from EditorCommandPalette.

- 'key_name': string (Name of the key for a particular Command.)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type MoreArgs

type MoreArgs [1]gdclass.EditorCommandPalette

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) AddCommand

func (self MoreArgs) AddCommand(command_name string, key_name string, binded_callable func(), shortcut_text string)

Adds a custom command to EditorCommandPalette.

- 'command_name': string (Name of the Command. This is displayed to the user.)

- 'key_name': string (Name of the key for a particular Command. This is used to uniquely identify the Command.)

- 'binded_callable': func (Callable of the Command. This will be executed when the Command is selected.)

- 'shortcut_text': string (Shortcut text of the Command if available.)