godot-docs/classes/class_editorplugin.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the EditorPlugin.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_EditorPlugin:

EditorPlugin
============

**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

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 :ref:`EditorScript<class_EditorScript>` to add functions to the editor.

Tutorials
---------

- :doc:`Editor plugins documentation index <../tutorials/plugins/editor/index>`

Methods
-------

+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_apply_changes<class_EditorPlugin_method__apply_changes>` **(** **)** |virtual|                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                             | :ref:`_build<class_EditorPlugin_method__build>` **(** **)** |virtual|                                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_clear<class_EditorPlugin_method__clear>` **(** **)** |virtual|                                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_disable_plugin<class_EditorPlugin_method__disable_plugin>` **(** **)** |virtual|                                                                                                                                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_edit<class_EditorPlugin_method__edit>` **(** :ref:`Variant<class_Variant>` object **)** |virtual|                                                                                                                           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_enable_plugin<class_EditorPlugin_method__enable_plugin>` **(** **)** |virtual|                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_forward_3d_draw_over_viewport<class_EditorPlugin_method__forward_3d_draw_over_viewport>` **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|                                                               |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_forward_3d_force_draw_over_viewport<class_EditorPlugin_method__forward_3d_force_draw_over_viewport>` **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|                                                   |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                               | :ref:`_forward_3d_gui_input<class_EditorPlugin_method__forward_3d_gui_input>` **(** :ref:`Camera3D<class_Camera3D>` viewport_camera, :ref:`InputEvent<class_InputEvent>` event **)** |virtual|                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_forward_canvas_draw_over_viewport<class_EditorPlugin_method__forward_canvas_draw_over_viewport>` **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|                                                       |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_forward_canvas_force_draw_over_viewport<class_EditorPlugin_method__forward_canvas_force_draw_over_viewport>` **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|                                           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                             | :ref:`_forward_canvas_gui_input<class_EditorPlugin_method__forward_canvas_gui_input>` **(** :ref:`InputEvent<class_InputEvent>` event **)** |virtual|                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>`   | :ref:`_get_breakpoints<class_EditorPlugin_method__get_breakpoints>` **(** **)** |virtual| |const|                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>`                   | :ref:`_get_plugin_icon<class_EditorPlugin_method__get_plugin_icon>` **(** **)** |virtual| |const|                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                         | :ref:`_get_plugin_name<class_EditorPlugin_method__get_plugin_name>` **(** **)** |virtual| |const|                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>`                 | :ref:`_get_state<class_EditorPlugin_method__get_state>` **(** **)** |virtual| |const|                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_get_window_layout<class_EditorPlugin_method__get_window_layout>` **(** :ref:`ConfigFile<class_ConfigFile>` configuration **)** |virtual|                                                                                    |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                             | :ref:`_handles<class_EditorPlugin_method__handles>` **(** :ref:`Variant<class_Variant>` object **)** |virtual| |const|                                                                                                             |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                             | :ref:`_has_main_screen<class_EditorPlugin_method__has_main_screen>` **(** **)** |virtual| |const|                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_make_visible<class_EditorPlugin_method__make_visible>` **(** :ref:`bool<class_bool>` visible **)** |virtual|                                                                                                                |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_save_external_data<class_EditorPlugin_method__save_external_data>` **(** **)** |virtual|                                                                                                                                    |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_set_state<class_EditorPlugin_method__set_state>` **(** :ref:`Dictionary<class_Dictionary>` state **)** |virtual|                                                                                                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`_set_window_layout<class_EditorPlugin_method__set_window_layout>` **(** :ref:`ConfigFile<class_ConfigFile>` configuration **)** |virtual|                                                                                    |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_autoload_singleton<class_EditorPlugin_method_add_autoload_singleton>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` path **)**                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Button<class_Button>`                         | :ref:`add_control_to_bottom_panel<class_EditorPlugin_method_add_control_to_bottom_panel>` **(** :ref:`Control<class_Control>` control, :ref:`String<class_String>` title **)**                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_control_to_container<class_EditorPlugin_method_add_control_to_container>` **(** :ref:`CustomControlContainer<enum_EditorPlugin_CustomControlContainer>` container, :ref:`Control<class_Control>` control **)**           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_control_to_dock<class_EditorPlugin_method_add_control_to_dock>` **(** :ref:`DockSlot<enum_EditorPlugin_DockSlot>` slot, :ref:`Control<class_Control>` control **)**                                                      |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_custom_type<class_EditorPlugin_method_add_custom_type>` **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture2D<class_Texture2D>` icon **)**       |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_debugger_plugin<class_EditorPlugin_method_add_debugger_plugin>` **(** :ref:`Script<class_Script>` script **)**                                                                                                           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_export_plugin<class_EditorPlugin_method_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)**                                                                                       |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_import_plugin<class_EditorPlugin_method_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_EditorImportPlugin>` importer **)**                                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_inspector_plugin<class_EditorPlugin_method_add_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` plugin **)**                                                                           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_scene_format_importer_plugin<class_EditorPlugin_method_add_scene_format_importer_plugin>` **(** :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>` scene_format_importer **)**                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_scene_post_import_plugin<class_EditorPlugin_method_add_scene_post_import_plugin>` **(** :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>` scene_import_plugin **)**                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_spatial_gizmo_plugin<class_EditorPlugin_method_add_spatial_gizmo_plugin>` **(** :ref:`EditorNode3DGizmoPlugin<class_EditorNode3DGizmoPlugin>` plugin **)**                                                               |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_tool_menu_item<class_EditorPlugin_method_add_tool_menu_item>` **(** :ref:`String<class_String>` name, :ref:`Callable<class_Callable>` callable **)**                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_tool_submenu_item<class_EditorPlugin_method_add_tool_submenu_item>` **(** :ref:`String<class_String>` name, :ref:`Object<class_Object>` submenu **)**                                                                    |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_translation_parser_plugin<class_EditorPlugin_method_add_translation_parser_plugin>` **(** :ref:`EditorTranslationParserPlugin<class_EditorTranslationParserPlugin>` parser **)**                                         |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`add_undo_redo_inspector_hook_callback<class_EditorPlugin_method_add_undo_redo_inspector_hook_callback>` **(** :ref:`Callable<class_Callable>` callable **)**                                                                 |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInterface<class_EditorInterface>`       | :ref:`get_editor_interface<class_EditorPlugin_method_get_editor_interface>` **(** **)**                                                                                                                                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ScriptCreateDialog<class_ScriptCreateDialog>` | :ref:`get_script_create_dialog<class_EditorPlugin_method_get_script_create_dialog>` **(** **)**                                                                                                                                    |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UndoRedo<class_UndoRedo>`                     | :ref:`get_undo_redo<class_EditorPlugin_method_get_undo_redo>` **(** **)**                                                                                                                                                          |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`hide_bottom_panel<class_EditorPlugin_method_hide_bottom_panel>` **(** **)**                                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_method_make_bottom_panel_item_visible>` **(** :ref:`Control<class_Control>` item **)**                                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`queue_save_layout<class_EditorPlugin_method_queue_save_layout>` **(** **)**                                                                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_autoload_singleton<class_EditorPlugin_method_remove_autoload_singleton>` **(** :ref:`String<class_String>` name **)**                                                                                                 |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_method_remove_control_from_bottom_panel>` **(** :ref:`Control<class_Control>` control **)**                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_control_from_container<class_EditorPlugin_method_remove_control_from_container>` **(** :ref:`CustomControlContainer<enum_EditorPlugin_CustomControlContainer>` container, :ref:`Control<class_Control>` control **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_control_from_docks<class_EditorPlugin_method_remove_control_from_docks>` **(** :ref:`Control<class_Control>` control **)**                                                                                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_custom_type<class_EditorPlugin_method_remove_custom_type>` **(** :ref:`String<class_String>` type **)**                                                                                                               |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_debugger_plugin<class_EditorPlugin_method_remove_debugger_plugin>` **(** :ref:`Script<class_Script>` script **)**                                                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_export_plugin<class_EditorPlugin_method_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)**                                                                                 |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_import_plugin<class_EditorPlugin_method_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_EditorImportPlugin>` importer **)**                                                                               |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_inspector_plugin<class_EditorPlugin_method_remove_inspector_plugin>` **(** :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` plugin **)**                                                                     |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_scene_format_importer_plugin<class_EditorPlugin_method_remove_scene_format_importer_plugin>` **(** :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>` scene_format_importer **)**                      |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_scene_post_import_plugin<class_EditorPlugin_method_remove_scene_post_import_plugin>` **(** :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>` scene_import_plugin **)**                            |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_spatial_gizmo_plugin<class_EditorPlugin_method_remove_spatial_gizmo_plugin>` **(** :ref:`EditorNode3DGizmoPlugin<class_EditorNode3DGizmoPlugin>` plugin **)**                                                         |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_tool_menu_item<class_EditorPlugin_method_remove_tool_menu_item>` **(** :ref:`String<class_String>` name **)**                                                                                                         |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_translation_parser_plugin<class_EditorPlugin_method_remove_translation_parser_plugin>` **(** :ref:`EditorTranslationParserPlugin<class_EditorTranslationParserPlugin>` parser **)**                                   |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`remove_undo_redo_inspector_hook_callback<class_EditorPlugin_method_remove_undo_redo_inspector_hook_callback>` **(** :ref:`Callable<class_Callable>` callable **)**                                                           |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`set_force_draw_over_forwarding_enabled<class_EditorPlugin_method_set_force_draw_over_forwarding_enabled>` **(** **)**                                                                                                        |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_method_set_input_event_forwarding_always_enabled>` **(** **)**                                                                                                  |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                               | :ref:`update_overlays<class_EditorPlugin_method_update_overlays>` **(** **)** |const|                                                                                                                                              |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_EditorPlugin_signal_main_screen_changed:

