godot-docs/classes/class_editorinterface.rst

:github_url: hide

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

.. _class_EditorInterface:

EditorInterface
===============

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

Godot editor's interface.

Description
-----------

EditorInterface gives you control over Godot editor's window. It allows customizing the window, saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects, and provides access to :ref:`EditorSettings<class_EditorSettings>`, :ref:`EditorFileSystem<class_EditorFileSystem>`, :ref:`EditorResourcePreview<class_EditorResourcePreview>`, :ref:`ScriptEditor<class_ScriptEditor>`, the editor viewport, and information about scenes.

**Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorPlugin.get_editor_interface<class_EditorPlugin_method_get_editor_interface>`.

Properties
----------

+-------------------------+------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`distraction_free_mode<class_EditorInterface_property_distraction_free_mode>` |
+-------------------------+------------------------------------------------------------------------------------+

Methods
-------

+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`edit_node<class_EditorInterface_method_edit_node>` **(** :ref:`Node<class_Node>` node **)**                                                                                                                   |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`edit_resource<class_EditorInterface_method_edit_resource>` **(** :ref:`Resource<class_Resource>` resource **)**                                                                                               |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`edit_script<class_EditorInterface_method_edit_script>` **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line=-1, :ref:`int<class_int>` column=0, :ref:`bool<class_bool>` grab_focus=true **)** |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>`                             | :ref:`get_base_control<class_EditorInterface_method_get_base_control>` **(** **)**                                                                                                                                  |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                               | :ref:`get_current_path<class_EditorInterface_method_get_current_path>` **(** **)** |const|                                                                                                                          |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_Node>`                                   | :ref:`get_edited_scene_root<class_EditorInterface_method_get_edited_scene_root>` **(** **)**                                                                                                                        |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                                 | :ref:`get_editor_scale<class_EditorInterface_method_get_editor_scale>` **(** **)** |const|                                                                                                                          |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSettings<class_EditorSettings>`               | :ref:`get_editor_settings<class_EditorInterface_method_get_editor_settings>` **(** **)**                                                                                                                            |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_Control>`                             | :ref:`get_editor_viewport<class_EditorInterface_method_get_editor_viewport>` **(** **)**                                                                                                                            |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FileSystemDock<class_FileSystemDock>`               | :ref:`get_file_system_dock<class_EditorInterface_method_get_file_system_dock>` **(** **)**                                                                                                                          |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorInspector<class_EditorInspector>`             | :ref:`get_inspector<class_EditorInterface_method_get_inspector>` **(** **)** |const|                                                                                                                                |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                                 | :ref:`get_open_scenes<class_EditorInterface_method_get_open_scenes>` **(** **)** |const|                                                                                                                            |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                               | :ref:`get_playing_scene<class_EditorInterface_method_get_playing_scene>` **(** **)** |const|                                                                                                                        |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorFileSystem<class_EditorFileSystem>`           | :ref:`get_resource_filesystem<class_EditorInterface_method_get_resource_filesystem>` **(** **)**                                                                                                                    |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorResourcePreview<class_EditorResourcePreview>` | :ref:`get_resource_previewer<class_EditorInterface_method_get_resource_previewer>` **(** **)**                                                                                                                      |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ScriptEditor<class_ScriptEditor>`                   | :ref:`get_script_editor<class_EditorInterface_method_get_script_editor>` **(** **)**                                                                                                                                |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                               | :ref:`get_selected_path<class_EditorInterface_method_get_selected_path>` **(** **)** |const|                                                                                                                        |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSelection<class_EditorSelection>`             | :ref:`get_selection<class_EditorInterface_method_get_selection>` **(** **)**                                                                                                                                        |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`inspect_object<class_EditorInterface_method_inspect_object>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` for_property="", :ref:`bool<class_bool>` inspector_only=false **)**        |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                   | :ref:`is_playing_scene<class_EditorInterface_method_is_playing_scene>` **(** **)** |const|                                                                                                                          |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                                   | :ref:`is_plugin_enabled<class_EditorInterface_method_is_plugin_enabled>` **(** :ref:`String<class_String>` plugin **)** |const|                                                                                     |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`                                 | :ref:`make_mesh_previews<class_EditorInterface_method_make_mesh_previews>` **(** :ref:`Array<class_Array>` meshes, :ref:`int<class_int>` preview_size **)**                                                         |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`open_scene_from_path<class_EditorInterface_method_open_scene_from_path>` **(** :ref:`String<class_String>` scene_filepath **)**                                                                               |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`play_current_scene<class_EditorInterface_method_play_current_scene>` **(** **)**                                                                                                                              |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`play_custom_scene<class_EditorInterface_method_play_custom_scene>` **(** :ref:`String<class_String>` scene_filepath **)**                                                                                     |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`play_main_scene<class_EditorInterface_method_play_main_scene>` **(** **)**                                                                                                                                    |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`reload_scene_from_path<class_EditorInterface_method_reload_scene_from_path>` **(** :ref:`String<class_String>` scene_filepath **)**                                                                           |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>`                     | :ref:`save_scene<class_EditorInterface_method_save_scene>` **(** **)**                                                                                                                                              |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`save_scene_as<class_EditorInterface_method_save_scene_as>` **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` with_preview=true **)**                                                            |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`select_file<class_EditorInterface_method_select_file>` **(** :ref:`String<class_String>` file **)**                                                                                                           |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`set_main_screen_editor<class_EditorInterface_method_set_main_screen_editor>` **(** :ref:`String<class_String>` name **)**                                                                                     |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`set_plugin_enabled<class_EditorInterface_method_set_plugin_enabled>` **(** :ref:`String<class_String>` plugin, :ref:`bool<class_bool>` enabled **)**                                                          |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`stop_playing_scene<class_EditorInterface_method_stop_playing_scene>` **(** **)**                                                                                                                              |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_EditorInterface_property_distraction_free_mode:

