diff options
author | Yuri Sizov <yuris@humnom.net> | 2023-04-05 17:14:46 +0200 |
---|---|---|
committer | Yuri Sizov <yuris@humnom.net> | 2023-04-17 21:59:09 +0200 |
commit | 49d7041d34e78bd6295b6a48b7c3fe1e7ba75bbc (patch) | |
tree | 8b0388466270fa20d7ab6f890a052ba363d54ed7 /doc/classes | |
parent | 055ee1276f097727d1c0ba3c1c25a12981c20bfa (diff) | |
download | redot-engine-49d7041d34e78bd6295b6a48b7c3fe1e7ba75bbc.tar.gz |
Decouple EditorInterface from EditorPlugin
- Simplify some includes in the process.
- Also exposes EditorInterface.movie_maker_enabled as a property.
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/EditorInterface.xml | 38 | ||||
-rw-r--r-- | doc/classes/EditorPlugin.xml | 2 | ||||
-rw-r--r-- | doc/classes/EditorSettings.xml | 2 |
3 files changed, 16 insertions, 26 deletions
diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 48939db1f7..74825493a1 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorInterface" inherits="Node" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> +<class name="EditorInterface" inherits="Object" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Godot editor's interface. </brief_description> @@ -34,7 +34,7 @@ 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. </description> </method> - <method name="get_base_control"> + <method name="get_base_control" qualifiers="const"> <return type="Control" /> <description> 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. @@ -60,20 +60,20 @@ Returns the current path being viewed in the [FileSystemDock]. </description> </method> - <method name="get_edited_scene_root"> + <method name="get_edited_scene_root" qualifiers="const"> <return type="Node" /> <description> Returns the edited (current) scene's root [Node]. </description> </method> - <method name="get_editor_main_screen"> + <method name="get_editor_main_screen" qualifiers="const"> <return type="VBoxContainer" /> <description> Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement [method EditorPlugin._has_main_screen]. [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> - <method name="get_editor_paths"> + <method name="get_editor_paths" qualifiers="const"> <return type="EditorPaths" /> <description> Returns the [EditorPaths] singleton. @@ -86,13 +86,13 @@ [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> - <method name="get_editor_settings"> + <method name="get_editor_settings" qualifiers="const"> <return type="EditorSettings" /> <description> Returns the editor's [EditorSettings] instance. </description> </method> - <method name="get_file_system_dock"> + <method name="get_file_system_dock" qualifiers="const"> <return type="FileSystemDock" /> <description> Returns the editor's [FileSystemDock] instance. @@ -118,19 +118,19 @@ Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. </description> </method> - <method name="get_resource_filesystem"> + <method name="get_resource_filesystem" qualifiers="const"> <return type="EditorFileSystem" /> <description> Returns the editor's [EditorFileSystem] instance. </description> </method> - <method name="get_resource_previewer"> + <method name="get_resource_previewer" qualifiers="const"> <return type="EditorResourcePreview" /> <description> Returns the editor's [EditorResourcePreview] instance. </description> </method> - <method name="get_script_editor"> + <method name="get_script_editor" qualifiers="const"> <return type="ScriptEditor" /> <description> Returns the editor's [ScriptEditor] instance. @@ -143,7 +143,7 @@ Returns an array containing the paths of the currently selected files (and directories) in the [FileSystemDock]. </description> </method> - <method name="get_selection"> + <method name="get_selection" qualifiers="const"> <return type="EditorSelection" /> <description> Returns the editor's [EditorSelection] instance. @@ -158,12 +158,6 @@ 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]. </description> </method> - <method name="is_movie_maker_enabled" qualifiers="const"> - <return type="bool" /> - <description> - Returns [code]true[/code] if Movie Maker mode is enabled in the editor. See also [method set_movie_maker_enabled]. See [MovieWriter] for more information. - </description> - </method> <method name="is_playing_scene" qualifiers="const"> <return type="bool" /> <description> @@ -253,13 +247,6 @@ 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]). </description> </method> - <method name="set_movie_maker_enabled"> - <return type="void" /> - <param index="0" name="enabled" type="bool" /> - <description> - Sets whether Movie Maker mode is enabled in the editor. See also [method is_movie_maker_enabled]. See [MovieWriter] for more information. - </description> - </method> <method name="set_plugin_enabled"> <return type="void" /> <param index="0" name="plugin" type="String" /> @@ -279,5 +266,8 @@ <member name="distraction_free_mode" type="bool" setter="set_distraction_free_mode" getter="is_distraction_free_mode_enabled"> If [code]true[/code], enables distraction-free mode which hides side docks to increase the space available for the main view. </member> + <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> </members> </class> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index a8ee5cdc19..1f3f028bbe 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -532,7 +532,7 @@ <method name="get_editor_interface"> <return type="EditorInterface" /> <description> - Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. + Returns the [EditorInterface] singleton. It provides access to some parts of the editor GUI as well as various inner states and tools. </description> </method> <method name="get_export_as_menu"> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 996af71c3b..85d5f7dd55 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -9,7 +9,7 @@ Accessing the settings can be done using the following methods, such as: [codeblocks] [gdscript] - var settings = EditorInterface.get_editor_settings() + var settings = get_editor_interface().get_editor_settings() # `settings.set("some/property", 10)` also works as this class overrides `_set()` internally. settings.set_setting("some/property", 10) # `settings.get("some/property")` also works as this class overrides `_get()` internally. |