From 508e624b87194359ecc0f557a8030cf2624f2a28 Mon Sep 17 00:00:00 2001 From: Tomasz Chabora Date: Wed, 8 Jan 2020 22:51:16 +0100 Subject: [PATCH] Complete documentation of various classes --- doc/classes/AudioStreamPlayer.xml | 2 ++ doc/classes/AudioStreamPlayer2D.xml | 2 ++ doc/classes/AudioStreamPlayer3D.xml | 2 ++ doc/classes/Engine.xml | 3 +++ doc/classes/HScrollBar.xml | 11 ++++++++++- doc/classes/LineEdit.xml | 17 ++++++++++++++++- doc/classes/ScrollBar.xml | 1 + doc/classes/VScrollBar.xml | 12 +++++++++++- doc/classes/VisibilityEnabler.xml | 2 ++ doc/classes/VisibilityEnabler2D.xml | 3 +++ .../doc_classes/AudioStreamOGGVorbis.xml | 2 ++ 11 files changed, 54 insertions(+), 3 deletions(-) diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 89fc18476bb..0eadf27c4d5 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -21,6 +21,7 @@ + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer]. @@ -69,6 +70,7 @@ The [AudioStream] object to be played. + If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code]. Volume of sound, in dB. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 4734aff770d..ec3b7872b79 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -21,6 +21,7 @@ + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D]. @@ -75,6 +76,7 @@ The [AudioStream] object to be played. + If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code]. Base volume without dampening. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index a73f96d0828..5e12e06650f 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -21,6 +21,7 @@ + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer3D]. @@ -99,6 +100,7 @@ The [AudioStream] object to be played. + If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code]. Base sound level unaffected by dampening, in dB. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 187e13d7bda..04e203793ba 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -85,6 +85,7 @@ + Returns a global singleton with given [code]name[/code]. Often used for plugins, e.g. GodotPayments. @@ -116,6 +117,7 @@ + Returns [code]true[/code] if a singleton with given [code]name[/code] exists in global scope. @@ -134,6 +136,7 @@ The number of fixed iterations per second (for fixed process and physics). + Controls how much physic ticks are synchronized with real time. For 0 or less, the ticks are synchronized. Such values are recommended for network games, where clock synchronization matters. Higher values cause higher deviation of in-game clock and real clock, but allows to smooth out framerate jitters. The default value of 0.5 should be fine for most; values above 2 could cause the game to react to dropped frames with a noticeable delay and are not recommended. The desired frames per second. If the hardware cannot keep up, this setting may not be respected. A value of 0 means no limit. diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml index 14ace8bc767..90f14dd3445 100644 --- a/doc/classes/HScrollBar.xml +++ b/doc/classes/HScrollBar.xml @@ -4,7 +4,7 @@ Horizontal scroll bar. - Horizontal scroll bar. See [ScrollBar]. This one goes from left (min) to right (max). + Horizontal version of [ScrollBar], which goes from left (min) to right (max). @@ -14,22 +14,31 @@ + Icon used as a button to scroll the [ScrollBar] left. Supports custom step using the [member ScrollBar.custom_step] property. + Displayed when the mouse cursor hovers over the decrement button. + Used as texture for the grabber, the draggable element representing current scroll. + Used when the mouse hovers over the grabber. + Used when the grabber is being dragged. + Icon used as a button to scroll the [ScrollBar] right. Supports custom step using the [member ScrollBar.custom_step] property. + Displayed when the mouse cursor hovers over the increment button. + Used as background of this [ScrollBar]. + Used as background when the [ScrollBar] has the GUI focus. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 78459d2839d..a360010b7ec 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -96,7 +96,7 @@ The cursor's position inside the [LineEdit]. When set, the text may scroll to accommodate it. - If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty. + If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty, which can be used to clear the text quickly. If [code]true[/code], the context menu will appear when right-clicked. @@ -128,8 +128,10 @@ The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character. + If [code]false[/code], it's impossible to select the text using mouse nor keyboard. + If [code]false[/code], using shortcuts will be disabled. String value of the [LineEdit]. @@ -192,30 +194,43 @@ + Texture for the clear button. See [member clear_button_enabled]. + Color used as default tint for the clear button. + Color used for the clear button when it's pressed. + Color of the [LineEdit]'s visual cursor (caret). + Background used when [LineEdit] has GUI focus. + Font used for the text. + Default font color. + Font color for selected text (inside the selection rectangle). + Font color when editing is disabled. + Minimum horizontal space for the text (not counting the clear button and content margins). + Default background for the [LineEdit]. + Background used when [LineEdit] is in read-only mode ([member editable] is set to [code]false[/code]). + Color of the selection rectangle. diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index ea30b9d48c8..e4ace8e8aed 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -12,6 +12,7 @@ + Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the [ScrollBar] is focused. diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml index 6240178b82e..add695ef2cc 100644 --- a/doc/classes/VScrollBar.xml +++ b/doc/classes/VScrollBar.xml @@ -1,9 +1,10 @@ - Vertical version of [ScrollBar], which goes from top (min) to bottom (max). + Vertical scroll bar. + Vertical version of [ScrollBar], which goes from top (min) to bottom (max). @@ -17,22 +18,31 @@ + Icon used as a button to scroll the [ScrollBar] up. Supports custom step using the [member ScrollBar.custom_step] property. + Displayed when the mouse cursor hovers over the decrement button. + Used as texture for the grabber, the draggable element representing current scroll. + Used when the mouse hovers over the grabber. + Used when the grabber is being dragged. + Icon used as a button to scroll the [ScrollBar] down. Supports custom step using the [member ScrollBar.custom_step] property. + Displayed when the mouse cursor hovers over the increment button. + Used as background of this [ScrollBar]. + Used as background when the [ScrollBar] has the GUI focus. diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index e3c7d05fce1..56fa7b77a94 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -15,6 +15,7 @@ + Returns whether the enabler identified by given [enum Enabler] constant is active. @@ -25,6 +26,7 @@ + Sets active state of the enabler identified by given [enum Enabler] constant. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 96f6a42cdff..547793c3851 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -15,6 +15,7 @@ + Returns whether the enabler identified by given [enum Enabler] constant is active. @@ -25,6 +26,7 @@ + Sets active state of the enabler identified by given [enum Enabler] constant. @@ -65,6 +67,7 @@ This enabler will stop the parent's _physics_process function. + This enabler will stop [AnimatedSprite] nodes animations. Represents the size of the [enum Enabler] enum. diff --git a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml index 94031993987..102a9b42361 100644 --- a/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml +++ b/modules/stb_vorbis/doc_classes/AudioStreamOGGVorbis.xml @@ -15,8 +15,10 @@ Contains the audio data in bytes. + If [code]true[/code], the stream will automatically loop when it reaches the end. + Time in seconds at which the stream starts after being looped.