godot-docs/classes/class_editorplugin.rst

.. Generated automatically by doc/tools/makerst.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>`

**Category:** Core

Brief Description
-----------------

Used by the editor to extend its functionality.

Member Functions
----------------

+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ToolButton<class_toolbutton>`                  | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>`  **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title  **)**                                           |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>`  **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control  **)**                                                   |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>`  **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control  **)**                                                                  |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>`  **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon  **)** |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_export_plugin<class_EditorPlugin_add_export_plugin>`  **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter  **)**                                                                           |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>`  **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer  **)**                                                                           |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>`  **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu  **)**                                                          |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`apply_changes<class_EditorPlugin_apply_changes>`  **(** **)** virtual                                                                                                                                         |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`clear<class_EditorPlugin_clear>`  **(** **)** virtual                                                                                                                                                         |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>`  | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>`  **(** :ref:`Spatial<class_spatial>` for_spatial  **)** virtual                                                                                |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`edit<class_EditorPlugin_edit>`  **(** :ref:`Object<class_object>` object  **)** virtual                                                                                                                       |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                              | :ref:`forward_canvas_gui_input<class_EditorPlugin_forward_canvas_gui_input>`  **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event  **)** virtual                    |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`forward_draw_over_canvas<class_EditorPlugin_forward_draw_over_canvas>`  **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`Control<class_control>` canvas  **)** virtual                         |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                              | :ref:`forward_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>`  **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event  **)** virtual                                  |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>`        | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>`  **(** **)** virtual                                                                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInterface<class_editorinterface>`        | :ref:`get_editor_interface<class_EditorPlugin_get_editor_interface>`  **(** **)**                                                                                                                                   |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`                          | :ref:`get_plugin_name<class_EditorPlugin_get_plugin_name>`  **(** **)** virtual                                                                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>`                  | :ref:`get_state<class_EditorPlugin_get_state>`  **(** **)** virtual                                                                                                                                                 |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`UndoRedo<class_undoredo>`                      | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>`  **(** **)**                                                                                                                                                 |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>`  **(** :ref:`ConfigFile<class_configfile>` layout  **)** virtual                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                              | :ref:`handles<class_EditorPlugin_handles>`  **(** :ref:`Object<class_object>` object  **)** virtual                                                                                                                 |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                              | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>`  **(** **)** virtual                                                                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>`  **(** **)**                                                                                                                                         |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>`  **(** :ref:`Control<class_control>` item  **)**                                                                           |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`make_visible<class_EditorPlugin_make_visible>`  **(** :ref:`bool<class_bool>` visible  **)** virtual                                                                                                          |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>`  **(** **)** const                                                                                                                                   |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>`  **(** :ref:`Control<class_control>` control  **)**                                                                    |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>`  **(** :ref:`Control<class_control>` control  **)**                                                                                  |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>`  **(** :ref:`String<class_string>` type  **)**                                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`remove_export_plugin<class_EditorPlugin_remove_export_plugin>`  **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter  **)**                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>`  **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer  **)**                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`save_external_data<class_EditorPlugin_save_external_data>`  **(** **)** virtual                                                                                                                               |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_set_input_event_forwarding_always_enabled>`  **(** **)**                                                                                         |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`set_state<class_EditorPlugin_set_state>`  **(** :ref:`Dictionary<class_dictionary>` state  **)** virtual                                                                                                      |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>`  **(** :ref:`ConfigFile<class_configfile>` layout  **)** virtual                                                                                     |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                 | :ref:`update_canvas<class_EditorPlugin_update_canvas>`  **(** **)**                                                                                                                                                 |
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **main_screen_changed**  **(** :ref:`String<class_string>` screen_name  **)**
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.

-  **scene_changed**  **(** :ref:`Object<class_object>` scene_root  **)**
Emitted when user change scene. The argument is a root node of freshly opened scene.

-  **scene_closed**  **(** :ref:`String<class_string>` filepath  **)**
Emitted when user close scene. The argument is file path to a closed scene.


Numeric Constants
-----------------

- **CONTAINER_TOOLBAR** = **0**
- **CONTAINER_SPATIAL_EDITOR_MENU** = **1**
- **CONTAINER_SPATIAL_EDITOR_SIDE** = **2**
- **CONTAINER_SPATIAL_EDITOR_BOTTOM** = **3**
- **CONTAINER_CANVAS_EDITOR_MENU** = **4**
- **CONTAINER_CANVAS_EDITOR_SIDE** = **5**
- **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **7**
- **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**

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.

Member Function Description
---------------------------

.. _class_EditorPlugin_add_control_to_bottom_panel:

- :ref:`ToolButton<class_toolbutton>`  **add_control_to_bottom_panel**  **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title  **)**

