mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
63a9188ddb
godot/doc/classes/EditorInterface.xml

258 lines
10 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="EditorInterface" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 22:38:19 +08:00
Godot editor's interface.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</brief_description>
<description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 22:38:19 +08: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.
Document how some editor classes should be accessed as singletons only This closes #37687.
2020-04-15 04:09:21 +08:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorPlugin.get_editor_interface].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
<methods>
Expose edit_node() for editor plugins
2021-04-08 04:08:41 +08:00
<method name="edit_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="node" type="Node" />
Expose edit_node() for editor plugins
2021-04-08 04:08:41 +08:00
<description>
Edits the given [Node]. The node will be also selected if it's inside the scene tree.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="edit_resource">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="resource" type="Resource" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Expose `ScriptEditor::edit` to scripting Exposes a method in `EditorInterface` to open scripts on a specified line and column. This method handles if the internal or the external editor should be used.
2021-12-08 04:00:26 +08:00
Edits the given [Resource]. If the resource is a [Script] you can also edit it with [method edit_script] to specify the line and column position.
</description>
</method>
<method name="edit_script">
<return type="void" />
<argument index="0" name="script" type="Script" />
<argument index="1" name="line" type="int" default="-1" />
<argument index="2" name="column" type="int" default="0" />
<argument index="3" name="grab_focus" type="bool" default="true" />
<description>
Edits the given [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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_base_control">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Control" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08: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.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render the editor useless and may cause a crash.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Added EditorCommandPalette
2021-05-29 21:28:16 +08:00
<method name="get_command_palette" qualifiers="const">
<return type="EditorCommandPalette" />
<description>
`EditorCommandPalette` Documentation.
2021-08-13 17:04:01 +08:00
Returns the editor's [EditorCommandPalette] instance.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
Added EditorCommandPalette
2021-05-29 21:28:16 +08:00
</description>
</method>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<method name="get_current_path" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="String" />
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the current path being viewed in the [FileSystemDock].
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="get_edited_scene_root">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Node" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 22:38:19 +08:00
Returns the edited (current) scene's root [Node].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename EditorInterface get_editor_viewport to get_editor_main_control
2020-12-19 22:17:42 +08:00
<method name="get_editor_main_control">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Control" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Improve the `EditorInterface.get_editor_viewport()` description This closes https://github.com/godotengine/godot-docs/issues/1109.
2020-07-30 18:21:49 +08: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.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Implement shader caching * Shader compilation is now cached. Subsequent loads take less than a millisecond. * Improved game, editor and project manager startup time. * Editor uses .godot/shader_cache to store shaders. * Game uses user://shader_cache * Project manager uses $config_dir/shader_cache * Options to tweak shader caching in project settings. * Editor path configuration moved from EditorSettings to new class, EditorPaths, so it can be available early on (before shaders are compiled). * Reworked ShaderCompilerRD to ensure deterministic shader code creation (else shader may change and cache will be invalidated). * Added shader compression with SMOLV: https://github.com/aras-p/smol-v
2021-05-25 08:25:11 +08:00
<method name="get_editor_paths">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorPaths" />
Implement shader caching * Shader compilation is now cached. Subsequent loads take less than a millisecond. * Improved game, editor and project manager startup time. * Editor uses .godot/shader_cache to store shaders. * Game uses user://shader_cache * Project manager uses $config_dir/shader_cache * Options to tweak shader caching in project settings. * Editor path configuration moved from EditorSettings to new class, EditorPaths, so it can be available early on (before shaders are compiled). * Reworked ShaderCompilerRD to ensure deterministic shader code creation (else shader may change and cache will be invalidated). * Added shader compression with SMOLV: https://github.com/aras-p/smol-v
2021-05-25 08:25:11 +08:00
<description>
</description>
</method>
Expose editor scale to the plugin API
2021-04-04 22:08:25 +08:00
<method name="get_editor_scale" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
Expose editor scale to the plugin API
2021-04-04 22:08:25 +08:00
<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>
doc: Sync classref with current source
2021-01-04 21:33:44 +08:00
<method name="get_editor_settings">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorSettings" />
doc: Sync classref with current source
2021-01-04 21:33:44 +08:00
<description>
Returns the editor's [EditorSettings] instance.
</description>
</method>
i18n: Generate translation template for class reference
2020-03-20 19:58:38 +08:00
<method name="get_file_system_dock">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="FileSystemDock" />
i18n: Generate translation template for class reference
2020-03-20 19:58:38 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [FileSystemDock] instance.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
i18n: Generate translation template for class reference
2020-03-20 19:58:38 +08:00
</description>
</method>
doc: Sync classref with current source
2019-04-15 20:49:41 +08:00
<method name="get_inspector" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorInspector" />
doc: Sync classref with current source
2019-04-15 20:49:41 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [EditorInspector] instance.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
doc: Sync classref with current source
2019-04-15 20:49:41 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="get_open_scenes" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 22:38:19 +08:00
Returns an [Array] with the file paths of the currently opened scenes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<method name="get_playing_scene" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="String" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="get_resource_filesystem">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorFileSystem" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [EditorFileSystem] instance.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_resource_previewer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorResourcePreview" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [EditorResourcePreview] instance.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_script_editor">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="ScriptEditor" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [ScriptEditor] instance.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
<method name="get_selected_path" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="String" />
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08: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.
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="get_selection">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="EditorSelection" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns the editor's [EditorSelection] instance.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="inspect_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="for_property" type="String" default="&quot;&quot;" />
<argument index="2" name="inspector_only" type="bool" default="false" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Added inspector_only option to inspect_object in EditorInterface. Updated docs to reflect change to inspect_object.
2020-09-17 03:27:19 +08: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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<method name="is_playing_scene" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played.
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
</description>
</method>
Add interface for plugins to enable/disable other plugins
2018-01-31 06:11:07 +08:00
<method name="is_plugin_enabled" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="plugin" type="String" />
Add interface for plugins to enable/disable other plugins
2018-01-31 06:11:07 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08:00
Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name.
Add interface for plugins to enable/disable other plugins
2018-01-31 06:11:07 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="make_mesh_previews">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Array" />
<argument index="0" name="meshes" type="Array" />
<argument index="1" name="preview_size" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="open_scene_from_path">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="scene_filepath" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[DOCS] EditorInterface
2017-10-13 01:10:42 +08:00
Opens the scene at the given path.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<method name="play_current_scene">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Plays the currently active scene.
</description>
</method>
<method name="play_custom_scene">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="scene_filepath" type="String" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Plays the scene specified by its filepath.
</description>
</method>
<method name="play_main_scene">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Plays the main scene.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="reload_scene_from_path">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="scene_filepath" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[DOCS] EditorInterface
2017-10-13 01:10:42 +08:00
Reloads the scene at the given path.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="save_scene">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" enum="Error" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="save_scene_as">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="with_preview" type="bool" default="true" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[DOCS] EditorInterface
2017-10-13 01:10:42 +08:00
Saves the scene as a file at [code]path[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
<method name="select_file">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="file" type="String" />
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
<description>
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 21:41:42 +08:00
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
doc: Sync classref with current source
2018-01-07 08:37:45 +08:00
</description>
</method>
doc: Sync classref with current source
2019-08-13 18:35:50 +08:00
<method name="set_main_screen_editor">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="name" type="String" />
doc: Sync classref with current source
2019-08-13 18:35:50 +08:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 23:17:00 +08: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]).
doc: Sync classref with current source
2019-08-13 18:35:50 +08:00
</description>
</method>
Add interface for plugins to enable/disable other plugins
2018-01-31 06:11:07 +08:00
<method name="set_plugin_enabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="plugin" type="String" />
<argument index="1" name="enabled" type="bool" />
Add interface for plugins to enable/disable other plugins
2018-01-31 06:11:07 +08:00
<description>
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<method name="stop_playing_scene">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 22:19:24 +08:00
<description>
Stops the scene that is currently playing.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</methods>
doc: Sync classref with current source
2020-06-04 16:07:56 +08:00
<members>
<member name="distraction_free_mode" type="bool" setter="set_distraction_free_mode" getter="is_distraction_free_mode_enabled">
Keep the bottom panel visible when enabling the distraction-free mode - Document the `EditorInterface.distraction_free_mode` property. This closes https://github.com/godotengine/godot-proposals/issues/951.
2020-05-31 04:55:56 +08:00
If [code]true[/code], enables distraction-free mode which hides side docks to increase the space available for the main view.
doc: Sync classref with current source
2020-06-04 16:07:56 +08:00
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</class>
Reference in New Issue Copy Permalink