2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 12:40:43 +00:00
<class name= "EditorInterface" inherits= "Node" category= "Core" version= "3.1" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-10-12 17:10:42 +00:00
Editor interface and main components.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2018-05-16 15:23:20 +00:00
Editor interface. Allows 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, as well as information about scenes. Also see [EditorPlugin] and [EditorScript].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<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 >
2017-10-12 17:10:42 +00:00
Returns the base [Control].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_edited_scene_root" >
<return type= "Node" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the edited scene's root [Node].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_editor_settings" >
<return type= "EditorSettings" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the [EditorSettings].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_editor_viewport" >
<return type= "Control" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the editor [Viewport].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_open_scenes" qualifiers= "const" >
<return type= "Array" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns an [Array] of the currently opened scenes.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_resource_filesystem" >
<return type= "EditorFileSystem" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the [EditorFileSystem].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_resource_previewer" >
<return type= "EditorResourcePreview" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the [EditorResourcePreview]\ er.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_script_editor" >
<return type= "ScriptEditor" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the [ScriptEditor].
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 >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_selection" >
<return type= "EditorSelection" >
</return>
<description >
2017-10-12 17:10:42 +00:00
Returns the [EditorSelection].
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>
<description >
2017-10-12 17:10:42 +00:00
Shows the given property on the given [code]object[/code] in the Editor's Inspector dock.
2017-09-12 20:42:36 +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 >
Returns the enabled status of a plugin. The plugin name is the same as its directory name.
</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 >
2017-10-21 10:33:50 +00:00
Returns mesh previews rendered at the given size as an [Array] of [Texture]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>
<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 >
2017-11-15 17:45:34 +00:00
Saves the scene. Returns either OK or ERR_CANT_CREATE. 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>
<argument index= "0" name= "p_file" type= "String" >
</argument>
<description >
</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>
2017-09-12 20:42:36 +00:00
</methods>
<constants >
</constants>
</class>