- **main_screen_changed** **(** :ref:`String<class_String>` screen_name **)**

Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib**). Also works with custom screens defined by plugins.

----

.. _class_EditorPlugin_signal_project_settings_changed:

- **project_settings_changed** **(** **)**

----

.. _class_EditorPlugin_signal_resource_saved:

- **resource_saved** **(** :ref:`Resource<class_Resource>` resource **)**

----

.. _class_EditorPlugin_signal_scene_changed:

- **scene_changed** **(** :ref:`Node<class_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``.

----

.. _class_EditorPlugin_signal_scene_closed:

- **scene_closed** **(** :ref:`String<class_String>` filepath **)**

Emitted when user closes a scene. The argument is file path to a closed scene.

Enumerations
------------

.. _enum_EditorPlugin_CustomControlContainer:

.. _class_EditorPlugin_constant_CONTAINER_TOOLBAR:

.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_MENU:

.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_SIDE_LEFT:

.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT:

.. _class_EditorPlugin_constant_CONTAINER_SPATIAL_EDITOR_BOTTOM:

.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_MENU:

.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_SIDE_LEFT:

.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_SIDE_RIGHT:

.. _class_EditorPlugin_constant_CONTAINER_CANVAS_EDITOR_BOTTOM:

.. _class_EditorPlugin_constant_CONTAINER_PROPERTY_EDITOR_BOTTOM:

.. _class_EditorPlugin_constant_CONTAINER_PROJECT_SETTING_TAB_LEFT:

.. _class_EditorPlugin_constant_CONTAINER_PROJECT_SETTING_TAB_RIGHT:

enum **CustomControlContainer**:

- **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**

----

.. _enum_EditorPlugin_DockSlot:

.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UL:

.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_BL:

.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UR:

.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_BR:

.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_UL:

.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_BL:

.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_UR:

.. _class_EditorPlugin_constant_DOCK_SLOT_RIGHT_BR:

.. _class_EditorPlugin_constant_DOCK_SLOT_MAX:

enum **DockSlot**:

- **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 :ref:`DockSlot<enum_EditorPlugin_DockSlot>` enum.

Method Descriptions
-------------------

.. _class_EditorPlugin_method__apply_changes:

- void **_apply_changes** **(** **)** |virtual|

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.

----

.. _class_EditorPlugin_method__build:

- :ref:`bool<class_bool>` **_build** **(** **)** |virtual|

This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.

This method must return a boolean. If this method returns ``false``, the project will not run. The run is aborted immediately, so this also prevents all other plugins' :ref:`_build<class_EditorPlugin_method__build>` methods from running.

----

.. _class_EditorPlugin_method__clear:

- void **_clear** **(** **)** |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.

----

.. _class_EditorPlugin_method__disable_plugin:

- void **_disable_plugin** **(** **)** |virtual|

Called by the engine when the user disables the ``EditorPlugin`` in the Plugin tab of the project settings window.

----

.. _class_EditorPlugin_method__edit:

- void **_edit** **(** :ref:`Variant<class_Variant>` 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.

----

.. _class_EditorPlugin_method__enable_plugin:

- void **_enable_plugin** **(** **)** |virtual|

Called by the engine when the user enables the ``EditorPlugin`` in the Plugin tab of the project settings window.

----

.. _class_EditorPlugin_method__forward_3d_draw_over_viewport:

- void **_forward_3d_draw_over_viewport** **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|

Called by the engine when the 3D editor's viewport is updated. Use the ``overlay`` :ref:`Control<class_Control>` for drawing. You can update the viewport manually by calling :ref:`update_overlays<class_EditorPlugin_method_update_overlays>`.


.. tabs::

 .. code-tab:: gdscript

    func _forward_3d_draw_over_viewport(overlay):
        # Draw a circle at cursor position.
        overlay.draw_circle(overlay.get_local_mouse_position(), 64)
    
    func _forward_3d_gui_input(camera, event):
        if event is InputEventMouseMotion:
            # Redraw viewport when cursor is moved.
            update_overlays()
            return true
        return false

 .. code-tab:: csharp

    public override void _Forward3dDrawOverViewport(Godot.Control overlay)
    {
        // Draw a circle at cursor position.
        overlay.DrawCircle(overlay.GetLocalMousePosition(), 64, Colors.White);
    }
    
    public override bool _Forward3dGuiInput(Godot.Camera3D camera, InputEvent @event)
    {
        if (@event is InputEventMouseMotion)
        {
            // Redraw viewport when cursor is moved.
            UpdateOverlays();
            return true;
        }
        return false;



----

.. _class_EditorPlugin_method__forward_3d_force_draw_over_viewport:

- void **_forward_3d_force_draw_over_viewport** **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|

This method is the same as :ref:`_forward_3d_draw_over_viewport<class_EditorPlugin_method__forward_3d_draw_over_viewport>`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else.

You need to enable calling of this method by using :ref:`set_force_draw_over_forwarding_enabled<class_EditorPlugin_method_set_force_draw_over_forwarding_enabled>`.

----

.. _class_EditorPlugin_method__forward_3d_gui_input:

- :ref:`int<class_int>` **_forward_3d_gui_input** **(** :ref:`Camera3D<class_Camera3D>` viewport_camera, :ref:`InputEvent<class_InputEvent>` event **)** |virtual|

Called when there is a root node in the current edited scene, :ref:`_handles<class_EditorPlugin_method__handles>` is implemented and an :ref:`InputEvent<class_InputEvent>` happens in the 3D viewport. Intercepts the :ref:`InputEvent<class_InputEvent>`, if ``return true`` ``EditorPlugin`` consumes the ``event``, otherwise forwards ``event`` to other Editor classes. Example:


.. tabs::

 .. code-tab:: gdscript

    # Prevents the InputEvent to reach other Editor classes.
    func _forward_3d_gui_input(camera, event):
        return EditorPlugin.AFTER_GUI_INPUT_STOP

 .. code-tab:: csharp

    // Prevents the InputEvent to reach other Editor classes.
    public override bool _Forward3dGuiInput(Camera3D camera, InputEvent @event)
    {
        return EditorPlugin.AFTER_GUI_INPUT_STOP;
    }



Must ``return false`` in order to forward the :ref:`InputEvent<class_InputEvent>` to other Editor classes. Example:


.. tabs::

 .. code-tab:: gdscript

    # Consumes InputEventMouseMotion and forwards other InputEvent types.
    func _forward_3d_gui_input(camera, event):
        return event is InputEventMouseMotion

 .. code-tab:: csharp

    // Consumes InputEventMouseMotion and forwards other InputEvent types.
    public override bool _Forward3dGuiInput(Camera3D camera, InputEvent @event)
    {
        return @event is InputEventMouseMotion;
    }



----

.. _class_EditorPlugin_method__forward_canvas_draw_over_viewport:

- void **_forward_canvas_draw_over_viewport** **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|

Called by the engine when the 2D editor's viewport is updated. Use the ``overlay`` :ref:`Control<class_Control>` for drawing. You can update the viewport manually by calling :ref:`update_overlays<class_EditorPlugin_method_update_overlays>`.


.. tabs::

 .. code-tab:: gdscript

    func _forward_canvas_draw_over_viewport(overlay):
        # Draw a circle at cursor position.
        overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.white)
    
    func _forward_canvas_gui_input(event):
        if event is InputEventMouseMotion:
            # Redraw viewport when cursor is moved.
            update_overlays()
            return true
        return false

 .. code-tab:: csharp

    public override void ForwardCanvasDrawOverViewport(Godot.Control overlay)
    {
        // Draw a circle at cursor position.
        overlay.DrawCircle(overlay.GetLocalMousePosition(), 64, Colors.White);
    }
    
    public override bool ForwardCanvasGuiInput(InputEvent @event)
    {
        if (@event is InputEventMouseMotion)
        {
            // Redraw viewport when cursor is moved.
            UpdateOverlays();
            return true;
        }
        return false;



----

.. _class_EditorPlugin_method__forward_canvas_force_draw_over_viewport:

- void **_forward_canvas_force_draw_over_viewport** **(** :ref:`Control<class_Control>` viewport_control **)** |virtual|

This method is the same as :ref:`_forward_canvas_draw_over_viewport<class_EditorPlugin_method__forward_canvas_draw_over_viewport>`, except it draws on top of everything. Useful when you need an extra layer that shows over anything else.

You need to enable calling of this method by using :ref:`set_force_draw_over_forwarding_enabled<class_EditorPlugin_method_set_force_draw_over_forwarding_enabled>`.

----

.. _class_EditorPlugin_method__forward_canvas_gui_input:

- :ref:`bool<class_bool>` **_forward_canvas_gui_input** **(** :ref:`InputEvent<class_InputEvent>` event **)** |virtual|

Called when there is a root node in the current edited scene, :ref:`_handles<class_EditorPlugin_method__handles>` is implemented and an :ref:`InputEvent<class_InputEvent>` happens in the 2D viewport. Intercepts the :ref:`InputEvent<class_InputEvent>`, if ``return true`` ``EditorPlugin`` consumes the ``event``, otherwise forwards ``event`` to other Editor classes. Example:


.. tabs::

 .. code-tab:: gdscript

    # Prevents the InputEvent to reach other Editor classes.
    func _forward_canvas_gui_input(event):
        return true

 .. code-tab:: csharp

    // Prevents the InputEvent to reach other Editor classes.
    public override bool ForwardCanvasGuiInput(InputEvent @event)
    {
        return true;
    }



Must ``return false`` in order to forward the :ref:`InputEvent<class_InputEvent>` to other Editor classes. Example:


.. tabs::

 .. code-tab:: gdscript

    # Consumes InputEventMouseMotion and forwards other InputEvent types.
    func _forward_canvas_gui_input(event):
        if (event is InputEventMouseMotion):
            return true
        return false

 .. code-tab:: csharp

    // Consumes InputEventMouseMotion and forwards other InputEvent types.
    public override bool ForwardCanvasGuiInput(InputEvent @event)
    {
        if (@event is InputEventMouseMotion) {
            return true;
        }
        return false
    }



----

.. _class_EditorPlugin_method__get_breakpoints:

- :ref:`PackedStringArray<class_PackedStringArray>` **_get_breakpoints** **(** **)** |virtual| |const|

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

----

.. _class_EditorPlugin_method__get_plugin_icon:

- :ref:`Texture2D<class_Texture2D>` **_get_plugin_icon** **(** **)** |virtual| |const|

Override this method in your plugin to return a :ref:`Texture2D<class_Texture2D>` 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.


.. tabs::

 .. code-tab:: gdscript

    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")

 .. code-tab:: csharp

    public override Texture2D GetPluginIcon()
    {
        // You can use a custom icon:
        return ResourceLoader.Load<Texture2D>("res://addons/my_plugin/my_plugin_icon.svg");
        // Or use a built-in icon:
        return GetEditorInterface().GetBaseControl().GetIcon("Node", "EditorIcons");
    }



----

.. _class_EditorPlugin_method__get_plugin_name:

- :ref:`String<class_String>` **_get_plugin_name** **(** **)** |virtual| |const|

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.

----

.. _class_EditorPlugin_method__get_state:

- :ref:`Dictionary<class_Dictionary>` **_get_state** **(** **)** |virtual| |const|

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

----

.. _class_EditorPlugin_method__get_window_layout:

- void **_get_window_layout** **(** :ref:`ConfigFile<class_ConfigFile>` configuration **)** |virtual|

Gets the GUI layout of the plugin. This is used to save the project's editor layout when :ref:`queue_save_layout<class_EditorPlugin_method_queue_save_layout>` is called or the editor layout was changed(For example changing the position of a dock).

----

.. _class_EditorPlugin_method__handles:

- :ref:`bool<class_bool>` **_handles** **(** :ref:`Variant<class_Variant>` object **)** |virtual| |const|

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 :ref:`_edit<class_EditorPlugin_method__edit>` and :ref:`_make_visible<class_EditorPlugin_method__make_visible>` called when the editor requests them. If you have declared the methods :ref:`_forward_canvas_gui_input<class_EditorPlugin_method__forward_canvas_gui_input>` and :ref:`_forward_3d_gui_input<class_EditorPlugin_method__forward_3d_gui_input>` these will be called too.

----

.. _class_EditorPlugin_method__has_main_screen:

- :ref:`bool<class_bool>` **_has_main_screen** **(** **)** |virtual| |const|

Returns ``true`` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**).

----

.. _class_EditorPlugin_method__make_visible:

- void **_make_visible** **(** :ref:`bool<class_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.

----

.. _class_EditorPlugin_method__save_external_data:

- void **_save_external_data** **(** **)** |virtual|

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.

----

.. _class_EditorPlugin_method__set_state:

- void **_set_state** **(** :ref:`Dictionary<class_Dictionary>` state **)** |virtual|

Restore the state saved by :ref:`_get_state<class_EditorPlugin_method__get_state>`.

----

.. _class_EditorPlugin_method__set_window_layout:

- void **_set_window_layout** **(** :ref:`ConfigFile<class_ConfigFile>` configuration **)** |virtual|

Restore the plugin GUI layout saved by :ref:`_get_window_layout<class_EditorPlugin_method__get_window_layout>`.

----

.. _class_EditorPlugin_method_add_autoload_singleton:

- void **add_autoload_singleton** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` path **)**

Adds a script at ``path`` to the Autoload list as ``name``.

----

.. _class_EditorPlugin_method_add_control_to_bottom_panel:

- :ref:`Button<class_Button>` **add_control_to_bottom_panel** **(** :ref:`Control<class_Control>` control, :ref:`String<class_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 :ref:`remove_control_from_bottom_panel<class_EditorPlugin_method_remove_control_from_bottom_panel>` and free it with :ref:`Node.queue_free<class_Node_method_queue_free>`.

----

.. _class_EditorPlugin_method_add_control_to_container:

- void **add_control_to_container** **(** :ref:`CustomControlContainer<enum_EditorPlugin_CustomControlContainer>` container, :ref:`Control<class_Control>` control **)**

Adds a custom control to a container (see :ref:`CustomControlContainer<enum_EditorPlugin_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 :ref:`remove_control_from_container<class_EditorPlugin_method_remove_control_from_container>` and free it with :ref:`Node.queue_free<class_Node_method_queue_free>`.

----

.. _class_EditorPlugin_method_add_control_to_dock:

- void **add_control_to_dock** **(** :ref:`DockSlot<enum_EditorPlugin_DockSlot>` slot, :ref:`Control<class_Control>` control **)**

Adds the control to a specific dock slot (see :ref:`DockSlot<enum_EditorPlugin_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 :ref:`remove_control_from_docks<class_EditorPlugin_method_remove_control_from_docks>` and free it with :ref:`Node.queue_free<class_Node_method_queue_free>`.

----

.. _class_EditorPlugin_method_add_custom_type:

- void **add_custom_type** **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture2D<class_Texture2D>` icon **)**

Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.

When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object.

You can use the virtual method :ref:`_handles<class_EditorPlugin_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.

----

.. _class_EditorPlugin_method_add_debugger_plugin:

- void **add_debugger_plugin** **(** :ref:`Script<class_Script>` script **)**

Adds a :ref:`Script<class_Script>` as debugger plugin to the Debugger. The script must extend :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>`.

----

.. _class_EditorPlugin_method_add_export_plugin:

- void **add_export_plugin** **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)**

Registers a new :ref:`EditorExportPlugin<class_EditorExportPlugin>`. Export plugins are used to perform tasks when the project is being exported.

See :ref:`add_inspector_plugin<class_EditorPlugin_method_add_inspector_plugin>` for an example of how to register a plugin.

----

.. _class_EditorPlugin_method_add_import_plugin:

- void **add_import_plugin** **(** :ref:`EditorImportPlugin<class_EditorImportPlugin>` importer **)**

Registers a new :ref:`EditorImportPlugin<class_EditorImportPlugin>`. Import plugins are used to import custom and unsupported assets as a custom :ref:`Resource<class_Resource>` type.

**Note:** If you want to import custom 3D asset formats use :ref:`add_scene_format_importer_plugin<class_EditorPlugin_method_add_scene_format_importer_plugin>` instead.

See :ref:`add_inspector_plugin<class_EditorPlugin_method_add_inspector_plugin>` for an example of how to register a plugin.

----

.. _class_EditorPlugin_method_add_inspector_plugin:

- void **add_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` plugin **)**

Registers a new :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`. Inspector plugins are used to extend :ref:`EditorInspector<class_EditorInspector>` and provide custom configuration tools for your object's properties.

**Note:** Always use :ref:`remove_inspector_plugin<class_EditorPlugin_method_remove_inspector_plugin>` to remove the registered :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` when your ``EditorPlugin`` is disabled to prevent leaks and an unexpected behavior.


.. tabs::

 .. code-tab:: gdscript

    const MyInspectorPlugin = preload("res://addons/your_addon/path/to/your/script.gd")
    var inspector_plugin = MyInspectorPlugin.new()
    
    func _enter_tree():
        add_inspector_plugin(inspector_plugin)
    
    func _exit_tree():
        remove_inspector_plugin(inspector_plugin)



----

.. _class_EditorPlugin_method_add_scene_format_importer_plugin:

- void **add_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>` scene_format_importer **)**

Registers a new :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>`. Scene importers are used to import custom 3D asset formats as scenes.

----

.. _class_EditorPlugin_method_add_scene_post_import_plugin:

- void **add_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>` scene_import_plugin **)**

Add a :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>`. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs.

----

.. _class_EditorPlugin_method_add_spatial_gizmo_plugin:

- void **add_spatial_gizmo_plugin** **(** :ref:`EditorNode3DGizmoPlugin<class_EditorNode3DGizmoPlugin>` plugin **)**

Registers a new :ref:`EditorNode3DGizmoPlugin<class_EditorNode3DGizmoPlugin>`. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a :ref:`Node3D<class_Node3D>`.

See :ref:`add_inspector_plugin<class_EditorPlugin_method_add_inspector_plugin>` for an example of how to register a plugin.

----

.. _class_EditorPlugin_method_add_tool_menu_item:

- void **add_tool_menu_item** **(** :ref:`String<class_String>` name, :ref:`Callable<class_Callable>` callable **)**

Adds a custom menu item to **Project > Tools** named ``name``. When clicked, the provided ``callable`` will be called.

----

.. _class_EditorPlugin_method_add_tool_submenu_item:

- void **add_tool_submenu_item** **(** :ref:`String<class_String>` name, :ref:`Object<class_Object>` submenu **)**

Adds a custom submenu under **Project > Tools >** ``name``. ``submenu`` should be an object of class :ref:`PopupMenu<class_PopupMenu>`. Use ``remove_tool_menu_item(name)`` on plugin clean up to remove the menu.

----

.. _class_EditorPlugin_method_add_translation_parser_plugin:

- void **add_translation_parser_plugin** **(** :ref:`EditorTranslationParserPlugin<class_EditorTranslationParserPlugin>` parser **)**

Registers a custom translation parser plugin for extracting translatable strings from custom files.

----

.. _class_EditorPlugin_method_add_undo_redo_inspector_hook_callback:

- void **add_undo_redo_inspector_hook_callback** **(** :ref:`Callable<class_Callable>` callable **)**

Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified.

The callback should have 4 arguments: :ref:`Object<class_Object>` ``undo_redo``, :ref:`Object<class_Object>` ``modified_object``, :ref:`String<class_String>` ``property`` and :ref:`Variant<class_Variant>` ``new_value``. They are, respectively, the :ref:`UndoRedo<class_UndoRedo>` object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take.

----

.. _class_EditorPlugin_method_get_editor_interface:

- :ref:`EditorInterface<class_EditorInterface>` **get_editor_interface** **(** **)**

Returns the :ref:`EditorInterface<class_EditorInterface>` object that gives you control over Godot editor's window and its functionalities.

----

.. _class_EditorPlugin_method_get_script_create_dialog:

- :ref:`ScriptCreateDialog<class_ScriptCreateDialog>` **get_script_create_dialog** **(** **)**

Gets the Editor's dialogue used for making scripts.

**Note:** Users can configure it before use.

**Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash.

----

.. _class_EditorPlugin_method_get_undo_redo:

- :ref:`UndoRedo<class_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.

----

.. _class_EditorPlugin_method_hide_bottom_panel:

- void **hide_bottom_panel** **(** **)**

Minimizes the bottom panel.

----

.. _class_EditorPlugin_method_make_bottom_panel_item_visible:

- void **make_bottom_panel_item_visible** **(** :ref:`Control<class_Control>` item **)**

Makes a specific item in the bottom panel visible.

----

.. _class_EditorPlugin_method_queue_save_layout:

- void **queue_save_layout** **(** **)**

Queue save the project's editor layout.

----

.. _class_EditorPlugin_method_remove_autoload_singleton:

- void **remove_autoload_singleton** **(** :ref:`String<class_String>` name **)**

Removes an Autoload ``name`` from the list.

----

.. _class_EditorPlugin_method_remove_control_from_bottom_panel:

- void **remove_control_from_bottom_panel** **(** :ref:`Control<class_Control>` control **)**

Removes the control from the bottom panel. You have to manually :ref:`Node.queue_free<class_Node_method_queue_free>` the control.

----

.. _class_EditorPlugin_method_remove_control_from_container:

- void **remove_control_from_container** **(** :ref:`CustomControlContainer<enum_EditorPlugin_CustomControlContainer>` container, :ref:`Control<class_Control>` control **)**

Removes the control from the specified container. You have to manually :ref:`Node.queue_free<class_Node_method_queue_free>` the control.

----

.. _class_EditorPlugin_method_remove_control_from_docks:

- void **remove_control_from_docks** **(** :ref:`Control<class_Control>` control **)**

Removes the control from the dock. You have to manually :ref:`Node.queue_free<class_Node_method_queue_free>` the control.

----

.. _class_EditorPlugin_method_remove_custom_type:

- void **remove_custom_type** **(** :ref:`String<class_String>` type **)**

Removes a custom type added by :ref:`add_custom_type<class_EditorPlugin_method_add_custom_type>`.

----

.. _class_EditorPlugin_method_remove_debugger_plugin:

- void **remove_debugger_plugin** **(** :ref:`Script<class_Script>` script **)**

Removes the debugger plugin with given script from the Debugger.

----

.. _class_EditorPlugin_method_remove_export_plugin:

- void **remove_export_plugin** **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)**

Removes an export plugin registered by :ref:`add_export_plugin<class_EditorPlugin_method_add_export_plugin>`.

----

.. _class_EditorPlugin_method_remove_import_plugin:

- void **remove_import_plugin** **(** :ref:`EditorImportPlugin<class_EditorImportPlugin>` importer **)**

Removes an import plugin registered by :ref:`add_import_plugin<class_EditorPlugin_method_add_import_plugin>`.

----

.. _class_EditorPlugin_method_remove_inspector_plugin:

- void **remove_inspector_plugin** **(** :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` plugin **)**

