1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009 |
- :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
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`close_scene<class_EditorInterface_method_close_scene>`\ (\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`edit_node<class_EditorInterface_method_edit_node>`\ (\ node\: :ref:`Node<class_Node>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`edit_resource<class_EditorInterface_method_edit_resource>`\ (\ resource\: :ref:`Resource<class_Resource>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`edit_script<class_EditorInterface_method_edit_script>`\ (\ script\: :ref:`Script<class_Script>`, line\: :ref:`int<class_int>` = -1, column\: :ref:`int<class_int>` = 0, grab_focus\: :ref:`bool<class_bool>` = 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:`EditorToaster<class_EditorToaster>` | :ref:`get_editor_toaster<class_EditorInterface_method_get_editor_toaster>`\ (\ ) |const| |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`EditorUndoRedoManager<class_EditorUndoRedoManager>` | :ref:`get_editor_undo_redo<class_EditorInterface_method_get_editor_undo_redo>`\ (\ ) |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>`\ (\ idx\: :ref:`int<class_int>` = 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:`Array<class_Array>`\[:ref:`Node<class_Node>`\] | :ref:`get_open_scene_roots<class_EditorInterface_method_get_open_scene_roots>`\ (\ ) |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>`\ (\ object\: :ref:`Object<class_Object>`, for_property\: :ref:`String<class_String>` = "", inspector_only\: :ref:`bool<class_bool>` = 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>`\ (\ plugin\: :ref:`String<class_String>`\ ) |const| |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] | :ref:`make_mesh_previews<class_EditorInterface_method_make_mesh_previews>`\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`Mesh<class_Mesh>`\], preview_size\: :ref:`int<class_int>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |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>`\ (\ scene_filepath\: :ref:`String<class_String>`, set_inherited\: :ref:`bool<class_bool>` = false\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`play_current_scene<class_EditorInterface_method_play_current_scene>`\ (\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`play_custom_scene<class_EditorInterface_method_play_custom_scene>`\ (\ scene_filepath\: :ref:`String<class_String>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`play_main_scene<class_EditorInterface_method_play_main_scene>`\ (\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_create_dialog<class_EditorInterface_method_popup_create_dialog>`\ (\ callback\: :ref:`Callable<class_Callable>`, base_type\: :ref:`StringName<class_StringName>` = "", current_type\: :ref:`String<class_String>` = "", dialog_title\: :ref:`String<class_String>` = "", type_blocklist\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_dialog<class_EditorInterface_method_popup_dialog>`\ (\ dialog\: :ref:`Window<class_Window>`, rect\: :ref:`Rect2i<class_Rect2i>` = Rect2i(0, 0, 0, 0)\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_dialog_centered<class_EditorInterface_method_popup_dialog_centered>`\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0)\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_dialog_centered_clamped<class_EditorInterface_method_popup_dialog_centered_clamped>`\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0), fallback_ratio\: :ref:`float<class_float>` = 0.75\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_dialog_centered_ratio<class_EditorInterface_method_popup_dialog_centered_ratio>`\ (\ dialog\: :ref:`Window<class_Window>`, ratio\: :ref:`float<class_float>` = 0.8\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_method_selector<class_EditorInterface_method_popup_method_selector>`\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, current_value\: :ref:`String<class_String>` = ""\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_node_selector<class_EditorInterface_method_popup_node_selector>`\ (\ callback\: :ref:`Callable<class_Callable>`, valid_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = [], current_value\: :ref:`Node<class_Node>` = null\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_property_selector<class_EditorInterface_method_popup_property_selector>`\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, type_filter\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), current_value\: :ref:`String<class_String>` = ""\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`popup_quick_open<class_EditorInterface_method_popup_quick_open>`\ (\ callback\: :ref:`Callable<class_Callable>`, base_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`reload_scene_from_path<class_EditorInterface_method_reload_scene_from_path>`\ (\ scene_filepath\: :ref:`String<class_String>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`restart_editor<class_EditorInterface_method_restart_editor>`\ (\ save\: :ref:`bool<class_bool>` = 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>`\ (\ path\: :ref:`String<class_String>`, with_preview\: :ref:`bool<class_bool>` = true\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`select_file<class_EditorInterface_method_select_file>`\ (\ file\: :ref:`String<class_String>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_current_feature_profile<class_EditorInterface_method_set_current_feature_profile>`\ (\ profile_name\: :ref:`String<class_String>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_main_screen_editor<class_EditorInterface_method_set_main_screen_editor>`\ (\ name\: :ref:`String<class_String>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_plugin_enabled<class_EditorInterface_method_set_plugin_enabled>`\ (\ plugin\: :ref:`String<class_String>`, enabled\: :ref:`bool<class_bool>`\ ) |
- +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |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** :ref:`๐<class_EditorInterface_property_distraction_free_mode>`
- .. rst-class:: classref-property-setget
- - |void| **set_distraction_free_mode**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :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** :ref:`๐<class_EditorInterface_property_movie_maker_enabled>`
- .. rst-class:: classref-property-setget
- - |void| **set_movie_maker_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :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_close_scene:
- .. rst-class:: classref-method
- :ref:`Error<enum_@GlobalScope_Error>` **close_scene**\ (\ ) :ref:`๐<class_EditorInterface_method_close_scene>`
- Closes the currently active scene, discarding any pending changes in the process. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success or :ref:`@GlobalScope.ERR_DOES_NOT_EXIST<class_@GlobalScope_constant_ERR_DOES_NOT_EXIST>` if there is no scene to close.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_edit_node:
- .. rst-class:: classref-method
- |void| **edit_node**\ (\ node\: :ref:`Node<class_Node>`\ ) :ref:`๐<class_EditorInterface_method_edit_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**\ (\ resource\: :ref:`Resource<class_Resource>`\ ) :ref:`๐<class_EditorInterface_method_edit_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**\ (\ script\: :ref:`Script<class_Script>`, line\: :ref:`int<class_int>` = -1, column\: :ref:`int<class_int>` = 0, grab_focus\: :ref:`bool<class_bool>` = true\ ) :ref:`๐<class_EditorInterface_method_edit_script>`
- 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| :ref:`๐<class_EditorInterface_method_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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_get_command_palette:
- .. rst-class:: classref-method
- :ref:`EditorCommandPalette<class_EditorCommandPalette>` **get_command_palette**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_command_palette>`
- 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| :ref:`๐<class_EditorInterface_method_get_current_directory>`
- 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| :ref:`๐<class_EditorInterface_method_get_current_feature_profile>`
- 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| :ref:`๐<class_EditorInterface_method_get_current_path>`
- 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| :ref:`๐<class_EditorInterface_method_get_edited_scene_root>`
- 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| :ref:`๐<class_EditorInterface_method_get_editor_main_screen>`
- 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| :ref:`๐<class_EditorInterface_method_get_editor_paths>`
- 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| :ref:`๐<class_EditorInterface_method_get_editor_scale>`
- 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 :ref:`EditorSettings.interface/editor/display_scale<class_EditorSettings_property_interface/editor/display_scale>` and :ref:`EditorSettings.interface/editor/custom_display_scale<class_EditorSettings_property_interface/editor/custom_display_scale>` settings. The 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| :ref:`๐<class_EditorInterface_method_get_editor_settings>`
- 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| :ref:`๐<class_EditorInterface_method_get_editor_theme>`
- 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_toaster:
- .. rst-class:: classref-method
- :ref:`EditorToaster<class_EditorToaster>` **get_editor_toaster**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_editor_toaster>`
- Returns the editor's :ref:`EditorToaster<class_EditorToaster>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_get_editor_undo_redo:
- .. rst-class:: classref-method
- :ref:`EditorUndoRedoManager<class_EditorUndoRedoManager>` **get_editor_undo_redo**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_editor_undo_redo>`
- Returns the editor's :ref:`EditorUndoRedoManager<class_EditorUndoRedoManager>`.
- .. 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| :ref:`๐<class_EditorInterface_method_get_editor_viewport_2d>`
- 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**\ (\ idx\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐<class_EditorInterface_method_get_editor_viewport_3d>`
- 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| :ref:`๐<class_EditorInterface_method_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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_get_inspector:
- .. rst-class:: classref-method
- :ref:`EditorInspector<class_EditorInspector>` **get_inspector**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_inspector>`
- 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_scene_roots:
- .. rst-class:: classref-method
- :ref:`Array<class_Array>`\[:ref:`Node<class_Node>`\] **get_open_scene_roots**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_open_scene_roots>`
- Returns an array with references to the root nodes of the currently opened scenes.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_get_open_scenes:
- .. rst-class:: classref-method
- :ref:`PackedStringArray<class_PackedStringArray>` **get_open_scenes**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_open_scenes>`
- Returns an 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| :ref:`๐<class_EditorInterface_method_get_playing_scene>`
- 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| :ref:`๐<class_EditorInterface_method_get_resource_filesystem>`
- 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| :ref:`๐<class_EditorInterface_method_get_resource_previewer>`
- 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| :ref:`๐<class_EditorInterface_method_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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_get_selected_paths:
- .. rst-class:: classref-method
- :ref:`PackedStringArray<class_PackedStringArray>` **get_selected_paths**\ (\ ) |const| :ref:`๐<class_EditorInterface_method_get_selected_paths>`
- 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| :ref:`๐<class_EditorInterface_method_get_selection>`
- 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**\ (\ object\: :ref:`Object<class_Object>`, for_property\: :ref:`String<class_String>` = "", inspector_only\: :ref:`bool<class_bool>` = false\ ) :ref:`๐<class_EditorInterface_method_inspect_object>`
- 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| :ref:`๐<class_EditorInterface_method_is_multi_window_enabled>`
- 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| :ref:`๐<class_EditorInterface_method_is_playing_scene>`
- 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**\ (\ plugin\: :ref:`String<class_String>`\ ) |const| :ref:`๐<class_EditorInterface_method_is_plugin_enabled>`
- 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:`Array<class_Array>`\[:ref:`Texture2D<class_Texture2D>`\] **make_mesh_previews**\ (\ meshes\: :ref:`Array<class_Array>`\[:ref:`Mesh<class_Mesh>`\], preview_size\: :ref:`int<class_int>`\ ) :ref:`๐<class_EditorInterface_method_make_mesh_previews>`
- 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**\ (\ ) :ref:`๐<class_EditorInterface_method_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**\ (\ scene_filepath\: :ref:`String<class_String>`, set_inherited\: :ref:`bool<class_bool>` = false\ ) :ref:`๐<class_EditorInterface_method_open_scene_from_path>`
- Opens the scene at the given path. If ``set_inherited`` is ``true``, creates a new inherited scene.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_play_current_scene:
- .. rst-class:: classref-method
- |void| **play_current_scene**\ (\ ) :ref:`๐<class_EditorInterface_method_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**\ (\ scene_filepath\: :ref:`String<class_String>`\ ) :ref:`๐<class_EditorInterface_method_play_custom_scene>`
- 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**\ (\ ) :ref:`๐<class_EditorInterface_method_play_main_scene>`
- Plays the main scene.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_popup_create_dialog:
- .. rst-class:: classref-method
- |void| **popup_create_dialog**\ (\ callback\: :ref:`Callable<class_Callable>`, base_type\: :ref:`StringName<class_StringName>` = "", current_type\: :ref:`String<class_String>` = "", dialog_title\: :ref:`String<class_String>` = "", type_blocklist\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) :ref:`๐<class_EditorInterface_method_popup_create_dialog>`
- **Experimental:** This method may be changed or removed in future versions.
- Pops up an editor dialog for creating an object.
- The ``callback`` must take a single argument of type :ref:`StringName<class_StringName>` which will contain the type name of the selected object or be empty if no item is selected.
- The ``base_type`` specifies the base type of objects to display. For example, if you set this to "Resource", all types derived from :ref:`Resource<class_Resource>` will display in the create dialog.
- The ``current_type`` will be passed in the search box of the create dialog, and the specified type can be immediately selected when the dialog pops up. If the ``current_type`` is not derived from ``base_type``, there will be no result of the type in the dialog.
- The ``dialog_title`` allows you to define a custom title for the dialog. This is useful if you want to accurately hint the usage of the dialog. If the ``dialog_title`` is an empty string, the dialog will use "Create New 'Base Type'" as the default title.
- The ``type_blocklist`` contains a list of type names, and the types in the blocklist will be hidden from the create dialog.
- \ **Note:** Trying to list the base type in the ``type_blocklist`` will hide all types derived from the base type from the create dialog.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_popup_dialog:
- .. rst-class:: classref-method
- |void| **popup_dialog**\ (\ dialog\: :ref:`Window<class_Window>`, rect\: :ref:`Rect2i<class_Rect2i>` = Rect2i(0, 0, 0, 0)\ ) :ref:`๐<class_EditorInterface_method_popup_dialog>`
- 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**\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0)\ ) :ref:`๐<class_EditorInterface_method_popup_dialog_centered>`
- 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**\ (\ dialog\: :ref:`Window<class_Window>`, minsize\: :ref:`Vector2i<class_Vector2i>` = Vector2i(0, 0), fallback_ratio\: :ref:`float<class_float>` = 0.75\ ) :ref:`๐<class_EditorInterface_method_popup_dialog_centered_clamped>`
- 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**\ (\ dialog\: :ref:`Window<class_Window>`, ratio\: :ref:`float<class_float>` = 0.8\ ) :ref:`๐<class_EditorInterface_method_popup_dialog_centered_ratio>`
- 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_method_selector:
- .. rst-class:: classref-method
- |void| **popup_method_selector**\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, current_value\: :ref:`String<class_String>` = ""\ ) :ref:`๐<class_EditorInterface_method_popup_method_selector>`
- Pops up an editor dialog for selecting a method from ``object``. The ``callback`` must take a single argument of type :ref:`String<class_String>` which will contain the name of the selected method or be empty if the dialog is canceled. If ``current_value`` is provided, the method will be selected automatically in the method list, if it exists.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_popup_node_selector:
- .. rst-class:: classref-method
- |void| **popup_node_selector**\ (\ callback\: :ref:`Callable<class_Callable>`, valid_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = [], current_value\: :ref:`Node<class_Node>` = null\ ) :ref:`๐<class_EditorInterface_method_popup_node_selector>`
- 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. If ``current_value`` is provided, the Node will be automatically selected in the tree, if it exists.
- \ **Example:** Display the node selection dialog as soon as this node is added to the tree for the first time:
- ::
- 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**\ (\ object\: :ref:`Object<class_Object>`, callback\: :ref:`Callable<class_Callable>`, type_filter\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), current_value\: :ref:`String<class_String>` = ""\ ) :ref:`๐<class_EditorInterface_method_popup_property_selector>`
- 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. If ``current_value`` is provided, the property will be selected automatically in the property list, if it exists.
- ::
- 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_popup_quick_open:
- .. rst-class:: classref-method
- |void| **popup_quick_open**\ (\ callback\: :ref:`Callable<class_Callable>`, base_types\: :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] = []\ ) :ref:`๐<class_EditorInterface_method_popup_quick_open>`
- Pops up an editor dialog for quick selecting a resource file. The ``callback`` must take a single argument of type :ref:`String<class_String>` which will contain the path of the selected resource or be empty if the dialog is canceled. If ``base_types`` is provided, the dialog will only show resources that match these types. Only types deriving from :ref:`Resource<class_Resource>` are supported.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_reload_scene_from_path:
- .. rst-class:: classref-method
- |void| **reload_scene_from_path**\ (\ scene_filepath\: :ref:`String<class_String>`\ ) :ref:`๐<class_EditorInterface_method_reload_scene_from_path>`
- Reloads the scene at the given path.
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_restart_editor:
- .. rst-class:: classref-method
- |void| **restart_editor**\ (\ save\: :ref:`bool<class_bool>` = true\ ) :ref:`๐<class_EditorInterface_method_restart_editor>`
- 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**\ (\ ) :ref:`๐<class_EditorInterface_method_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**\ (\ ) :ref:`๐<class_EditorInterface_method_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**\ (\ path\: :ref:`String<class_String>`, with_preview\: :ref:`bool<class_bool>` = true\ ) :ref:`๐<class_EditorInterface_method_save_scene_as>`
- 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**\ (\ file\: :ref:`String<class_String>`\ ) :ref:`๐<class_EditorInterface_method_select_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**\ (\ profile_name\: :ref:`String<class_String>`\ ) :ref:`๐<class_EditorInterface_method_set_current_feature_profile>`
- 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**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`๐<class_EditorInterface_method_set_main_screen_editor>`
- 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``, ``Game``, or ``AssetLib`` for default tabs).
- .. rst-class:: classref-item-separator
- ----
- .. _class_EditorInterface_method_set_plugin_enabled:
- .. rst-class:: classref-method
- |void| **set_plugin_enabled**\ (\ plugin\: :ref:`String<class_String>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐<class_EditorInterface_method_set_plugin_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**\ (\ ) :ref:`๐<class_EditorInterface_method_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.)`
- .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
- .. |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.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|