2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "EditorInterface" inherits= "Node" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-09-18 14:38:19 +00:00
Godot editor's interface.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2018-09-18 14:38:19 +00:00
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 [EditorSettings], [EditorFileSystem], [EditorResourcePreview], [ScriptEditor], the editor viewport, and information about scenes.
2020-04-14 20:09:21 +00:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorPlugin.get_editor_interface].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
2021-04-07 20:08:41 +00:00
<method name= "edit_node" >
<return type= "void" >
</return>
<argument index= "0" name= "node" type= "Node" >
</argument>
<description >
Edits the given [Node]. The node will be also selected if it's inside the scene tree.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "edit_resource" >
<return type= "void" >
</return>
<argument index= "0" name= "resource" type= "Resource" >
</argument>
<description >
2017-10-12 17:10:42 +00:00
Edits the given [Resource].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_base_control" >
<return type= "Control" >
</return>
<description >
2020-07-18 15:17:00 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-09-24 09:44:48 +00:00
<method name= "get_current_path" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the current path being viewed in the [FileSystemDock].
2019-09-24 09:44:48 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_edited_scene_root" >
<return type= "Node" >
</return>
<description >
2018-09-18 14:38:19 +00:00
Returns the edited (current) scene's root [Node].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-12-19 14:17:42 +00:00
<method name= "get_editor_main_control" >
2017-09-12 20:42:36 +00:00
<return type= "Control" >
</return>
<description >
2020-07-30 10:21:49 +00:00
Returns the main editor control. Use this as a parent for main screens.
[b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically.
2017-09-12 20:42:36 +00:00
</description>
</method>
2021-04-04 14:08:25 +00:00
<method name= "get_editor_scale" qualifiers= "const" >
<return type= "float" >
</return>
<description >
Returns the actual scale of the editor UI ([code]1.0[/code] being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.
[b]Note:[/b] This value is set via the [code]interface/editor/display_scale[/code] and [code]interface/editor/custom_display_scale[/code] editor settings. Editor must be restarted for changes to be properly applied.
</description>
</method>
2021-01-04 13:33:44 +00:00
<method name= "get_editor_settings" >
<return type= "EditorSettings" >
</return>
<description >
Returns the editor's [EditorSettings] instance.
</description>
</method>
2020-03-20 11:58:38 +00:00
<method name= "get_file_system_dock" >
<return type= "FileSystemDock" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [FileSystemDock] instance.
2020-03-20 11:58:38 +00:00
</description>
</method>
2019-04-15 12:49:41 +00:00
<method name= "get_inspector" qualifiers= "const" >
<return type= "EditorInspector" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [EditorInspector] instance.
2019-04-15 12:49:41 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_open_scenes" qualifiers= "const" >
<return type= "Array" >
</return>
<description >
2018-09-18 14:38:19 +00:00
Returns an [Array] with the file paths of the currently opened scenes.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-04-05 14:19:24 +00:00
<method name= "get_playing_scene" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_resource_filesystem" >
<return type= "EditorFileSystem" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [EditorFileSystem] instance.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_resource_previewer" >
<return type= "EditorResourcePreview" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [EditorResourcePreview] instance.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_script_editor" >
<return type= "ScriptEditor" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [ScriptEditor] instance.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-01-07 00:37:45 +00:00
<method name= "get_selected_path" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the path of the directory currently selected in the [FileSystemDock]. If a file is selected, its base directory will be returned using [method String.get_base_dir] instead.
2018-01-07 00:37:45 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_selection" >
<return type= "EditorSelection" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns the editor's [EditorSelection] instance.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "inspect_object" >
<return type= "void" >
</return>
<argument index= "0" name= "object" type= "Object" >
</argument>
<argument index= "1" name= "for_property" type= "String" default= """" >
</argument>
2020-09-16 19:27:19 +00:00
<argument index= "2" name= "inspector_only" type= "bool" default= "false" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2020-09-16 19:27:19 +00:00
Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-04-05 14:19:24 +00:00
<method name= "is_playing_scene" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2020-07-18 15:17:00 +00:00
Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played.
2020-04-05 14:19:24 +00:00
</description>
</method>
2018-01-30 22:11:07 +00:00
<method name= "is_plugin_enabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "plugin" type= "String" >
</argument>
<description >
2020-07-18 15:17:00 +00:00
Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name.
2018-01-30 22:11:07 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "make_mesh_previews" >
<return type= "Array" >
</return>
2017-10-11 21:54:43 +00:00
<argument index= "0" name= "meshes" type= "Array" >
2017-09-12 20:42:36 +00:00
</argument>
2017-10-11 21:54:43 +00:00
<argument index= "1" name= "preview_size" type= "int" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-02-12 08:59:06 +00:00
Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "open_scene_from_path" >
<return type= "void" >
</return>
<argument index= "0" name= "scene_filepath" type= "String" >
</argument>
<description >
2017-10-12 17:10:42 +00:00
Opens the scene at the given path.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-04-05 14:19:24 +00:00
<method name= "play_current_scene" >
<return type= "void" >
</return>
<description >
Plays the currently active scene.
</description>
</method>
<method name= "play_custom_scene" >
<return type= "void" >
</return>
<argument index= "0" name= "scene_filepath" type= "String" >
</argument>
<description >
Plays the scene specified by its filepath.
</description>
</method>
<method name= "play_main_scene" >
<return type= "void" >
</return>
<description >
Plays the main scene.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "reload_scene_from_path" >
<return type= "void" >
</return>
<argument index= "0" name= "scene_filepath" type= "String" >
</argument>
<description >
2017-10-12 17:10:42 +00:00
Reloads the scene at the given path.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "save_scene" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-06-21 23:04:47 +00:00
Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "save_scene_as" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "String" >
</argument>
<argument index= "1" name= "with_preview" type= "bool" default= "true" >
</argument>
<description >
2017-10-12 17:10:42 +00:00
Saves the scene as a file at [code]path[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-01-07 00:37:45 +00:00
<method name= "select_file" >
<return type= "void" >
</return>
2018-12-27 10:10:09 +00:00
<argument index= "0" name= "file" type= "String" >
2018-01-07 00:37:45 +00:00
</argument>
<description >
2019-07-20 13:41:42 +00:00
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
2018-01-07 00:37:45 +00:00
</description>
</method>
2019-08-13 10:35:50 +00:00
<method name= "set_main_screen_editor" >
<return type= "void" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
2020-07-18 15:17:00 +00:00
Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]).
2019-08-13 10:35:50 +00:00
</description>
</method>
2018-01-30 22:11:07 +00:00
<method name= "set_plugin_enabled" >
<return type= "void" >
</return>
<argument index= "0" name= "plugin" type= "String" >
</argument>
<argument index= "1" name= "enabled" type= "bool" >
</argument>
<description >
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
</description>
</method>
2020-04-05 14:19:24 +00:00
<method name= "stop_playing_scene" >
<return type= "void" >
</return>
<description >
Stops the scene that is currently playing.
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
2020-06-04 08:07:56 +00:00
<members >
<member name= "distraction_free_mode" type= "bool" setter= "set_distraction_free_mode" getter= "is_distraction_free_mode_enabled" >
2020-05-30 20:55:56 +00:00
If [code]true[/code], enables distraction-free mode which hides side docks to increase the space available for the main view.
2020-06-04 08:07:56 +00:00
</member>
</members>
2017-09-12 20:42:36 +00:00
<constants >
</constants>
</class>
