godot-docs/classes/class_editorinterface.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorInterface.xml.

.. _class_EditorInterface:

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

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

Godot editor's interface.

.. rst-class:: classref-introduction-group

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 directly by its name.


.. tabs::

 .. code-tab:: gdscript

    var editor_settings = EditorInterface.get_editor_settings()

 .. code-tab:: csharp

    // In C# you can access it via the static Singleton property.
    EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();



.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

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

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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>` **(** **)** |const|                                                                                                                                                                    |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`EditorCommandPalette<class_EditorCommandPalette>`   | :ref:`get_command_palette<class_EditorInterface_method_get_command_palette>` **(** **)** |const|                                                                                                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                               | :ref:`get_current_directory<class_EditorInterface_method_get_current_directory>` **(** **)** |const|                                                                                                                                                          |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                               | :ref:`get_current_feature_profile<class_EditorInterface_method_get_current_feature_profile>` **(** **)** |const|                                                                                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :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>` **(** **)** |const|                                                                                                                                                          |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`VBoxContainer<class_VBoxContainer>`                 | :ref:`get_editor_main_screen<class_EditorInterface_method_get_editor_main_screen>` **(** **)** |const|                                                                                                                                                        |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`EditorPaths<class_EditorPaths>`                     | :ref:`get_editor_paths<class_EditorInterface_method_get_editor_paths>` **(** **)** |const|                                                                                                                                                                    |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :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>` **(** **)** |const|                                                                                                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Theme<class_Theme>`                                 | :ref:`get_editor_theme<class_EditorInterface_method_get_editor_theme>` **(** **)** |const|                                                                                                                                                                    |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`SubViewport<class_SubViewport>`                     | :ref:`get_editor_viewport_2d<class_EditorInterface_method_get_editor_viewport_2d>` **(** **)** |const|                                                                                                                                                        |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`SubViewport<class_SubViewport>`                     | :ref:`get_editor_viewport_3d<class_EditorInterface_method_get_editor_viewport_3d>` **(** :ref:`int<class_int>` idx=0 **)** |const|                                                                                                                            |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`FileSystemDock<class_FileSystemDock>`               | :ref:`get_file_system_dock<class_EditorInterface_method_get_file_system_dock>` **(** **)** |const|                                                                                                                                                            |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`EditorInspector<class_EditorInspector>`             | :ref:`get_inspector<class_EditorInterface_method_get_inspector>` **(** **)** |const|                                                                                                                                                                          |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>`         | :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>` **(** **)** |const|                                                                                                                                                      |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`EditorResourcePreview<class_EditorResourcePreview>` | :ref:`get_resource_previewer<class_EditorInterface_method_get_resource_previewer>` **(** **)** |const|                                                                                                                                                        |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`ScriptEditor<class_ScriptEditor>`                   | :ref:`get_script_editor<class_EditorInterface_method_get_script_editor>` **(** **)** |const|                                                                                                                                                                  |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>`         | :ref:`get_selected_paths<class_EditorInterface_method_get_selected_paths>` **(** **)** |const|                                                                                                                                                                |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`EditorSelection<class_EditorSelection>`             | :ref:`get_selection<class_EditorInterface_method_get_selection>` **(** **)** |const|                                                                                                                                                                          |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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_multi_window_enabled<class_EditorInterface_method_is_multi_window_enabled>` **(** **)** |const|                                                                                                                                                      |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :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:`Texture2D[]<class_Texture2D>`                       | :ref:`make_mesh_previews<class_EditorInterface_method_make_mesh_previews>` **(** :ref:`Mesh[]<class_Mesh>` meshes, :ref:`int<class_int>` preview_size **)**                                                                                                   |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`mark_scene_as_unsaved<class_EditorInterface_method_mark_scene_as_unsaved>` **(** **)**                                                                                                                                                                  |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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:`popup_dialog<class_EditorInterface_method_popup_dialog>` **(** :ref:`Window<class_Window>` dialog, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**                                                                                            |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`popup_dialog_centered<class_EditorInterface_method_popup_dialog_centered>` **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**                                                                       |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`popup_dialog_centered_clamped<class_EditorInterface_method_popup_dialog_centered_clamped>` **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**        |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`popup_dialog_centered_ratio<class_EditorInterface_method_popup_dialog_centered_ratio>` **(** :ref:`Window<class_Window>` dialog, :ref:`float<class_float>` ratio=0.8 **)**                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`popup_node_selector<class_EditorInterface_method_popup_node_selector>` **(** :ref:`Callable<class_Callable>` callback, :ref:`StringName[]<class_StringName>` valid_types=[] **)**                                                                       |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`popup_property_selector<class_EditorInterface_method_popup_property_selector>` **(** :ref:`Object<class_Object>` object, :ref:`Callable<class_Callable>` callback, :ref:`PackedInt32Array<class_PackedInt32Array>` type_filter=PackedInt32Array() **)** |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`reload_scene_from_path<class_EditorInterface_method_reload_scene_from_path>` **(** :ref:`String<class_String>` scene_filepath **)**                                                                                                                     |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`restart_editor<class_EditorInterface_method_restart_editor>` **(** :ref:`bool<class_bool>` save=true **)**                                                                                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                      | :ref:`save_all_scenes<class_EditorInterface_method_save_all_scenes>` **(** **)**                                                                                                                                                                              |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :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_current_feature_profile<class_EditorInterface_method_set_current_feature_profile>` **(** :ref:`String<class_String>` profile_name **)**                                                                                                             |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | 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>` **(** **)**                                                                                                                                                                        |
   +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

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

.. _class_EditorInterface_property_distraction_free_mode:

.. rst-class:: classref-property

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

.. rst-class:: classref-property-setget

- void **set_distraction_free_mode** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_distraction_free_mode_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_property_movie_maker_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **movie_maker_enabled**

.. rst-class:: classref-property-setget

- void **set_movie_maker_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_movie_maker_enabled** **(** **)**

If ``true``, the Movie Maker mode is enabled in the editor. See :ref:`MovieWriter<class_MovieWriter>` for more information.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

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

.. _class_EditorInterface_method_edit_node:

.. rst-class:: classref-method

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_edit_resource:

.. rst-class:: classref-method

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_edit_script:

.. rst-class:: classref-method

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_base_control:

.. rst-class:: classref-method

:ref:`Control<class_Control>` **get_base_control** **(** **)** |const|

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_command_palette:

.. rst-class:: classref-method

:ref:`EditorCommandPalette<class_EditorCommandPalette>` **get_command_palette** **(** **)** |const|

Returns the editor's :ref:`EditorCommandPalette<class_EditorCommandPalette>` instance.

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_current_directory:

.. rst-class:: classref-method

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

Returns the current directory being viewed 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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_current_feature_profile:

.. rst-class:: classref-method

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

Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead.

In order to get a reference to the :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, you must load the feature profile using :ref:`EditorFeatureProfile.load_from_file<class_EditorFeatureProfile_method_load_from_file>`.

\ **Note:** Feature profiles created via the user interface are loaded from the ``feature_profiles`` directory, as a file with the ``.profile`` extension. The editor configuration folder can be found by using :ref:`EditorPaths.get_config_dir<class_EditorPaths_method_get_config_dir>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_current_path:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_edited_scene_root:

.. rst-class:: classref-method

:ref:`Node<class_Node>` **get_edited_scene_root** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_main_screen:

.. rst-class:: classref-method

:ref:`VBoxContainer<class_VBoxContainer>` **get_editor_main_screen** **(** **)** |const|

Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen<class_EditorPlugin_private_method__has_main_screen>`.

\ **Note:** This node is a :ref:`VBoxContainer<class_VBoxContainer>`, which means that if you add a :ref:`Control<class_Control>` child to it, you need to set the child's :ref:`Control.size_flags_vertical<class_Control_property_size_flags_vertical>` to :ref:`Control.SIZE_EXPAND_FILL<class_Control_constant_SIZE_EXPAND_FILL>` to make it use the full available space.

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_paths:

.. rst-class:: classref-method

:ref:`EditorPaths<class_EditorPaths>` **get_editor_paths** **(** **)** |const|

Returns the :ref:`EditorPaths<class_EditorPaths>` singleton.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_scale:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_settings:

.. rst-class:: classref-method

:ref:`EditorSettings<class_EditorSettings>` **get_editor_settings** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_theme:

.. rst-class:: classref-method

:ref:`Theme<class_Theme>` **get_editor_theme** **(** **)** |const|

Returns the editor's :ref:`Theme<class_Theme>`.

\ **Note:** When creating custom editor UI, prefer accessing theme items directly from your GUI nodes using the ``get_theme_*`` methods.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_viewport_2d:

.. rst-class:: classref-method

:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_2d** **(** **)** |const|

Returns the 2D editor :ref:`SubViewport<class_SubViewport>`. It does not have a camera. Instead, the view transforms are done directly and can be accessed with :ref:`Viewport.global_canvas_transform<class_Viewport_property_global_canvas_transform>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_editor_viewport_3d:

.. rst-class:: classref-method

:ref:`SubViewport<class_SubViewport>` **get_editor_viewport_3d** **(** :ref:`int<class_int>` idx=0 **)** |const|

Returns the specified 3D editor :ref:`SubViewport<class_SubViewport>`, from ``0`` to ``3``. The viewport can be used to access the active editor cameras with :ref:`Viewport.get_camera_3d<class_Viewport_method_get_camera_3d>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_file_system_dock:

.. rst-class:: classref-method

:ref:`FileSystemDock<class_FileSystemDock>` **get_file_system_dock** **(** **)** |const|

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_inspector:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_open_scenes:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_open_scenes** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_playing_scene:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_resource_filesystem:

.. rst-class:: classref-method

:ref:`EditorFileSystem<class_EditorFileSystem>` **get_resource_filesystem** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_resource_previewer:

.. rst-class:: classref-method

:ref:`EditorResourcePreview<class_EditorResourcePreview>` **get_resource_previewer** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_script_editor:

.. rst-class:: classref-method

:ref:`ScriptEditor<class_ScriptEditor>` **get_script_editor** **(** **)** |const|

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_selected_paths:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **get_selected_paths** **(** **)** |const|

Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock<class_FileSystemDock>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_get_selection:

.. rst-class:: classref-method

:ref:`EditorSelection<class_EditorSelection>` **get_selection** **(** **)** |const|

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_inspect_object:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_is_multi_window_enabled:

.. rst-class:: classref-method

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

Returns ``true`` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true:

- :ref:`EditorSettings.interface/multi_window/enable<class_EditorSettings_property_interface/multi_window/enable>` is ``true``.

- :ref:`EditorSettings.interface/editor/single_window_mode<class_EditorSettings_property_interface/editor/single_window_mode>` is ``false``.

- :ref:`Viewport.gui_embed_subwindows<class_Viewport_property_gui_embed_subwindows>` is ``false``. This is forced to ``true`` on platforms that don't support multiple windows such as Web, or when the ``--single-window`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` is used.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_is_playing_scene:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_is_plugin_enabled:

.. rst-class:: classref-method

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_make_mesh_previews:

.. rst-class:: classref-method

:ref:`Texture2D[]<class_Texture2D>` **make_mesh_previews** **(** :ref:`Mesh[]<class_Mesh>` meshes, :ref:`int<class_int>` preview_size **)**

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_mark_scene_as_unsaved:

.. rst-class:: classref-method

void **mark_scene_as_unsaved** **(** **)**

Marks the current scene tab as unsaved.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_open_scene_from_path:

.. rst-class:: classref-method

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

Opens the scene at the given path.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_play_current_scene:

.. rst-class:: classref-method

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

Plays the currently active scene.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_play_custom_scene:

.. rst-class:: classref-method

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

Plays the scene specified by its filepath.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_play_main_scene:

.. rst-class:: classref-method

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

Plays the main scene.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_dialog:

.. rst-class:: classref-method

void **popup_dialog** **(** :ref:`Window<class_Window>` dialog, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**

Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive<class_Window_method_popup_exclusive>`. The dialog must have no current parent, otherwise the method fails.

See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_dialog_centered:

.. rst-class:: classref-method

void **popup_dialog_centered** **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**

Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered<class_Window_method_popup_exclusive_centered>`. The dialog must have no current parent, otherwise the method fails.

See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_dialog_centered_clamped:

.. rst-class:: classref-method

void **popup_dialog_centered_clamped** **(** :ref:`Window<class_Window>` dialog, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**

Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_clamped<class_Window_method_popup_exclusive_centered_clamped>`. The dialog must have no current parent, otherwise the method fails.

See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_dialog_centered_ratio:

.. rst-class:: classref-method

void **popup_dialog_centered_ratio** **(** :ref:`Window<class_Window>` dialog, :ref:`float<class_float>` ratio=0.8 **)**

Pops up the ``dialog`` in the editor UI with :ref:`Window.popup_exclusive_centered_ratio<class_Window_method_popup_exclusive_centered_ratio>`. The dialog must have no current parent, otherwise the method fails.

See also :ref:`Window.set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_node_selector:

.. rst-class:: classref-method

void **popup_node_selector** **(** :ref:`Callable<class_Callable>` callback, :ref:`StringName[]<class_StringName>` valid_types=[] **)**

Pops up an editor dialog for selecting a :ref:`Node<class_Node>` from the edited scene. The ``callback`` must take a single argument of type :ref:`NodePath<class_NodePath>`. It is called on the selected :ref:`NodePath<class_NodePath>` or the empty path ``^""`` if the dialog is canceled. If ``valid_types`` is provided, the dialog will only show Nodes that match one of the listed Node types.

\ **Example:**\ 

::

    func _ready():
        if Engine.is_editor_hint():
            EditorInterface.popup_node_selector(_on_node_selected, ["Button"])
    
    func _on_node_selected(node_path):
        if node_path.is_empty():
            print("node selection canceled")
        else:
            print("selected ", node_path)

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_popup_property_selector:

.. rst-class:: classref-method

void **popup_property_selector** **(** :ref:`Object<class_Object>` object, :ref:`Callable<class_Callable>` callback, :ref:`PackedInt32Array<class_PackedInt32Array>` type_filter=PackedInt32Array() **)**

Pops up an editor dialog for selecting properties from ``object``. The ``callback`` must take a single argument of type :ref:`NodePath<class_NodePath>`. It is called on the selected property path (see :ref:`NodePath.get_as_property_path<class_NodePath_method_get_as_property_path>`) or the empty path ``^""`` if the dialog is canceled. If ``type_filter`` is provided, the dialog will only show properties that match one of the listed :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.

\ **Example:**\ 

::

    func _ready():
        if Engine.is_editor_hint():
            EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT])
    
    func _on_property_selected(property_path):
        if property_path.is_empty():
            print("property selection canceled")
        else:
            print("selected ", property_path)

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_reload_scene_from_path:

.. rst-class:: classref-method

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

Reloads the scene at the given path.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_restart_editor:

.. rst-class:: classref-method

void **restart_editor** **(** :ref:`bool<class_bool>` save=true **)**

Restarts the editor. This closes the editor and then opens the same project. If ``save`` is ``true``, the project will be saved before restarting.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_save_all_scenes:

.. rst-class:: classref-method

void **save_all_scenes** **(** **)**

Saves all opened scenes in the editor.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_save_scene:

.. rst-class:: classref-method

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

Saves the currently active scene. Returns either :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` or :ref:`@GlobalScope.ERR_CANT_CREATE<class_@GlobalScope_constant_ERR_CANT_CREATE>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_save_scene_as:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_select_file:

.. rst-class:: classref-method

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

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

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_set_current_feature_profile:

.. rst-class:: classref-method

void **set_current_feature_profile** **(** :ref:`String<class_String>` profile_name **)**

Selects and activates the specified feature profile with the given ``profile_name``. Set ``profile_name`` to an empty string to reset to the default feature profile.

A feature profile can be created programmatically using the :ref:`EditorFeatureProfile<class_EditorFeatureProfile>` class.

\ **Note:** The feature profile that gets activated must be located in the ``feature_profiles`` directory, as a file with the ``.profile`` extension. If a profile could not be found, an error occurs. The editor configuration folder can be found by using :ref:`EditorPaths.get_config_dir<class_EditorPaths_method_get_config_dir>`.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_set_main_screen_editor:

.. rst-class:: classref-method

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 title of the tab in question exactly (e.g. ``2D``, ``3D``, ``Script``, or ``AssetLib`` for default tabs).

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_set_plugin_enabled:

.. rst-class:: classref-method

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.

.. rst-class:: classref-item-separator

----

.. _class_EditorInterface_method_stop_playing_scene:

.. rst-class:: classref-method

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.)`
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`