Struct EditorPlugin
Used by the editor to extend its functionality.
struct EditorPlugin
;
Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. See also EditorScript to add functions to the editor.
Methods
| Name | Description |
|---|---|
addAutoloadSingleton
|
Adds a script at path to the Autoload list as name.
|
addControlToBottomPanel
|
Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with removeControlFromBottomPanel and free it with Node.
|
addControlToContainer
|
Adds a custom control to a container (see customcontrolcontainer). There are many locations where custom controls can be added in the editor UI.
Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it).
When your plugin is deactivated, make sure to remove your custom control with removeControlFromContainer and free it with Node.
|
addControlToDock
|
Adds the control to a specific dock slot (see dockslot for options).
If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions.
When your plugin is deactivated, make sure to remove your custom control with removeControlFromDocks and free it with Node.
|
addCustomType
|
Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object.
You can use the virtual method handles to check if your custom object is being edited by checking the script or using the is keyword.
During run-time, this will be a simple object with a script so this function does not need to be called then.
|
addExportPlugin
|
|
addImportPlugin
|
|
addInspectorPlugin
|
|
addSceneImportPlugin
|
|
addSpatialGizmoPlugin
|
|
addToolMenuItem
|
Adds a custom menu item to Project > Tools as name that calls callback on an instance of handler with a parameter ud when user activates it.
|
addToolSubmenuItem
|
Adds a custom submenu under Project > Tools > name. submenu should be an object of class PopupMenu. This submenu should be cleaned up using remove_tool_menu_item(name).
|
applyChanges
|
This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. |
build
|
|
clear
|
Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. |
disablePlugin
|
Called by the engine when the user disables the EditorPlugin in the Plugin tab of the project settings window.
|
edit
|
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. |
enablePlugin
|
Called by the engine when the user enables the EditorPlugin in the Plugin tab of the project settings window.
|
forwardCanvasDrawOverViewport
|
|
forwardCanvasForceDrawOverViewport
|
|
forwardCanvasGuiInput
|
Called when there is a root node in the current edited scene, handles is implemented and an InputEvent happens in the 2D viewport. Intercepts the InputEvent, if return true EditorPlugin consumes the event, otherwise forwards event to other Editor classes. Example:
|
forwardSpatialGuiInput
|
Called when there is a root node in the current edited scene, handles is implemented and an InputEvent happens in the 3D viewport. Intercepts the InputEvent, if return true EditorPlugin consumes the event, otherwise forwards event to other Editor classes. Example:
|
getBreakpoints
|
This is for editors that edit script-based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25.
|
getEditorInterface
|
Returns the EditorInterface object that gives you control over Godot editor's window and its functionalities.
|
getPluginIcon
|
|
getPluginName
|
|
getScriptCreateDialog
|
Gets the Editor's dialogue used for making scripts. Note: Users can configure it before use. |
getState
|
Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). |
getUndoRedo
|
Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. |
getWindowLayout
|
Gets the GUI layout of the plugin. This is used to save the project's editor layout when queueSaveLayout is called or the editor layout was changed(For example changing the position of a dock).
|
handles
|
Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions edit and makeVisible called when the editor requests them. If you have declared the methods forwardCanvasGuiInput and forwardSpatialGuiInput these will be called too.
|
hasMainScreen
|
Returns true if this is a main screen editor plugin (it goes in the workspace selector together with 2D, 3D, Script and AssetLib).
|
hideBottomPanel
|
|
makeBottomPanelItemVisible
|
|
makeVisible
|
This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. Remember that you have to manage the visibility of all your editor controls manually. |
queueSaveLayout
|
Queue save the project's editor layout. |
removeAutoloadSingleton
|
Removes an Autoload name from the list.
|
removeControlFromBottomPanel
|
Removes the control from the bottom panel. You have to manually Node the control.
|
removeControlFromContainer
|
Removes the control from the specified container. You have to manually Node the control.
|
removeControlFromDocks
|
Removes the control from the dock. You have to manually Node the control.
|
removeCustomType
|
Removes a custom type added by addCustomType.
|
removeExportPlugin
|
|
removeImportPlugin
|
|
removeInspectorPlugin
|
|
removeSceneImportPlugin
|
|
removeSpatialGizmoPlugin
|
|
removeToolMenuItem
|
Removes a menu name from Project > Tools.
|
saveExternalData
|
This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. |
setForceDrawOverForwardingEnabled
|
|
setInputEventForwardingAlwaysEnabled
|
Use this method if you always want to receive inputs from 3D view screen inside forwardSpatialGuiInput. It might be especially usable if your plugin will want to use raycast in the scene.
|
setState
|
Restore the state saved by getState.
|
setWindowLayout
|
Restore the plugin GUI layout saved by getWindowLayout.
|
updateOverlays
|
Updates the overlays of the editor (2D/3D) viewport. |
Enums
| Name | Description |
|---|---|
Constants
|
|
CustomControlContainer
|
|
DockSlot
|