Removes an inspector plugin registered by :ref:`add_import_plugin<class_EditorPlugin_method_add_import_plugin>`

----

.. _class_EditorPlugin_method_remove_scene_format_importer_plugin:

- void **remove_scene_format_importer_plugin** **(** :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>` scene_format_importer **)**

Removes a scene format importer registered by :ref:`add_scene_format_importer_plugin<class_EditorPlugin_method_add_scene_format_importer_plugin>`.

----

.. _class_EditorPlugin_method_remove_scene_post_import_plugin:

- void **remove_scene_post_import_plugin** **(** :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>` scene_import_plugin **)**

Remove the :ref:`EditorScenePostImportPlugin<class_EditorScenePostImportPlugin>`, added with :ref:`add_scene_post_import_plugin<class_EditorPlugin_method_add_scene_post_import_plugin>`.

----

.. _class_EditorPlugin_method_remove_spatial_gizmo_plugin:

- void **remove_spatial_gizmo_plugin** **(** :ref:`EditorNode3DGizmoPlugin<class_EditorNode3DGizmoPlugin>` plugin **)**

Removes a gizmo plugin registered by :ref:`add_spatial_gizmo_plugin<class_EditorPlugin_method_add_spatial_gizmo_plugin>`.

----

.. _class_EditorPlugin_method_remove_tool_menu_item:

