2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "EditorInterface" inherits= "Node" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-09-18 16:38:19 +02:00
Godot editor's interface.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2018-09-18 16:38:19 +02: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 22:09:21 +02:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorPlugin.get_editor_interface].
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "edit_resource" >
<return type= "void" >
</return>
<argument index= "0" name= "resource" type= "Resource" >
</argument>
<description >
2017-10-12 19:10:42 +02:00
Edits the given [Resource].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_base_control" >
<return type= "Control" >
</return>
<description >
2018-09-18 16:38:19 +02:00
Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly.
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-09-24 11:44:48 +02:00
<method name= "get_current_path" qualifiers= "const" >
<return type= "String" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_edited_scene_root" >
<return type= "Node" >
</return>
<description >
2018-09-18 16:38:19 +02:00
Returns the edited (current) scene's root [Node].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_editor_settings" >
<return type= "EditorSettings" >
</return>
<description >
2017-10-12 19:10:42 +02:00
Returns the [EditorSettings].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_editor_viewport" >
<return type= "Control" >
</return>
<description >
2017-10-12 19:10:42 +02:00
Returns the editor [Viewport].
2017-09-12 22:42:36 +02:00
</description>
</method>
2020-03-20 12:58:38 +01:00
<method name= "get_file_system_dock" >
<return type= "FileSystemDock" >
</return>
<description >
</description>
</method>
2019-04-15 14:49:41 +02:00
<method name= "get_inspector" qualifiers= "const" >
<return type= "EditorInspector" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_open_scenes" qualifiers= "const" >
<return type= "Array" >
</return>
<description >
2018-09-18 16:38:19 +02:00
Returns an [Array] with the file paths of the currently opened scenes.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_resource_filesystem" >
<return type= "EditorFileSystem" >
</return>
<description >
2017-10-12 19:10:42 +02:00
Returns the [EditorFileSystem].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_resource_previewer" >
<return type= "EditorResourcePreview" >
</return>
<description >
2018-09-18 16:38:19 +02:00
Returns the [EditorResourcePreview].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_script_editor" >
<return type= "ScriptEditor" >
</return>
<description >
2017-10-12 19:10:42 +02:00
Returns the [ScriptEditor].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-01-07 01:37:45 +01:00
<method name= "get_selected_path" qualifiers= "const" >
<return type= "String" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_selection" >
<return type= "EditorSelection" >
</return>
<description >
2017-10-12 19:10:42 +02:00
Returns the [EditorSelection].
2017-09-12 22:42:36 +02: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>
<description >
2017-10-12 19:10:42 +02:00
Shows the given property on the given [code]object[/code] in the Editor's Inspector dock.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-01-30 23:11:07 +01:00
<method name= "is_plugin_enabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "plugin" type= "String" >
</argument>
<description >
Returns the enabled status of a plugin. The plugin name is the same as its directory name.
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "make_mesh_previews" >
<return type= "Array" >
</return>
2017-10-11 23:54:43 +02:00
<argument index= "0" name= "meshes" type= "Array" >
2017-09-12 22:42:36 +02:00
</argument>
2017-10-11 23:54:43 +02:00
<argument index= "1" name= "preview_size" type= "int" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
2020-02-12 09:59:06 +01:00
Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s.
2017-09-12 22:42:36 +02: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 19:10:42 +02:00
Opens the scene at the given path.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "reload_scene_from_path" >
<return type= "void" >
</return>
<argument index= "0" name= "scene_filepath" type= "String" >
</argument>
<description >
2017-10-12 19:10:42 +02:00
Reloads the scene at the given path.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "save_scene" >
<return type= "int" enum= "Error" >
</return>
<description >
2019-06-22 01:04:47 +02:00
Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants).
2017-09-12 22:42:36 +02: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 19:10:42 +02:00
Saves the scene as a file at [code]path[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-01-07 01:37:45 +01:00
<method name= "select_file" >
<return type= "void" >
</return>
2018-12-27 11:10:09 +01:00
<argument index= "0" name= "file" type= "String" >
2018-01-07 01:37:45 +01:00
</argument>
<description >
2019-07-20 15:41:42 +02:00
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
2018-01-07 01:37:45 +01:00
</description>
</method>
2019-08-13 12:35:50 +02:00
<method name= "set_main_screen_editor" >
<return type= "void" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
</description>
</method>
2018-01-30 23:11:07 +01: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>
2017-09-12 22:42:36 +02:00
</methods>
2020-06-04 10:07:56 +02:00
<members >
<member name= "distraction_free_mode" type= "bool" setter= "set_distraction_free_mode" getter= "is_distraction_free_mode_enabled" >
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
</constants>
</class>