EditorPlugin¶
Used by the editor to extend its functionality.
Description¶
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.
Tutorials¶
Methods¶
Signals¶
- main_screen_changed ( String screen_name )
Emitted when user changes the workspace (2D, 3D, Script, AssetLib). Also works with custom screens defined by plugins.
- resource_saved ( Resource resource )
- scene_changed ( Node scene_root )
Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be null.
- scene_closed ( String filepath )
Emitted when user closes a scene. The argument is file path to a closed scene.
Enumerations¶
- CONTAINER_TOOLBAR = 0
- CONTAINER_SPATIAL_EDITOR_MENU = 1
- CONTAINER_SPATIAL_EDITOR_SIDE_LEFT = 2
- CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT = 3
- CONTAINER_SPATIAL_EDITOR_BOTTOM = 4
- CONTAINER_CANVAS_EDITOR_MENU = 5
- CONTAINER_CANVAS_EDITOR_SIDE_LEFT = 6
- CONTAINER_CANVAS_EDITOR_SIDE_RIGHT = 7
- CONTAINER_CANVAS_EDITOR_BOTTOM = 8
- CONTAINER_PROPERTY_EDITOR_BOTTOM = 9
- CONTAINER_PROJECT_SETTING_TAB_LEFT = 10
- CONTAINER_PROJECT_SETTING_TAB_RIGHT = 11
- DOCK_SLOT_LEFT_UL = 0
- DOCK_SLOT_LEFT_BL = 1
- DOCK_SLOT_LEFT_UR = 2
- DOCK_SLOT_LEFT_BR = 3
- DOCK_SLOT_RIGHT_UL = 4
- DOCK_SLOT_RIGHT_BL = 5
- DOCK_SLOT_RIGHT_UR = 6
- DOCK_SLOT_RIGHT_BR = 7
- DOCK_SLOT_MAX = 8 — Represents the size of the DockSlot enum.
Method Descriptions¶
Adds a script at path to the Autoload list as name.
- ToolButton add_control_to_bottom_panel ( Control control, String title )
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 remove_control_from_bottom_panel and free it with Node.queue_free.
- void add_control_to_container ( CustomControlContainer container, Control control )
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 remove_control_from_container and free it with Node.queue_free.
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 remove_control_from_docks and free it with Node.queue_free.
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.
- void add_export_plugin ( EditorExportPlugin plugin )
- void add_import_plugin ( EditorImportPlugin importer )
- void add_inspector_plugin ( EditorInspectorPlugin plugin )
- void add_scene_import_plugin ( EditorSceneImporter scene_importer )
- void add_spatial_gizmo_plugin ( EditorSpatialGizmoPlugin plugin )
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.
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).
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.
- bool build ( ) virtual
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.
Called by the engine when the user disables the EditorPlugin in the Plugin tab of the project settings window.
- void edit ( Object object ) virtual
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
Called by the engine when the user enables the EditorPlugin in the Plugin tab of the project settings window.
- void forward_canvas_draw_over_viewport ( Control overlay ) virtual
- void forward_canvas_force_draw_over_viewport ( Control overlay ) virtual
- bool forward_canvas_gui_input ( InputEvent event ) virtual
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:
# Prevents the InputEvent to reach other Editor classes
func forward_canvas_gui_input(event):
var forward = true
return forward
Must return false in order to forward the InputEvent to other Editor classes. Example:
# Consumes InputEventMouseMotion and forwards other InputEvent types
func forward_canvas_gui_input(event):
var forward = false
if event is InputEventMouseMotion:
forward = true
return forward
- bool forward_spatial_gui_input ( Camera camera, InputEvent event ) virtual
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:
# Prevents the InputEvent to reach other Editor classes
func forward_spatial_gui_input(camera, event):
var forward = true
return forward
Must return false in order to forward the InputEvent to other Editor classes. Example:
# Consumes InputEventMouseMotion and forwards other InputEvent types
func forward_spatial_gui_input(camera, event):
var forward = false
if event is InputEventMouseMotion:
forward = true
return forward
- PoolStringArray get_breakpoints ( ) virtual
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.
- EditorInterface get_editor_interface ( )
Returns the EditorInterface object that gives you control over Godot editor’s window and its functionalities.
- Texture get_plugin_icon ( ) virtual
Override this method in your plugin to return a Texture in order to give it an icon.
For main screen plugins, this appears at the top of the screen, to the right of the “2D”, “3D”, “Script”, and “AssetLib” buttons.
Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size.
func get_plugin_icon():
# You can use a custom icon:
return preload("res://addons/my_plugin/my_plugin_icon.svg")
# Or use a built-in icon:
return get_editor_interface().get_base_control().get_icon("Node", "EditorIcons")
- String get_plugin_name ( ) virtual
Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.
For main screen plugins, this appears at the top of the screen, to the right of the “2D”, “3D”, “Script”, and “AssetLib” buttons.
- ScriptCreateDialog get_script_create_dialog ( )
Gets the Editor’s dialogue used for making scripts.
Note: Users can configure it before use.
- Dictionary get_state ( ) virtual
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).
- UndoRedo get_undo_redo ( )
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.
- void get_window_layout ( ConfigFile layout ) virtual
Gets the GUI layout of the plugin. This is used to save the project’s editor layout when queue_save_layout is called or the editor layout was changed(For example changing the position of a dock).
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 make_visible called when the editor requests them. If you have declared the methods forward_canvas_gui_input and forward_spatial_gui_input these will be called too.
- bool has_main_screen ( ) virtual
Returns true if this is a main screen editor plugin (it goes in the workspace selector together with 2D, 3D, Script and AssetLib).
- void make_bottom_panel_item_visible ( Control item )
- void make_visible ( bool visible ) virtual
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.
Queue save the project’s editor layout.
- void remove_autoload_singleton ( String name )
Removes an Autoload name from the list.
- void remove_control_from_bottom_panel ( Control control )
Removes the control from the bottom panel. You have to manually Node.queue_free the control.
- void remove_control_from_container ( CustomControlContainer container, Control control )
Removes the control from the specified container. You have to manually Node.queue_free the control.
- void remove_control_from_docks ( Control control )
Removes the control from the dock. You have to manually Node.queue_free the control.
- void remove_custom_type ( String type )
Removes a custom type added by add_custom_type.
- void remove_export_plugin ( EditorExportPlugin plugin )
- void remove_import_plugin ( EditorImportPlugin importer )
- void remove_inspector_plugin ( EditorInspectorPlugin plugin )
- void remove_scene_import_plugin ( EditorSceneImporter scene_importer )
- void remove_spatial_gizmo_plugin ( EditorSpatialGizmoPlugin plugin )
Removes a menu name from Project > Tools.
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.
Use this method if you always want to receive inputs from 3D view screen inside forward_spatial_gui_input. It might be especially usable if your plugin will want to use raycast in the scene.
- void set_state ( Dictionary state ) virtual
Restore the state saved by get_state.
- void set_window_layout ( ConfigFile layout ) virtual
Restore the plugin GUI layout saved by get_window_layout.
- int update_overlays ( ) const
Updates the overlays of the editor (2D/3D) viewport.