summaryrefslogtreecommitdiff
path: root/doc/classes/EditorInterface.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:28:05 +0200
committerRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:29:52 +0200
commit7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch)
tree0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/EditorInterface.xml
parenta1c19b9a1e53f78c75c13cb418270db80057b21a (diff)
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.
Diffstat (limited to 'doc/classes/EditorInterface.xml')
-rw-r--r--doc/classes/EditorInterface.xml150
1 files changed, 50 insertions, 100 deletions
diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml
index 3f324bf1a0..185b4f8c39 100644
--- a/doc/classes/EditorInterface.xml
+++ b/doc/classes/EditorInterface.xml
@@ -11,267 +11,217 @@
</tutorials>
<methods>
<method name="edit_node">
- <return type="void">
- </return>
- <argument index="0" name="node" type="Node">
- </argument>
+ <return type="void" />
+ <argument index="0" name="node" type="Node" />
<description>
Edits the given [Node]. The node will be also selected if it's inside the scene tree.
</description>
</method>
<method name="edit_resource">
- <return type="void">
- </return>
- <argument index="0" name="resource" type="Resource">
- </argument>
+ <return type="void" />
+ <argument index="0" name="resource" type="Resource" />
<description>
Edits the given [Resource].
</description>
</method>
<method name="get_base_control">
- <return type="Control">
- </return>
+ <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.
</description>
</method>
<method name="get_current_path" qualifiers="const">
- <return type="String">
- </return>
+ <return type="String" />
<description>
Returns the current path being viewed in the [FileSystemDock].
</description>
</method>
<method name="get_edited_scene_root">
- <return type="Node">
- </return>
+ <return type="Node" />
<description>
Returns the edited (current) scene's root [Node].
</description>
</method>
<method name="get_editor_main_control">
- <return type="Control">
- </return>
+ <return type="Control" />
<description>
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.
</description>
</method>
<method name="get_editor_paths">
- <return type="EditorPaths">
- </return>
+ <return type="EditorPaths" />
<description>
</description>
</method>
<method name="get_editor_scale" qualifiers="const">
- <return type="float">
- </return>
+ <return type="float" />
<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>
<method name="get_editor_settings">
- <return type="EditorSettings">
- </return>
+ <return type="EditorSettings" />
<description>
Returns the editor's [EditorSettings] instance.
</description>
</method>
<method name="get_file_system_dock">
- <return type="FileSystemDock">
- </return>
+ <return type="FileSystemDock" />
<description>
Returns the editor's [FileSystemDock] instance.
</description>
</method>
<method name="get_inspector" qualifiers="const">
- <return type="EditorInspector">
- </return>
+ <return type="EditorInspector" />
<description>
Returns the editor's [EditorInspector] instance.
</description>
</method>
<method name="get_open_scenes" qualifiers="const">
- <return type="Array">
- </return>
+ <return type="Array" />
<description>
Returns an [Array] with the file paths of the currently opened scenes.
</description>
</method>
<method name="get_playing_scene" qualifiers="const">
- <return type="String">
- </return>
+ <return type="String" />
<description>
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">
- <return type="EditorFileSystem">
- </return>
+ <return type="EditorFileSystem" />
<description>
Returns the editor's [EditorFileSystem] instance.
</description>
</method>
<method name="get_resource_previewer">
- <return type="EditorResourcePreview">
- </return>
+ <return type="EditorResourcePreview" />
<description>
Returns the editor's [EditorResourcePreview] instance.
</description>
</method>
<method name="get_script_editor">
- <return type="ScriptEditor">
- </return>
+ <return type="ScriptEditor" />
<description>
Returns the editor's [ScriptEditor] instance.
</description>
</method>
<method name="get_selected_path" qualifiers="const">
- <return type="String">
- </return>
+ <return type="String" />
<description>
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.
</description>
</method>
<method name="get_selection">
- <return type="EditorSelection">
- </return>
+ <return type="EditorSelection" />
<description>
Returns the editor's [EditorSelection] instance.
</description>
</method>
<method name="inspect_object">
- <return type="void">
- </return>
- <argument index="0" name="object" type="Object">
- </argument>
- <argument index="1" name="for_property" type="String" default="&quot;&quot;">
- </argument>
- <argument index="2" name="inspector_only" type="bool" default="false">
- </argument>
+ <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" />
<description>
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].
</description>
</method>
<method name="is_playing_scene" qualifiers="const">
- <return type="bool">
- </return>
+ <return type="bool" />
<description>
Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played.
</description>
</method>
<method name="is_plugin_enabled" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="plugin" type="String">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="plugin" type="String" />
<description>
Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name.
</description>
</method>
<method name="make_mesh_previews">
- <return type="Array">
- </return>
- <argument index="0" name="meshes" type="Array">
- </argument>
- <argument index="1" name="preview_size" type="int">
- </argument>
+ <return type="Array" />
+ <argument index="0" name="meshes" type="Array" />
+ <argument index="1" name="preview_size" type="int" />
<description>
Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s.
</description>
</method>
<method name="open_scene_from_path">
- <return type="void">
- </return>
- <argument index="0" name="scene_filepath" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="scene_filepath" type="String" />
<description>
Opens the scene at the given path.
</description>
</method>
<method name="play_current_scene">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Plays the currently active scene.
</description>
</method>
<method name="play_custom_scene">
- <return type="void">
- </return>
- <argument index="0" name="scene_filepath" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="scene_filepath" type="String" />
<description>
Plays the scene specified by its filepath.
</description>
</method>
<method name="play_main_scene">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Plays the main scene.
</description>
</method>
<method name="reload_scene_from_path">
- <return type="void">
- </return>
- <argument index="0" name="scene_filepath" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="scene_filepath" type="String" />
<description>
Reloads the scene at the given path.
</description>
</method>
<method name="save_scene">
- <return type="int" enum="Error">
- </return>
+ <return type="int" enum="Error" />
<description>
Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants).
</description>
</method>
<method name="save_scene_as">
- <return type="void">
- </return>
- <argument index="0" name="path" type="String">
- </argument>
- <argument index="1" name="with_preview" type="bool" default="true">
- </argument>
+ <return type="void" />
+ <argument index="0" name="path" type="String" />
+ <argument index="1" name="with_preview" type="bool" default="true" />
<description>
Saves the scene as a file at [code]path[/code].
</description>
</method>
<method name="select_file">
- <return type="void">
- </return>
- <argument index="0" name="file" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="file" type="String" />
<description>
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
</description>
</method>
<method name="set_main_screen_editor">
- <return type="void">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="name" type="String" />
<description>
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]).
</description>
</method>
<method name="set_plugin_enabled">
- <return type="void">
- </return>
- <argument index="0" name="plugin" type="String">
- </argument>
- <argument index="1" name="enabled" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="plugin" type="String" />
+ <argument index="1" name="enabled" type="bool" />
<description>
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
</description>
</method>
<method name="stop_playing_scene">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Stops the scene that is currently playing.
</description>