Add 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. If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>`.

.. _class_EditorPlugin_add_control_to_container:

- void  **add_control_to_container**  **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control  **)**

Add a custom control to a container (see CONTAINER\_\* enum). 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).

If your plugin is being removed, also make sure to remove your custom controls too.

.. _class_EditorPlugin_add_control_to_dock:

- void  **add_control_to_dock**  **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control  **)**

Add the control to a specific dock slot (see DOCK\_\* enum 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.

If your plugin is being removed, also make sure to remove your control by calling :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>`.

.. _class_EditorPlugin_add_custom_type:

- void  **add_custom_type**  **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon  **)**

Add 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 :ref:`EditorPlugin.handles<class_EditorPlugin_handles>` to check if your custom object is being edited by checking the script or using '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_add_export_plugin:

- void  **add_export_plugin**  **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter  **)**

.. _class_EditorPlugin_add_import_plugin:

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

.. _class_EditorPlugin_add_tool_submenu_item:

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

.. _class_EditorPlugin_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_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_create_spatial_gizmo:

- :ref:`EditorSpatialGizmo<class_editorspatialgizmo>`  **create_spatial_gizmo**  **(** :ref:`Spatial<class_spatial>` for_spatial  **)** virtual

This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin.

.. _class_EditorPlugin_edit:

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

.. _class_EditorPlugin_forward_canvas_gui_input:

- :ref:`bool<class_bool>`  **forward_canvas_gui_input**  **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event  **)** virtual

.. _class_EditorPlugin_forward_draw_over_canvas:

- void  **forward_draw_over_canvas**  **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`Control<class_control>` canvas  **)** virtual

This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call :ref:`update_canvas<class_EditorPlugin_update_canvas>`.

.. _class_EditorPlugin_forward_spatial_gui_input:

- :ref:`bool<class_bool>`  **forward_spatial_gui_input**  **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event  **)** virtual

Implement this function if you are interested in 3D view screen input events. It will be called only if currently selected node is handled by your plugin.

If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled<class_EditorPlugin_set_input_forwarding_always_enabled>`.

.. _class_EditorPlugin_get_breakpoints:

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

.. _class_EditorPlugin_get_editor_interface:

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

.. _class_EditorPlugin_get_plugin_name:

- :ref:`String<class_string>`  **get_plugin_name**  **(** **)** virtual

.. _class_EditorPlugin_get_state:

- :ref:`Dictionary<class_dictionary>`  **get_state**  **(** **)** virtual

Get 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_get_undo_redo:

- :ref:`UndoRedo<class_undoredo>`  **get_undo_redo**  **(** **)**

Get 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_get_window_layout:

- void  **get_window_layout**  **(** :ref:`ConfigFile<class_configfile>` layout  **)** virtual

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

.. _class_EditorPlugin_handles:

- :ref:`bool<class_bool>`  **handles**  **(** :ref:`Object<class_object>` object  **)** virtual

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:`EditorPlugin.edit<class_EditorPlugin_edit>` and :ref:`EditorPlugin.make_visible<class_EditorPlugin_make_visible>` called when the editor requests them.

.. _class_EditorPlugin_has_main_screen:

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

Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script).

.. _class_EditorPlugin_hide_bottom_panel:

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

.. _class_EditorPlugin_make_bottom_panel_item_visible:

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

.. _class_EditorPlugin_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_queue_save_layout:

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

Queue save the project's editor layout.

.. _class_EditorPlugin_remove_control_from_bottom_panel:

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

Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly.

.. _class_EditorPlugin_remove_control_from_docks:

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

Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly.

.. _class_EditorPlugin_remove_custom_type:

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

Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlugin_add_custom_type>`

.. _class_EditorPlugin_remove_export_plugin:

- void  **remove_export_plugin**  **(** :ref:`EditorExportPlugin<class_editorexportplugin>` exporter  **)**

.. _class_EditorPlugin_remove_import_plugin:

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

.. _class_EditorPlugin_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_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_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>`. It might be especially usable if your plugin will want to use raycast in the scene.

.. _class_EditorPlugin_set_state:

- void  **set_state**  **(** :ref:`Dictionary<class_dictionary>` state  **)** virtual

Restore the state saved by :ref:`EditorPlugin.get_state<class_EditorPlugin_get_state>`.

.. _class_EditorPlugin_set_window_layout:

- void  **set_window_layout**  **(** :ref:`ConfigFile<class_configfile>` layout  **)** virtual

Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout<class_EditorPlugin_get_window_layout>`.

.. _class_EditorPlugin_update_canvas:

- void  **update_canvas**  **(** **)**

Updates the control used to draw the edited scene over the 2D canvas. This is used together with :ref:`forward_canvas_input_event<class_EditorPlugin_forward_canvas_input_event>`.