EditorCommandPalette

Reckfell editor's command palette.

1.0.0

class EditorCommandPaletteReckfellSharpEditorInherits ConfirmationDialog

Reckfell editor's command palette.

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.

C#
EditorCommandPalette commandPalette = EditorInterface.Singleton.GetCommandPalette();
// ExternalCommand is a function that will be called with the command is executed.
Callable commandCallable = new Callable(this, MethodName.ExternalCommand);
commandPalette.AddCommand("command", "test/command", commandCallable)

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

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

Constructors1

EditorCommandPaletteConstructor

# EditorCommandPalette

C#
public EditorCommandPalette();

Methods2

AddCommandvoid

# AddCommand

C#
public void AddCommand(string commandName, string keyName, Callable bindedCallable, string shortcutText = "None");

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: Callable (Callable of the Command. This will be executed when the Command is selected.)
shortcut_text: string (Shortcut text of the Command if available.)

Parameters
Name	Type	Default
`commandName`	`string`	—
`keyName`	`string`	—
`bindedCallable`	`Callable`	—
`shortcutText`	`string`	`"None"`

RemoveCommandvoid

# RemoveCommand

C#
public void RemoveCommand(string keyName);

Removes the custom command from EditorCommandPalette.

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

Parameters
Name	Type	Default
`keyName`	`string`	—

Reckfell Engine documentationBack to top ↑