- :ref:`bool<class_bool>` **distraction_free_mode**

+----------+------------------------------------+
| *Setter* | set_distraction_free_mode(value)   |
+----------+------------------------------------+
| *Getter* | is_distraction_free_mode_enabled() |
+----------+------------------------------------+

If ``true``, enables distraction-free mode which hides side docks to increase the space available for the main view.

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

.. _class_EditorInterface_method_edit_node:

- void **edit_node** **(** :ref:`Node<class_Node>` node **)**

Edits the given :ref:`Node<class_Node>`. The node will be also selected if it's inside the scene tree.

----

.. _class_EditorInterface_method_edit_resource:

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

Edits the given :ref:`Resource<class_Resource>`. If the resource is a :ref:`Script<class_Script>` you can also edit it with :ref:`edit_script<class_EditorInterface_method_edit_script>` to specify the line and column position.

----

.. _class_EditorInterface_method_edit_script:

- void **edit_script** **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line=-1, :ref:`int<class_int>` column=0, :ref:`bool<class_bool>` grab_focus=true **)**

Edits the given :ref:`Script<class_Script>`. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor.

----

.. _class_EditorInterface_method_get_base_control:

- :ref:`Control<class_Control>` **get_base_control** **(** **)**

Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly.

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

----

.. _class_EditorInterface_method_get_current_path:

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

Returns the current path being viewed in the :ref:`FileSystemDock<class_FileSystemDock>`.

----

.. _class_EditorInterface_method_get_edited_scene_root:

- :ref:`Node<class_Node>` **get_edited_scene_root** **(** **)**

Returns the edited (current) scene's root :ref:`Node<class_Node>`.

----

.. _class_EditorInterface_method_get_editor_scale:

- :ref:`float<class_float>` **get_editor_scale** **(** **)** |const|

