From fb2e4d77ebad5877310b246ebc6279e8409cb6c0 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sat, 18 Jul 2020 17:17:00 +0200 Subject: [PATCH] Document several editor-related classes to 100% completion --- doc/classes/EditorFileSystem.xml | 1 + doc/classes/EditorFileSystemDirectory.xml | 2 ++ doc/classes/EditorImportPlugin.xml | 12 +++++++++++ doc/classes/EditorInspector.xml | 15 ++++++++++++- doc/classes/EditorInterface.xml | 26 ++++++++++++++--------- doc/classes/EditorNode3DGizmo.xml | 9 ++++++-- doc/classes/EditorNode3DGizmoPlugin.xml | 2 ++ doc/classes/EditorProperty.xml | 14 ++++++------ 8 files changed, 62 insertions(+), 19 deletions(-) diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 9bb51af2d0a..5461dccd270 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -97,6 +97,7 @@ + Emitted if at least one resource is reloaded when the filesystem is scanned. diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 096fe5df8fd..b852ae10634 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -67,6 +67,7 @@ + Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. @@ -75,6 +76,7 @@ + Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 0aac59c7276..ea2dfae9a58 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -83,6 +83,16 @@ + This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: + [codeblock] + func get_option_visibility(option, options): + # Only show the lossy quality setting if the compression mode is set to "Lossy". + if option == "compress/lossy_quality" and options.has("compress/mode"): + return int(options["compress/mode"]) == COMPRESS_LOSSY + + return true + [/codeblock] + Return [code]true[/code] to make all options always visible. @@ -150,6 +160,8 @@ + Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function. + This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index 2f62fe9e404..5fbe427f676 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -14,41 +14,50 @@ + Refreshes the inspector. + [b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.) - + + If [code]true[/code], horizontal scrolling is enabled. An horizontal scroll bar will display at the bottom of the inspector. + + Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector. + Emitted when a property is removed from the inspector. + Emitted when a property is edited in the inspector. + Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. + Emitted when a property is selected in the inspector. @@ -57,6 +66,8 @@ + Emitted when a boolean property is toggled in the inspector. + [b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. @@ -65,10 +76,12 @@ + Emitted when a resource is selected in the inspector. + Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings. diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 1d877e632e4..8b2b9c93503 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -23,13 +23,14 @@ - Returns the main container of Godot editor's window. You can use it, for example, to retrieve the size of the container and place your controls accordingly. + 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. + Returns the current path being viewed in the [FileSystemDock]. @@ -43,26 +44,29 @@ - Returns the [EditorSettings]. + Returns the editor's [EditorSettings] instance. - Returns the editor [Viewport]. + Returns the editor's [Viewport] instance. + [b]Note:[/b] This returns the main editor viewport containing the whole editor, not the 2D or 3D viewports specifically. + Returns the editor's [FileSystemDock] instance. + Returns the editor's [EditorInspector] instance. @@ -83,34 +87,35 @@ - Returns the [EditorFileSystem]. + Returns the editor's [EditorFileSystem] instance. - Returns the [EditorResourcePreview]. + Returns the editor's [EditorResourcePreview] instance. - Returns the [ScriptEditor]. + Returns the editor's [ScriptEditor] instance. + 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. - Returns the [EditorSelection]. + Returns the editor's [EditorSelection] instance. @@ -121,14 +126,14 @@ - Shows the given property on the given [code]object[/code] in the Editor's Inspector dock. + Shows the given property on the given [code]object[/code] in the editor's Inspector dock. - Returns [code]true[/code], if a scene is currently being played; [code]false[/code] otherwise. Paused scenes are considered as being played. + Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played. @@ -137,7 +142,7 @@ - Returns the enabled status of a plugin. The plugin name is the same as its directory name. + Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name. @@ -225,6 +230,7 @@ + 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]). diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index 6d695ddeea0..45541b9263d 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -15,6 +15,7 @@ + Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method redraw]. @@ -69,6 +70,7 @@ + Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method redraw]. @@ -88,6 +90,7 @@ + Removes everything in the gizmo including meshes, collisions and handles. @@ -143,14 +146,14 @@ - Gets whether a handle is highlighted or not. + Returns [code]true[/code] if the handle at index [code]index[/code] is highlighted by being hovered with the mouse. - This function is called when the Node3D this gizmo refers to changes (the [method Node3D.update_gizmo] is called). + This function is called when the [Node3D] this gizmo refers to changes (the [method Node3D.update_gizmo] is called). @@ -173,6 +176,7 @@ + Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown. @@ -181,6 +185,7 @@ + Sets the reference [Node3D] node for the gizmo. [code]node[/code] must inherit from [Node3D]. diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index ca75b47fbf0..b81281b5b62 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -139,6 +139,8 @@ + Override this method to set the gizmo's priority. Higher values correspond to higher priority. If a gizmo with higher priority conflicts with another gizmo, only the gizmo with higher priority will be used. + All built-in editor gizmos return a priority of [code]-1[/code]. If not overridden, this method will return [code]0[/code], which means custom gizmos will automatically override built-in gizmos. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 4da3b58b944..f568263ff8c 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -73,24 +73,25 @@ - Used by the inspector, set when property is checkable. + Used by the inspector, set to [code]true[/code] when the property is checkable. - Used by the inspector, when the property is checked. + Used by the inspector, set to [code]true[/code] when the property is checked. + Used by the inspector, set to [code]true[/code] when the property can be deleted by the user. - Used by the inspector, when the property must draw with error color. + Used by the inspector, set to [code]true[/code] when the property must draw with error color. This is used for editable children's properties. - Used by the inspector, when the property can add keys for animation. + Used by the inspector, set to [code]true[/code] when the property can add keys for animation. - Sets this property to change the label (if you want to show one). + Set this property to change the label (if you want to show one). - Used by the inspector, when the property is read-only. + Used by the inspector, set to [code]true[/code] when the property is read-only. @@ -134,6 +135,7 @@ + Emitted when a property was deleted. Used internally.