- void **remove_tool_menu_item** **(** :ref:`String<class_String>` name **)**

Removes a menu ``name`` from **Project > Tools**.

----

.. _class_EditorPlugin_method_remove_translation_parser_plugin:

- void **remove_translation_parser_plugin** **(** :ref:`EditorTranslationParserPlugin<class_EditorTranslationParserPlugin>` parser **)**

Removes a custom translation parser plugin registered by :ref:`add_translation_parser_plugin<class_EditorPlugin_method_add_translation_parser_plugin>`.

----

.. _class_EditorPlugin_method_remove_undo_redo_inspector_hook_callback:

- void **remove_undo_redo_inspector_hook_callback** **(** :ref:`Callable<class_Callable>` callable **)**

Removes a callback previsously added by :ref:`add_undo_redo_inspector_hook_callback<class_EditorPlugin_method_add_undo_redo_inspector_hook_callback>`.

----

.. _class_EditorPlugin_method_set_force_draw_over_forwarding_enabled:

- void **set_force_draw_over_forwarding_enabled** **(** **)**

Enables calling of :ref:`_forward_canvas_force_draw_over_viewport<class_EditorPlugin_method__forward_canvas_force_draw_over_viewport>` for the 2D editor and :ref:`_forward_3d_force_draw_over_viewport<class_EditorPlugin_method__forward_3d_force_draw_over_viewport>` for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin.

----

.. _class_EditorPlugin_method_set_input_event_forwarding_always_enabled:

- void **set_input_event_forwarding_always_enabled** **(** **)**

Use this method if you always want to receive inputs from 3D view screen inside :ref:`_forward_3d_gui_input<class_EditorPlugin_method__forward_3d_gui_input>`. It might be especially usable if your plugin will want to use raycast in the scene.

----

.. _class_EditorPlugin_method_update_overlays:

- :ref:`int<class_int>` **update_overlays** **(** **)** |const|

Updates the overlays of the 2D and 3D editor viewport. Causes methods :ref:`_forward_canvas_draw_over_viewport<class_EditorPlugin_method__forward_canvas_draw_over_viewport>`, :ref:`_forward_canvas_force_draw_over_viewport<class_EditorPlugin_method__forward_canvas_force_draw_over_viewport>`, :ref:`_forward_3d_draw_over_viewport<class_EditorPlugin_method__forward_3d_draw_over_viewport>` and :ref:`_forward_3d_force_draw_over_viewport<class_EditorPlugin_method__forward_3d_force_draw_over_viewport>` to be called.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`