asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/EditorInterface.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

349 lines
15 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-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="EditorInterface" inherits="Object" 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-12 22:42:36 +02:00
<brief_description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02: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-12 22:42:36 +02:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +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.
Make EditorInterface accessible as a singleton - EditorPlugin.get_editor_interface() is removed as redundant.
2023-08-09 14:03:27 +02:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton directly by its name.
[codeblocks]
[gdscript]
var editor_settings = EditorInterface.get_editor_settings()
[/gdscript]
[csharp]
// In C# you can access it via the static Singleton property.
EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();
[/csharp]
[/codeblocks]
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-12 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
Expose edit_node() for editor plugins
2021-04-07 22:08:41 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="node" type="Node" />
Expose edit_node() for editor plugins
2021-04-07 22:08:41 +02: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-12 22:42:36 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param 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-12 22:42:36 +02: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-07 21:00:26 +01: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" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="script" type="Script" />
<param index="1" name="line" type="int" default="-1" />
<param index="2" name="column" type="int" default="0" />
<param index="3" name="grab_focus" type="bool" default="true" />
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-07 21:00:26 +01:00
<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-12 22:42:36 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_base_control" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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-10 21:28:56 +02: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-12 22:42:36 +02:00
</description>
</method>
Added EditorCommandPalette
2021-05-29 15:28:16 +02:00
<method name="get_command_palette" qualifiers="const">
<return type="EditorCommandPalette" />
<description>
`EditorCommandPalette` Documentation.
2021-08-13 11:04:01 +02:00
Returns the editor's [EditorCommandPalette] instance.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02: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 15:28:16 +02:00
</description>
</method>
Add EditorInterface.get_selected_paths() Exposes the selected paths in the editor filesystem dock. Implements this proposal : https://github.com/godotengine/godot-proposals/issues/2424 Also renamed the old `get_selected_path` to `get_selected_directory` to better match the already existing get_current_path function.
2022-05-10 22:25:36 +02:00
<method name="get_current_directory" qualifiers="const">
<return type="String" />
<description>
Returns the current directory being viewed in the [FileSystemDock]. If a file is selected, its base directory will be returned using [method String.get_base_dir] instead.
</description>
</method>
Allow changing feature profile via EditorInterface
2023-03-04 20:27:56 +01:00
<method name="get_current_feature_profile" qualifiers="const">
<return type="String" />
<description>
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 [EditorFeatureProfile], you must load the feature profile using [method EditorFeatureProfile.load_from_file].
[b]Note:[/b] Feature profiles created via the user interface are loaded from the [code]feature_profiles[/code] directory, as a file with the [code].profile[/code] extension. The editor configuration folder can be found by using [method EditorPaths.get_config_dir].
</description>
</method>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:44:48 +02: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 15:28:05 +02: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 11:44:48 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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 11:44:48 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_edited_scene_root" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02: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-12 22:42:36 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_editor_main_screen" qualifiers="const">
Rename EditorInterface.get_editor_main_control to get_editor_main_screen
2022-09-07 01:30:54 +02:00
<return type="VBoxContainer" />
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-12 22:42:36 +02:00
<description>
Rename EditorInterface.get_editor_main_control to get_editor_main_screen
2022-09-07 01:30:54 +02:00
Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement [method EditorPlugin._has_main_screen].
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02: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-12 22:42:36 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_editor_paths" 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 15:28:05 +02: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 02:25:11 +02:00
<description>
Fill random docs
2022-10-06 21:59:48 +02:00
Returns the [EditorPaths] singleton.
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 02:25:11 +02:00
</description>
</method>
Expose editor scale to the plugin API
2021-04-04 16:08:25 +02: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 15:28:05 +02:00
<return type="float" />
Expose editor scale to the plugin API
2021-04-04 16:08:25 +02: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>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_editor_settings" 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 15:28:05 +02:00
<return type="EditorSettings" />
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
<description>
Returns the editor's [EditorSettings] instance.
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_file_system_dock" 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 15:28:05 +02:00
<return type="FileSystemDock" />
i18n: Generate translation template for class reference
2020-03-20 12:58:38 +01:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02:00
Returns the editor's [FileSystemDock] instance.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02: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 12:58:38 +01:00
</description>
</method>
doc: Sync classref with current source
2019-04-15 14:49:41 +02: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 15:28:05 +02:00
<return type="EditorInspector" />
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02:00
Returns the editor's [EditorInspector] instance.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02: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 14:49:41 +02: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-12 22:42:36 +02:00
<method name="get_open_scenes" qualifiers="const">
Replace Array return types with TypedArray
2022-08-05 03:41:48 +02:00
<return type="PackedStringArray" />
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-12 22:42:36 +02:00
<description>
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02: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-12 22:42:36 +02:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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 15:28:05 +02:00
<return type="String" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_resource_filesystem" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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-12 22:42:36 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_resource_previewer" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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-12 22:42:36 +02:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_script_editor" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02:00
Returns the editor's [ScriptEditor] instance.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02: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-12 22:42:36 +02:00
</description>
</method>
Add EditorInterface.get_selected_paths() Exposes the selected paths in the editor filesystem dock. Implements this proposal : https://github.com/godotengine/godot-proposals/issues/2424 Also renamed the old `get_selected_path` to `get_selected_directory` to better match the already existing get_current_path function.
2022-05-10 22:25:36 +02:00
<method name="get_selected_paths" qualifiers="const">
<return type="PackedStringArray" />
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
<description>
Add EditorInterface.get_selected_paths() Exposes the selected paths in the editor filesystem dock. Implements this proposal : https://github.com/godotengine/godot-proposals/issues/2424 Also renamed the old `get_selected_path` to `get_selected_directory` to better match the already existing get_current_path function.
2022-05-10 22:25:36 +02:00
Returns an array containing the paths of the currently selected files (and directories) in the [FileSystemDock].
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
</description>
</method>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<method name="get_selection" 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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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-12 22:42:36 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="object" type="Object" />
<param index="1" name="for_property" type="String" default="&quot;&quot;" />
<param 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-12 22:42:36 +02:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 18:07:53 +02:00
Shows the given property on the given [param object] in the editor's Inspector dock. If [param inspector_only] is [code]true[/code], plugins will not attempt to edit [param object].
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-12 22:42:36 +02:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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 15:28:05 +02:00
<return type="bool" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02:00
<description>
Document several editor-related classes to 100% completion
2020-07-18 17:17:00 +02: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 16:19:24 +02:00
</description>
</method>
Add interface for plugins to enable/disable other plugins
2018-01-30 23:11:07 +01: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 15:28:05 +02:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="plugin" type="String" />
Add interface for plugins to enable/disable other plugins
2018-01-30 23:11:07 +01:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 18:07:53 +02:00
Returns [code]true[/code] if the specified [param plugin] is enabled. The plugin name is the same as its directory name.
Add interface for plugins to enable/disable other plugins
2018-01-30 23:11:07 +01: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-12 22:42:36 +02:00
<method name="make_mesh_previews">
Replace Array return types with TypedArray
2022-08-05 03:41:48 +02:00
<return type="Texture2D[]" />
Change Array arguments to TypedArray
2022-08-31 19:24:04 +02:00
<param index="0" name="meshes" type="Mesh[]" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param 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-12 22:42:36 +02: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 09:59:06 +01: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-12 22:42:36 +02:00
</description>
</method>
Let editor workaround a case of inconsistency in compound scenes
2023-06-07 13:44:37 +02:00
<method name="mark_scene_as_unsaved">
<return type="void" />
<description>
Marks the current scene tab as unsaved.
</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-12 22:42:36 +02:00
<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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param 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-12 22:42:36 +02:00
<description>
[DOCS] EditorInterface
2017-10-12 19:10:42 +02: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-12 22:42:36 +02:00
</description>
</method>
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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 15:28:05 +02:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="scene_filepath" type="String" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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 15:28:05 +02:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02:00
<description>
Plays the main scene.
</description>
</method>
Expose dialog parent-and-popup logic to the API
2023-04-20 15:13:21 +02:00
<method name="popup_dialog">
<return type="void" />
<param index="0" name="dialog" type="Window" />
<param index="1" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" />
<description>
Pops up the [param dialog] in the editor UI with [method Window.popup_exclusive]. The dialog must have no current parent, otherwise the method fails.
See also [method Window.set_unparent_when_invisible].
</description>
</method>
<method name="popup_dialog_centered">
<return type="void" />
<param index="0" name="dialog" type="Window" />
<param index="1" name="minsize" type="Vector2i" default="Vector2i(0, 0)" />
<description>
Pops up the [param dialog] in the editor UI with [method Window.popup_exclusive_centered]. The dialog must have no current parent, otherwise the method fails.
See also [method Window.set_unparent_when_invisible].
</description>
</method>
<method name="popup_dialog_centered_clamped">
<return type="void" />
<param index="0" name="dialog" type="Window" />
<param index="1" name="minsize" type="Vector2i" default="Vector2i(0, 0)" />
<param index="2" name="fallback_ratio" type="float" default="0.75" />
<description>
Pops up the [param dialog] in the editor UI with [method Window.popup_exclusive_centered_clamped]. The dialog must have no current parent, otherwise the method fails.
See also [method Window.set_unparent_when_invisible].
</description>
</method>
<method name="popup_dialog_centered_ratio">
<return type="void" />
<param index="0" name="dialog" type="Window" />
<param index="1" name="ratio" type="float" default="0.8" />
<description>
Pops up the [param dialog] in the editor UI with [method Window.popup_exclusive_centered_ratio]. The dialog must have no current parent, otherwise the method fails.
See also [method Window.set_unparent_when_invisible].
</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-12 22:42:36 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param 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-12 22:42:36 +02:00
<description>
[DOCS] EditorInterface
2017-10-12 19:10:42 +02: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-12 22:42:36 +02:00
</description>
</method>
Add a method for restarting the editor to EditorInterface
2022-08-19 01:46:31 +02:00
<method name="restart_editor">
<return type="void" />
<param index="0" name="save" type="bool" default="true" />
<description>
Restarts the editor. This closes the editor and then opens the same project. If [param save] is [code]true[/code], the project will be saved before restarting.
</description>
</method>
Add `save_all_scenes` method to Editor Interface Update documentation (squash) fix docs (squash) Improve docs
2023-05-27 04:23:06 +02:00
<method name="save_all_scenes">
<return type="void" />
<description>
Saves all opened scenes in the editor.
</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-12 22:42:36 +02:00
<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 15:28:05 +02: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-12 22:42:36 +02:00
<description>
Add `save_all_scenes` method to Editor Interface Update documentation (squash) fix docs (squash) Improve docs
2023-05-27 04:23:06 +02:00
Saves the currently active scene. Returns either [constant OK] or [constant ERR_CANT_CREATE].
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-12 22:42:36 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="path" type="String" />
<param 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-12 22:42:36 +02:00
<description>
Add `save_all_scenes` method to Editor Interface Update documentation (squash) fix docs (squash) Improve docs
2023-05-27 04:23:06 +02:00
Saves the currently active scene as a file at [param 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-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-01-07 01:37:45 +01: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="file" type="String" />
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 18:07:53 +02:00
Selects the file, with the path provided by [param file], in the FileSystem dock.
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
</description>
</method>
Allow changing feature profile via EditorInterface
2023-03-04 20:27:56 +01:00
<method name="set_current_feature_profile">
<return type="void" />
<param index="0" name="profile_name" type="String" />
<description>
Selects and activates the specified feature profile with the given [param profile_name]. Set [param profile_name] to an empty string to reset to the default feature profile.
A feature profile can be created programmatically using the [EditorFeatureProfile] class.
[b]Note:[/b] The feature profile that gets activated must be located in the [code]feature_profiles[/code] directory, as a file with the [code].profile[/code] extension. If a profile could not be found, an error occurs. The editor configuration folder can be found by using [method EditorPaths.get_config_dir].
</description>
</method>
doc: Sync classref with current source
2019-08-13 12:35:50 +02: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="name" type="String" />
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 18:07:53 +02:00
Sets the editor's current main screen to the one specified in [param name]. [param name] 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 12:35:50 +02:00
</description>
</method>
Add interface for plugins to enable/disable other plugins
2018-01-30 23:11:07 +01: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 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="plugin" type="String" />
<param index="1" name="enabled" type="bool" />
Add interface for plugins to enable/disable other plugins
2018-01-30 23:11:07 +01: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 16:19:24 +02: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 15:28:05 +02:00
<return type="void" />
Expose methods to play scene from plugin code
2020-04-05 16:19:24 +02: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-12 22:42:36 +02:00
</methods>
doc: Sync classref with current source
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">
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-30 22:55:56 +02: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 10:07:56 +02:00
</member>
Decouple EditorInterface from EditorPlugin - Simplify some includes in the process. - Also exposes EditorInterface.movie_maker_enabled as a property.
2023-04-05 17:14:46 +02:00
<member name="movie_maker_enabled" type="bool" setter="set_movie_maker_enabled" getter="is_movie_maker_enabled">
If [code]true[/code], the Movie Maker mode is enabled in the editor. See [MovieWriter] for more information.
</member>
doc: Sync classref with current source
2020-06-04 10:07:56 +02:00
</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-12 22:42:36 +02:00
</class>
Reference in a new issue Copy permalink