EditorContextMenuPlugin

package
v0.0.0-...-af89a4c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 9, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Package EditorContextMenuPlugin provides methods for working with EditorContextMenuPlugin object instances.

Index

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 Any 

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

type ContextMenuSlot 

type ContextMenuSlot int //gd:EditorContextMenuPlugin.ContextMenuSlot

const (
	/*Context menu of Scene dock. [method _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.*/
	ContextSlotSceneTree ContextMenuSlot = 0
	/*Context menu of FileSystem dock. [method _popup_menu] and option callback will be called with list of paths of the currently selected files.*/
	ContextSlotFilesystem ContextMenuSlot = 1
	/*Context menu of Script editor's script tabs. [method _popup_menu] will be called with the path to the currently edited script, while option callback will receive reference to that script.*/
	ContextSlotScriptEditor ContextMenuSlot = 2
	/*The "Create..." submenu of FileSystem dock's context menu. [method _popup_menu] and option callback will be called with list of paths of the currently selected files.*/
	ContextSlotFilesystemCreate ContextMenuSlot = 3
	/*Context menu of Script editor's code editor. [method _popup_menu] will be called with the path to the [CodeEdit] node. You can fetch it using this code:
	  [codeblock]
	  func _popup_menu(paths):
	      var code_edit = Engine.get_main_loop().root.get_node(paths[0]);
	  [/codeblock]
	  The option callback will receive reference to that node. You can use [CodeEdit] methods to perform symbol lookups etc.*/
	ContextSlotScriptEditorCode ContextMenuSlot = 4
	/*Context menu of scene tabs. [method _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.*/
	ContextSlotSceneTabs ContextMenuSlot = 5
	/*Context menu of 2D editor's basic right-click menu. [method _popup_menu] will be called with paths to all [CanvasItem] nodes under the cursor. You can fetch them using this code:
	  [codeblock]
	  func _popup_menu(paths):
	      var canvas_item = Engine.get_main_loop().root.get_node(paths[0]); # Replace 0 with the desired index.
	  [/codeblock]
	  The paths array is empty if there weren't any nodes under cursor. The option callback will receive a typed array of [CanvasItem] nodes.*/
	ContextSlot2dEditor ContextMenuSlot = 6
)

type Expanded 

type Expanded [1]gdclass.EditorContextMenuPlugin

func (Expanded) AddContextMenuItem 

func (self Expanded) AddContextMenuItem(name string, callback func(array []any), icon Texture2D.Instance)

Add custom option to the context menu of the plugin's specified slot. When the option is activated, [param callback] will be called. Callback should take single [Array] argument; array contents depend on context menu slot. [codeblock] func _popup_menu(paths): 

add_context_menu_item("File Custom options", handle, ICON)

[/codeblock] If you want to assign shortcut to the menu item, use [method add_context_menu_item_from_shortcut] instead.

func (Expanded) AddContextMenuItemFromShortcut 

func (self Expanded) AddContextMenuItemFromShortcut(name string, shortcut Shortcut.Instance, icon Texture2D.Instance)

Add custom option to the context menu of the plugin's specified slot. The option will have the [param shortcut] assigned and reuse its callback. The shortcut has to be registered beforehand with [method add_menu_shortcut]. [codeblock] func _init(): 

add_menu_shortcut(SHORTCUT, handle)

func _popup_menu(paths): 

add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON)

[/codeblock]

func (Expanded) AddContextSubmenuItem 

func (self Expanded) AddContextSubmenuItem(name string, menu PopupMenu.Instance, icon Texture2D.Instance)

Add a submenu to the context menu of the plugin's specified slot. The submenu is not automatically handled, you need to connect to its signals yourself. Also the submenu is freed on every popup, so provide a new [PopupMenu] every time. [codeblock] 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)

[/codeblock]

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

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

func (*Extension[T]) AsObject 

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

func (*Extension[T]) AsRefCounted 

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

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 Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.EditorContextMenuPlugin

[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. 

See [Interface] for methods that can be overridden by a [Class] that extends it.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AddContextMenuItem 

func (self Instance) AddContextMenuItem(name string, callback func(array []any))

Add custom option to the context menu of the plugin's specified slot. When the option is activated, [param callback] will be called. Callback should take single [Array] argument; array contents depend on context menu slot. [codeblock] func _popup_menu(paths): 

add_context_menu_item("File Custom options", handle, ICON)

[/codeblock] If you want to assign shortcut to the menu item, use [method add_context_menu_item_from_shortcut] instead.

func (Instance) AddContextMenuItemFromShortcut 

func (self Instance) AddContextMenuItemFromShortcut(name string, shortcut Shortcut.Instance)

Add custom option to the context menu of the plugin's specified slot. The option will have the [param shortcut] assigned and reuse its callback. The shortcut has to be registered beforehand with [method add_menu_shortcut]. [codeblock] func _init(): 

add_menu_shortcut(SHORTCUT, handle)

func _popup_menu(paths): 

add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON)

[/codeblock]

func (Instance) AddContextSubmenuItem 

func (self Instance) AddContextSubmenuItem(name string, menu PopupMenu.Instance)

Add a submenu to the context menu of the plugin's specified slot. The submenu is not automatically handled, you need to connect to its signals yourself. Also the submenu is freed on every popup, so provide a new [PopupMenu] every time. [codeblock] 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)

[/codeblock]

func (Instance) AddMenuShortcut 

func (self Instance) AddMenuShortcut(shortcut Shortcut.Instance, callback func(array []any))

Registers a shortcut associated with the plugin's context menu. This method should be called once (e.g. in plugin's [method Object._init]). [param callback] will be called when user presses the specified [param shortcut] while the menu's context is in effect (e.g. FileSystem dock is focused). Callback should take single [Array] argument; array contents depend on context menu slot. [codeblock] func _init(): 

add_menu_shortcut(SHORTCUT, handle)

[/codeblock]

func (Instance) AsEditorContextMenuPlugin 

func (self Instance) AsEditorContextMenuPlugin() Instance

func (Instance) AsObject 

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

func (Instance) AsRefCounted 

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) ID 

func (self Instance) ID() ID

func (*Instance) SetObject 

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

func (Instance) Virtual 

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

type Interface 

type Interface interface {
	//Called when creating a context menu, custom options can be added by using the [method add_context_menu_item] or [method add_context_menu_item_from_shortcut] functions. [param paths] contains currently selected paths (depending on menu), which can be used to conditionally add options.
	PopupMenu(paths []string)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.