From 3739f03d9883a60322fb4c57f9c30a3572e57be3 Mon Sep 17 00:00:00 2001 From: Tomasz Chabora Date: Tue, 3 Mar 2020 19:21:21 +0100 Subject: [PATCH] Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98) --- doc/classes/Animation.xml | 29 ++++++++++++++++++++++++- doc/classes/AnimationNodeBlendTree.xml | 18 +++++++++++++++ doc/classes/AnimationNodeOneShot.xml | 5 +++++ doc/classes/AnimationNodeOutput.xml | 1 + doc/classes/AnimationNodeTimeScale.xml | 2 ++ doc/classes/AnimationNodeTimeSeek.xml | 2 ++ doc/classes/AnimationNodeTransition.xml | 4 ++++ doc/classes/AnimationTree.xml | 9 ++++++++ doc/classes/AudioEffectRecord.xml | 6 +++++ doc/classes/CollisionPolygon2D.xml | 1 + doc/classes/CollisionShape2D.xml | 2 +- doc/classes/ColorPicker.xml | 8 +++++++ doc/classes/EditorExportPlugin.xml | 3 +++ doc/classes/EditorFileDialog.xml | 1 + doc/classes/EditorFileSystem.xml | 1 + doc/classes/FileDialog.xml | 6 +++++ doc/classes/Font.xml | 1 + doc/classes/GraphEdit.xml | 11 ++++++++++ doc/classes/GraphNode.xml | 17 +++++++++++++++ doc/classes/GridContainer.xml | 2 ++ doc/classes/HSeparator.xml | 2 ++ doc/classes/HSlider.xml | 6 +++++ doc/classes/HSplitContainer.xml | 3 +++ doc/classes/HingeJoint.xml | 4 ++++ doc/classes/InputEventGesture.xml | 2 ++ doc/classes/PackedDataContainerRef.xml | 1 + doc/classes/Panel.xml | 1 + doc/classes/PanelContainer.xml | 1 + doc/classes/PinJoint.xml | 2 ++ doc/classes/Polygon2D.xml | 8 +++++++ doc/classes/PopupPanel.xml | 1 + doc/classes/ProgressBar.xml | 5 +++++ doc/classes/RichTextLabel.xml | 17 +++++++++++++++ doc/classes/Script.xml | 5 +++++ doc/classes/ScriptEditor.xml | 1 + doc/classes/SpriteBase3D.xml | 3 +++ doc/classes/StreamPeerSSL.xml | 2 ++ doc/classes/StreamTexture.xml | 1 + doc/classes/TabContainer.xml | 16 ++++++++++++++ doc/classes/Tabs.xml | 15 +++++++++++++ doc/classes/Tree.xml | 1 + doc/classes/VSeparator.xml | 2 ++ doc/classes/VSlider.xml | 6 +++++ doc/classes/VSplitContainer.xml | 3 +++ doc/classes/VisualShader.xml | 17 +++++++++++++++ doc/classes/VisualShaderNode.xml | 1 + doc/classes/WindowDialog.xml | 9 ++++++++ 47 files changed, 262 insertions(+), 2 deletions(-) diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index f1bfcdb1757..3ec4827375b 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -14,7 +14,7 @@ animation.track_insert_key(track_index, 0.0, 0) animation.track_insert_key(track_index, 0.5, 100) [/codeblock] - Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. + Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check [enum TrackType] to see available types. https://docs.godotengine.org/en/latest/tutorials/animation/index.html @@ -39,6 +39,7 @@ + Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track. @@ -51,6 +52,7 @@ + Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. @@ -63,6 +65,7 @@ + Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. @@ -73,6 +76,8 @@ + Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. + End offset is the number of seconds cut off at the ending of the audio stream. @@ -83,6 +88,8 @@ + Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. + Start offset is the number of seconds cut off at the beginning of the audio stream. @@ -93,6 +100,7 @@ + Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. @@ -109,6 +117,8 @@ + Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track. + [code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending. @@ -121,6 +131,7 @@ + Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. @@ -133,6 +144,7 @@ + Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. @@ -145,6 +157,7 @@ + Sets the stream of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. @@ -155,6 +168,7 @@ + Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -165,6 +179,7 @@ + Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -175,6 +190,7 @@ + Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -191,6 +207,8 @@ + Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. + [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. @@ -201,6 +219,7 @@ + Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. @@ -213,6 +232,7 @@ + Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -225,6 +245,7 @@ + Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -237,6 +258,7 @@ + Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. @@ -675,6 +697,7 @@ + Emitted when there's a change in the list of tracks, e.g. tracks are added, moved or have changed paths. @@ -689,10 +712,13 @@ Method tracks call functions with given arguments per key. + Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a [Color]). + Audio tracks are used to play an audio stream with either type of [AudioStreamPlayer]. The stream can be trimmed and previewed in the animation. + Animation tracks play animations in other [AnimationPlayer] nodes. No interpolation (nearest value). @@ -713,6 +739,7 @@ Update at the keyframes. + Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds. diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index bd821da4541..b69bae6031c 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -1,8 +1,10 @@ + [AnimationTree] node resource that contains many blend type nodes. + This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots. https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html @@ -18,6 +20,7 @@ + Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. @@ -30,6 +33,7 @@ + Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. @@ -40,6 +44,7 @@ + Disconnects the node connected to the specified input. @@ -48,6 +53,7 @@ + Returns the sub-node with the specified [code]name[/code]. @@ -56,6 +62,7 @@ + Returns the position of the sub-node with the specified [code]name[/code]. @@ -64,6 +71,7 @@ + Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. @@ -72,6 +80,7 @@ + Removes a sub-node. @@ -82,6 +91,7 @@ + Changes the name of a sub-node. @@ -92,25 +102,33 @@ + Modifies the position of a sub-node. + The global offset of all sub-nodes. + The connection was successful. + The input node is [code]null[/code]. + The specified input port is out of range. + The output node is [code]null[/code]. + Input and output nodes are the same. + The specified connection already exists. diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index 6c0b9caa84e..8e3a0c0a1d5 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -1,8 +1,10 @@ + Plays an animation once in [AnimationNodeBlendTree]. + A resource to add to an [AnimationNodeBlendTree]. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters. https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html @@ -25,10 +27,13 @@ + If [code]true[/code], the sub-animation will restart automatically after finishing. + The delay after which the automatic restart is triggered, in seconds. + If [member autorestart] is [code]true[/code], a random additional delay (in seconds) between 0 and this value will be added to [member autorestart_delay]. diff --git a/doc/classes/AnimationNodeOutput.xml b/doc/classes/AnimationNodeOutput.xml index 5ed021a871d..180b60c755d 100644 --- a/doc/classes/AnimationNodeOutput.xml +++ b/doc/classes/AnimationNodeOutput.xml @@ -1,6 +1,7 @@ + Generic output node to be added to [AnimationNodeBlendTree]. diff --git a/doc/classes/AnimationNodeTimeScale.xml b/doc/classes/AnimationNodeTimeScale.xml index 9f30a468e4a..cc52d39e6df 100644 --- a/doc/classes/AnimationNodeTimeScale.xml +++ b/doc/classes/AnimationNodeTimeScale.xml @@ -1,8 +1,10 @@ + A time-scaling animation node to be used with [AnimationTree]. + Allows scaling the speed of the animation (or reversing it) in any children nodes. Setting it to 0 will pause the animation. https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html diff --git a/doc/classes/AnimationNodeTimeSeek.xml b/doc/classes/AnimationNodeTimeSeek.xml index d7fc2ee9e88..12bb9df676a 100644 --- a/doc/classes/AnimationNodeTimeSeek.xml +++ b/doc/classes/AnimationNodeTimeSeek.xml @@ -1,8 +1,10 @@ + A time-seeking animation node to be used with [AnimationTree]. + This node can be used to cause a seek command to happen to any sub-children of the graph. After setting the time, this value returns to -1. https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 5495e20ab6e..c106ef5f649 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -1,8 +1,10 @@ + A generic animation transition node for [AnimationTree]. + Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified. https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html @@ -47,8 +49,10 @@ + The number of available input ports for this node. + Cross-fading time (in seconds) between each animation connected to the inputs. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 21cc6782b5e..3b8dc34bf07 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -1,6 +1,7 @@ + A node to be used for advanced animation transitions in an [AnimationPlayer]. @@ -15,6 +16,7 @@ + Manually advance the animations by the specified time (in seconds). @@ -36,22 +38,29 @@ + If [code]true[/code], the [AnimationTree] will be processing. + The path to the [AnimationPlayer] used for animating. + The process mode of this [AnimationTree]. See [enum AnimationProcessMode] for available modes. + The root animation node of this [AnimationTree]. See [AnimationNode]. + The animations will progress during the physics frame (i.e. [method Node._physics_process]). + The animations will progress during the idle frame (i.e. [method Node._process]). + The animations will only progress manually (see [method advance]). diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index 3ae1acd2cf5..9631b9d3dff 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -1,22 +1,26 @@ + Audio effect used for recording sound from a microphone. + https://docs.godotengine.org/en/latest/tutorials/audio/recording_with_microphone.html + Returns the recorded sample. + Returns whether the recording is active or not. @@ -25,11 +29,13 @@ + If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. + Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index 1074bab69d9..f0ec27f6f3b 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -21,6 +21,7 @@ If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects. + The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity. The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PoolVector2Array], not a reference. diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 9ceefb00abf..015db91f105 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -19,7 +19,7 @@ Sets whether this collision shape should only detect collision on one side (top or bottom). - The margin used for one-way collision (in pixels). + The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity. The actual shape owned by this collision shape. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index ee222274e7f..e922d553961 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -88,26 +88,34 @@ + The icon for the "Add Preset" button. + Custom texture for the hue selection slider on the right. + The width of the hue selection slider. + The margin around the [ColorPicker]. + The indicator used to signalize that the color value is outside the 0-1 range. + The icon for the screen color picker button. + The height of the saturation-value selection box. + The width of the saturation-value selection box. diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index a616d52a029..4045ab14c74 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -1,6 +1,7 @@ + A script that is executed when exporting projects. @@ -19,12 +20,14 @@ + Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. + Virtual method to be overridden by the user. Called when the export is finished. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 262dda85b51..97262751e19 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -1,6 +1,7 @@ + A modified version of [FileDialog] used by the editor. diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index bb5e2ed4cb9..9f994e9c7ee 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -75,6 +75,7 @@ + Scans the script files and updates the list of custom class names. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 61e908d26b4..56d31dec663 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -133,16 +133,22 @@ + The color tint for disabled files (when the [FileDialog] is used in open folder mode). + Custom icon for folders. + The color modulation applied to the folder icon. + Custom icon for the parent folder arrow. + Custom icon for the reload button. + Custom icon for the toggle hidden button. diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index fa4ee7d1c18..c34fd3bdbbc 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -85,6 +85,7 @@ + Returns the size that the string would have with word wrapping enabled with a fixed [code]width[/code]. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 889d38b4ea5..ae5f38bb227 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -303,26 +303,37 @@ + The background drawn under the grid. + Color of major grid lines. + Color of minor grid lines. + The icon for the zoom out button. + The icon for the zoom in button. + The horizontal range within which a port can be grabbed (on both sides). + The vertical range within which a port can be grabbed (on both sides). + The icon for the zoom reset button. + The fill color of the selection rectangle. + The outline color of the selection rectangle. + The icon for the snap toggle button. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index fe2d5d4d868..f4ffe3872d9 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -252,42 +252,59 @@ + The background used when [member overlay] is set to [constant OVERLAY_BREAKPOINT]. + The icon for the close button, visible when [member show_close] is enabled. + The color modulation applied to the close button icon. + The vertical offset of the close button. + The [StyleBox] used when [member comment] is enabled. + The [StyleBox] used when [member comment] is enabled and the [GraphNode] is focused. + The default background for [GraphNode]. + The icon used for representing ports. + Horizontal offset for the ports. + The background used when [member overlay] is set to [constant OVERLAY_POSITION]. + The icon used for resizer, visible when [member resizable] is enabled. + The color modulation applied to the resizer icon. + The background used when the [GraphNode] is selected. + The vertical distance between ports. + Color of the title text. + Font used for the title text. + Vertical offset of the title text. diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 64f0785a996..af3e5a84867 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -21,8 +21,10 @@ + The horizontal separation of children nodes. + The vertical separation of children nodes. diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml index 03881dc5a62..38b1ccd0357 100644 --- a/doc/classes/HSeparator.xml +++ b/doc/classes/HSeparator.xml @@ -14,8 +14,10 @@ + The height of the area covered by the separator. Effectively works like a minimum height. + The style for the separator line. Works best with [StyleBoxLine]. diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml index aa437f755d2..125461cac00 100644 --- a/doc/classes/HSlider.xml +++ b/doc/classes/HSlider.xml @@ -14,16 +14,22 @@ + The texture for the grabber (the draggable element). + The background of the area to the left of the grabber. + The texture for the grabber when it's disabled. + The texture for the grabber when it's focused. + The background for the whole slider. Determines the height of the [code]grabber_area[/code]. + The texture for the ticks, visible when [member Slider.tick_count] is greater than 0. diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index 16b47d6b0d3..34781df3793 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -14,12 +14,15 @@ + Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible. + The icon used for the grabber drawn in the middle area. + The space between sides of the container. diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 19de68a799c..0de8863a43f 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -15,6 +15,7 @@ + Returns the value of the specified flag. @@ -23,6 +24,7 @@ + Returns the value of the specified parameter. @@ -33,6 +35,7 @@ + If [code]true[/code], enables the specified flag. @@ -43,6 +46,7 @@ + Sets the value of the specified parameter. diff --git a/doc/classes/InputEventGesture.xml b/doc/classes/InputEventGesture.xml index 49e3168fa63..0d98222e6c0 100644 --- a/doc/classes/InputEventGesture.xml +++ b/doc/classes/InputEventGesture.xml @@ -1,6 +1,7 @@ + Base class for touch control gestures. @@ -10,6 +11,7 @@ + The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture. diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index ba4cef31b9f..3ceae3e3223 100644 --- a/doc/classes/PackedDataContainerRef.xml +++ b/doc/classes/PackedDataContainerRef.xml @@ -1,6 +1,7 @@ + Reference version of [PackedDataContainer]. diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml index 0f12486aafc..a2bd6c36536 100644 --- a/doc/classes/Panel.xml +++ b/doc/classes/Panel.xml @@ -14,6 +14,7 @@ + The style of this [Panel]. diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml index 1a01a7378b9..fa4991bd8ac 100644 --- a/doc/classes/PanelContainer.xml +++ b/doc/classes/PanelContainer.xml @@ -14,6 +14,7 @@ + The style of [PanelContainer]'s background. diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index e77f5a4818c..9145ebb8fdd 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -15,6 +15,7 @@ + Returns the value of the specified parameter. @@ -25,6 +26,7 @@ + Sets the value of the specified parameter. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 889c55780af..195dd4ae25d 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -18,12 +18,14 @@ + Adds a bone with the specified [code]path[/code] and [code]weights[/code]. + Removes all bones from this [Polygon2D]. @@ -32,12 +34,14 @@ + Removes the specified bone from this [Polygon2D]. + Returns the number of bones in this [Polygon2D]. @@ -46,6 +50,7 @@ + Returns the path to the node associated with the specified bone. @@ -54,6 +59,7 @@ + Returns the height values of the specified bone. @@ -64,6 +70,7 @@ + Sets the path to the node associated with the specified bone. @@ -74,6 +81,7 @@ + Sets the weight values for the specified bone. diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml index 082aa1975e5..519bf3b5dcc 100644 --- a/doc/classes/PopupPanel.xml +++ b/doc/classes/PopupPanel.xml @@ -14,6 +14,7 @@ + The background panel style of this [PopupPanel]. diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 83d581075e1..7c03413ab96 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -21,14 +21,19 @@ + The style of the background. + The style of the progress (i.e. the part that fills the bar). + Font used to draw the fill percentage if [member percent_visible] is [code]true[/code]. + The color of the text. + The color of the text's shadow. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 195856f6875..409ef3f74ec 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -409,38 +409,55 @@ + The font used for bold text. + The font used for bold italics text. + The default text color. + The background The background used when the [RichTextLabel] is focused. + The color of selected text, used when [member selection_enabled] is [code]true[/code]. + The color of the font's shadow. + The font used for italics text. + The vertical space between lines. + The font used for monospace text. + The normal background for the [RichTextLabel]. + The default text font. + The color of the selection box. + Boolean value. If 1 ([code]true[/code]), the shadow will be displayed around the whole text as an outline. + The horizontal offset of the font's shadow. + The vertical offset of the font's shadow. + The horizontal separation of elements in a table. + The vertical separation of elements in a table. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 24eb5b61d0b..2ea4fdc1faa 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -38,30 +38,35 @@ + Returns the default value of the specified property. + Returns a dictionary containing constant names and their values. + Returns the list of methods in this [Script]. + Returns the list of properties in this [Script]. + Returns the list of user signals defined in this [Script]. diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 2ee681583e9..62ba839ed72 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -1,6 +1,7 @@ + Godot editor's script editor. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 9619ebb70d9..470b6826db8 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -21,12 +21,14 @@ + Returns the value of the specified flag. + Returns the rectangle representing this sprite. @@ -37,6 +39,7 @@ + If [code]true[/code], the specified flag will be enabled. diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 11af6a4d306..589df8d6dff 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -72,11 +72,13 @@ A status representing a [StreamPeerSSL] that is disconnected. + A status representing a [StreamPeerSSL] during handshaking. A status representing a [StreamPeerSSL] that is connected to a host. + A status representing a [StreamPeerSSL] in error state. An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 5952e17911f..043f5fab1fb 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -15,6 +15,7 @@ + Loads the texture from the given path. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 0cb9c8b957a..8ec4489fb09 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -187,40 +187,56 @@ + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. + The font used to draw tab names. + Font color of inactive tabs. + Font color of disabled tabs. + Font color of the currently selected tab. + Horizontal separation between tabs. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. + The icon for the menu button (see [method set_popup]). + The icon for the menu button (see [method set_popup]) when it's being hovered with the cursor. + The style for the background fill. + The space at the left and right edges of the tab bar. + The style of inactive tabs. + The style of disabled tabs. + The style of the currently selected tab. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index cd87e46185f..fc3fb5afeca 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -262,28 +262,40 @@ + Background of the close button when it's being hovered with the cursor. + Background of the close button when it's being pressed. + The icon for the close button (see [member tab_close_display_policy]). + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. + Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. + The font used to draw tab names. + Font color of inactive tabs. + Font color of disabled tabs. + Font color of the currently selected tab. + The horizontal separation between the tabs. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. + Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. @@ -292,10 +304,13 @@ + The style of an inactive tab. + The style of a disabled tab + The style of the currently selected tab. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index a2bac812b38..421d0c7edb7 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -313,6 +313,7 @@ + Emitted when a custom button is pressed (i.e. in a [constant TreeItem.CELL_MODE_CUSTOM] mode cell). diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml index d8956640014..067cd99086b 100644 --- a/doc/classes/VSeparator.xml +++ b/doc/classes/VSeparator.xml @@ -14,8 +14,10 @@ + The width of the area covered by the separator. Effectively works like a minimum width. + The style for the separator line. Works best with [StyleBoxLine] (remember to enable [member StyleBoxLine.vertical]). diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml index 46395989977..a6ae75704fd 100644 --- a/doc/classes/VSlider.xml +++ b/doc/classes/VSlider.xml @@ -18,16 +18,22 @@ + The texture for the grabber (the draggable element). + The background of the area below the grabber. + The texture for the grabber when it's disabled. + The texture for the grabber when it's focused. + The background for the whole slider. Determines the width of the [code]grabber_area[/code]. + The texture for the ticks, visible when [member Slider.tick_count] is greater than 0. diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index c90acf5f4ca..5263618ef8e 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -14,12 +14,15 @@ + Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible. + The icon used for the grabber drawn in the middle area. + The space between sides of the container. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 4bacee44262..6b823a89f7f 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -22,6 +22,7 @@ + Adds the specified node to the shader. @@ -38,6 +39,7 @@ + Returns [code]true[/code] if the specified nodes and ports can be connected together. @@ -54,6 +56,7 @@ + Connects the specified nodes and ports. @@ -70,6 +73,7 @@ + Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. @@ -86,6 +90,7 @@ + Connects the specified nodes and ports. @@ -96,6 +101,7 @@ + Returns the shader node instance with specified [code]type[/code] and [code]id[/code]. @@ -104,6 +110,7 @@ + Returns the list of connected nodes with the specified type. @@ -112,6 +119,7 @@ + Returns the list of all nodes in the shader with the specified type. @@ -122,6 +130,7 @@ + Returns the position of the specified node within the shader graph. @@ -146,6 +155,7 @@ + Returns [code]true[/code] if the specified node and port connection exist. @@ -156,6 +166,7 @@ + Removes the specified node from the shader. @@ -164,6 +175,7 @@ + Sets the mode of this shader. @@ -176,20 +188,25 @@ + Sets the position of the specified node. + The offset vector of the whole graph. + A vertex shader, operating on vertices. + A fragment shader, operating on fragments (pixels). + A shader for light calculations. Represents the size of the [enum Type] enum. diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 14176e009bb..02781043eae 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -1,6 +1,7 @@ + Base class for nodes in a visual shader graph. diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index e2fa1ef3f7e..2b193d04944 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -29,22 +29,31 @@ + The icon for the close button. + The horizontal offset of the close button. + The icon used for the close button when it's hovered with the mouse cursor. + The vertical offset of the close button. + The style for both the content background of the [WindowDialog] and the title bar. + The thickness of the border that can be dragged when scaling the window (if [member resizable] is enabled). + The color of the title text. + The font used to draw the title. + The vertical offset of the title text.