Returns the actual scale of the editor UI (``1.0`` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.

**Note:** This value is set via the ``interface/editor/display_scale`` and ``interface/editor/custom_display_scale`` editor settings. Editor must be restarted for changes to be properly applied.

----

.. _class_EditorInterface_method_get_editor_settings:

- :ref:`EditorSettings<class_EditorSettings>` **get_editor_settings** **(** **)**

Returns the editor's :ref:`EditorSettings<class_EditorSettings>` instance.

----

.. _class_EditorInterface_method_get_editor_viewport:

- :ref:`Control<class_Control>` **get_editor_viewport** **(** **)**

Returns the main editor control. Use this as a parent for main screens.

**Note:** This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically.

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

----

.. _class_EditorInterface_method_get_file_system_dock:

- :ref:`FileSystemDock<class_FileSystemDock>` **get_file_system_dock** **(** **)**

Returns the editor's :ref:`FileSystemDock<class_FileSystemDock>` instance.

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

----

.. _class_EditorInterface_method_get_inspector:

- :ref:`EditorInspector<class_EditorInspector>` **get_inspector** **(** **)** |const|

Returns the editor's :ref:`EditorInspector<class_EditorInspector>` instance.

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

----

.. _class_EditorInterface_method_get_open_scenes:

- :ref:`Array<class_Array>` **get_open_scenes** **(** **)** |const|

Returns an :ref:`Array<class_Array>` with the file paths of the currently opened scenes.

----

.. _class_EditorInterface_method_get_playing_scene:

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

Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.

----

.. _class_EditorInterface_method_get_resource_filesystem:

- :ref:`EditorFileSystem<class_EditorFileSystem>` **get_resource_filesystem** **(** **)**

Returns the editor's :ref:`EditorFileSystem<class_EditorFileSystem>` instance.

----

.. _class_EditorInterface_method_get_resource_previewer:

- :ref:`EditorResourcePreview<class_EditorResourcePreview>` **get_resource_previewer** **(** **)**

Returns the editor's :ref:`EditorResourcePreview<class_EditorResourcePreview>` instance.

----

.. _class_EditorInterface_method_get_script_editor:

- :ref:`ScriptEditor<class_ScriptEditor>` **get_script_editor** **(** **)**

Returns the editor's :ref:`ScriptEditor<class_ScriptEditor>` instance.

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

----

.. _class_EditorInterface_method_get_selected_path:

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

Returns the path of the directory currently selected in the :ref:`FileSystemDock<class_FileSystemDock>`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir<class_String_method_get_base_dir>` instead.

----

.. _class_EditorInterface_method_get_selection:

- :ref:`EditorSelection<class_EditorSelection>` **get_selection** **(** **)**

Returns the editor's :ref:`EditorSelection<class_EditorSelection>` instance.

----

.. _class_EditorInterface_method_inspect_object:

- void **inspect_object** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` for_property="", :ref:`bool<class_bool>` inspector_only=false **)**

Shows the given property on the given ``object`` in the editor's Inspector dock. If ``inspector_only`` is ``true``, plugins will not attempt to edit ``object``.

----

.. _class_EditorInterface_method_is_playing_scene:

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

Returns ``true`` if a scene is currently being played, ``false`` otherwise. Paused scenes are considered as being played.

----

.. _class_EditorInterface_method_is_plugin_enabled:

- :ref:`bool<class_bool>` **is_plugin_enabled** **(** :ref:`String<class_String>` plugin **)** |const|

Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the same as its directory name.

----

.. _class_EditorInterface_method_make_mesh_previews:

- :ref:`Array<class_Array>` **make_mesh_previews** **(** :ref:`Array<class_Array>` meshes, :ref:`int<class_int>` preview_size **)**

Returns mesh previews rendered at the given size as an :ref:`Array<class_Array>` of :ref:`Texture<class_Texture>`\ s.

----

.. _class_EditorInterface_method_open_scene_from_path:

- void **open_scene_from_path** **(** :ref:`String<class_String>` scene_filepath **)**

Opens the scene at the given path.

----

.. _class_EditorInterface_method_play_current_scene:

- void **play_current_scene** **(** **)**

Plays the currently active scene.

----

.. _class_EditorInterface_method_play_custom_scene:

- void **play_custom_scene** **(** :ref:`String<class_String>` scene_filepath **)**

Plays the scene specified by its filepath.

----

.. _class_EditorInterface_method_play_main_scene:

- void **play_main_scene** **(** **)**

Plays the main scene.

----

.. _class_EditorInterface_method_reload_scene_from_path:

- void **reload_scene_from_path** **(** :ref:`String<class_String>` scene_filepath **)**

Reloads the scene at the given path.

----

.. _class_EditorInterface_method_save_scene:

- :ref:`Error<enum_@GlobalScope_Error>` **save_scene** **(** **)**

Saves the scene. Returns either ``OK`` or ``ERR_CANT_CREATE`` (see :ref:`@GlobalScope<class_@GlobalScope>` constants).

----

.. _class_EditorInterface_method_save_scene_as:

- void **save_scene_as** **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` with_preview=true **)**

Saves the scene as a file at ``path``.

----

.. _class_EditorInterface_method_select_file:

- void **select_file** **(** :ref:`String<class_String>` file **)**

Selects the file, with the path provided by ``file``, in the FileSystem dock.

----

.. _class_EditorInterface_method_set_main_screen_editor:

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

Sets the editor's current main screen to the one specified in ``name``. ``name`` must match the text of the tab in question exactly (``2D``, ``3D``, ``Script``, ``AssetLib``).

----

.. _class_EditorInterface_method_set_plugin_enabled:

- void **set_plugin_enabled** **(** :ref:`String<class_String>` plugin, :ref:`bool<class_bool>` enabled **)**

Sets the enabled status of a plugin. The plugin name is the same as its directory name.

----

.. _class_EditorInterface_method_stop_playing_scene:

- void **stop_playing_scene** **(** **)**

Stops the scene that is currently playing.

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