2021-05-29 13:28:16 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 13:18:53 +00:00
<class name= "EditorCommandPalette" inherits= "ConfirmationDialog" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2021-05-29 13:28:16 +00:00
<brief_description >
2021-08-13 09:04:01 +00:00
Godot editor's command palette.
2021-05-29 13:28:16 +00:00
</brief_description>
<description >
2021-08-13 09:04:01 +00:00
Object that holds all the available Commands and their shortcuts text. These Commands can be accessed through [b]Editor > Command Palette[/b] menu.
2022-11-01 14:29:38 +00:00
Command key names use slash delimiters to distinguish sections, for example: [code]"example/command1"[/code] then [code]example[/code] will be the section name.
2021-08-13 09:04:01 +00:00
[codeblocks]
[gdscript]
var command_palette = get_editor_interface().get_command_palette()
# external_command is a function that will be called with the command is executed.
var command_callable = Callable(self, "external_command").bind(arguments)
command_palette.add_command("command", "test/command",command_callable)
[/gdscript]
[csharp]
EditorCommandPalette commandPalette = GetEditorInterface().GetCommandPalette();
// ExternalCommand is a function that will be called with the command is executed.
2022-08-26 14:21:45 +00:00
Callable commandCallable = new Callable(this, MethodName.ExternalCommand);
2021-08-13 09:04:01 +00:00
commandPalette.AddCommand("command", "test/command", commandCallable)
[/csharp]
[/codeblocks]
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_command_palette].
2021-05-29 13:28:16 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_command" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "command_name" type= "String" />
<param index= "1" name= "key_name" type= "String" />
<param index= "2" name= "binded_callable" type= "Callable" />
<param index= "3" name= "shortcut_text" type= "String" default= ""None"" />
2021-05-29 13:28:16 +00:00
<description >
2021-08-13 09:04:01 +00:00
Adds a custom command to EditorCommandPalette.
2022-08-12 16:07:53 +00:00
- [param command_name]: [String] (Name of the [b]Command[/b]. This is displayed to the user.)
- [param key_name]: [String] (Name of the key for a particular [b]Command[/b]. This is used to uniquely identify the [b]Command[/b].)
- [param binded_callable]: [Callable] (Callable of the [b]Command[/b]. This will be executed when the [b]Command[/b] is selected.)
- [param shortcut_text]: [String] (Shortcut text of the [b]Command[/b] if available.)
2021-05-29 13:28:16 +00:00
</description>
</method>
<method name= "remove_command" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "key_name" type= "String" />
2021-05-29 13:28:16 +00:00
<description >
2021-08-13 09:04:01 +00:00
Removes the custom command from EditorCommandPalette.
2022-08-12 16:07:53 +00:00
- [param key_name]: [String] (Name of the key for a particular [b]Command[/b].)
2021-05-29 13:28:16 +00:00
</description>
</method>
</methods>
<members >
2021-12-02 19:38:49 +00:00
<member name= "dialog_hide_on_ok" type= "bool" setter= "set_hide_on_ok" getter= "get_hide_on_ok" overrides= "AcceptDialog" default= "false" />
2021-05-29 13:28:16 +00:00
</members>
</class>