Inheritance #

EditorContextMenuPlugin #

is_refcounted, is_instantiable, editor, not_builtin_classes

Plugin for adding custom context menus in the editor.

EditorContextMenuPlugin allows for the addition of custom options in the editor's context menu.

Currently, context menus are supported for three commonly used areas: the file system, scene tree, and editor script list panel.

Members #

Methods #

func _popup_menu(paths):
    add_context_menu_item("File Custom options", handle, ICON)

func _init():
    add_menu_shortcut(SHORTCUT, handle)

func _popup_menu(paths):
    add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON)

func _popup_menu(paths):
    var popup_menu = PopupMenu.new()
    popup_menu.add_item("Blue")
    popup_menu.add_item("White")
    popup_menu.id_pressed.connect(_on_color_submenu_option)

    add_context_submenu_item("Set Node Color", popup_menu)

func _init():
    add_menu_shortcut(SHORTCUT, handle)

Annotations #

Constants #

const CONTEXT_SLOT_SCENE_TREE = 0 enum ContextMenuSlot#

Context menu of Scene dock. _popup_menu will be called with a list of paths to currently selected nodes, while option callback will receive the list of currently selected nodes.

const CONTEXT_SLOT_FILESYSTEM = 1 enum ContextMenuSlot#

Context menu of FileSystem dock. _popup_menu and option callback will be called with list of paths of the currently selected files.

const CONTEXT_SLOT_SCRIPT_EDITOR = 2 enum ContextMenuSlot#

Context menu of Script editor's script tabs. _popup_menu will be called with the path to the currently edited script, while option callback will receive reference to that script.

const CONTEXT_SLOT_FILESYSTEM_CREATE = 3 enum ContextMenuSlot#

The "Create..." submenu of FileSystem dock's context menu. _popup_menu and option callback will be called with list of paths of the currently selected files.

const CONTEXT_SLOT_SCRIPT_EDITOR_CODE = 4 enum ContextMenuSlot#

Context menu of Script editor's code editor. _popup_menu will be called with the path to the CodeEdit node. You can fetch it using this code:

func _popup_menu(paths):
    var code_edit = Engine.get_main_loop().root.get_node(paths[0]);

The option callback will receive reference to that node. You can use CodeEdit methods to perform symbol lookups etc.

const CONTEXT_SLOT_SCENE_TABS = 5 enum ContextMenuSlot#

Context menu of scene tabs. _popup_menu will be called with the path of the clicked scene, or empty PackedStringArray if the menu was opened on empty space. The option callback will receive the path of the clicked scene, or empty String if none was clicked.

const CONTEXT_SLOT_2D_EDITOR = 6 enum ContextMenuSlot#

Context menu of 2D editor's basic right-click menu. _popup_menu will be called with paths to all CanvasItem nodes under the cursor. You can fetch them using this code:

func _popup_menu(paths):
    var canvas_item = Engine.get_main_loop().root.get_node(paths[0]); # Replace 0 with the desired index.

The paths array is empty if there weren't any nodes under cursor. The option callback will receive a typed array of CanvasItem nodes.

Constructors #

Enums #

ContextMenuSlot#

Operators #

Signals #

Theme Items #

Tutorials #