From 14feea59fb733424652090faf4461b45d060fcaf Mon Sep 17 00:00:00 2001 From: Micky Date: Mon, 22 Aug 2022 15:13:19 +0200 Subject: [PATCH] Improve `percent_visible` and `visible_characters` description Applies for Label and RichTextLabel. --- doc/classes/Label.xml | 8 ++++---- doc/classes/RichTextLabel.xml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 239eea099bc..52b2e9a7298 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -62,8 +62,8 @@ - Limits the number of visible characters. If you set [code]percent_visible[/code] to 0.5, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box. - [b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count]. + The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. + [b]Note:[/b] Setting this property updates [member visible_characters] accordingly. @@ -88,8 +88,8 @@ Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the [enum VerticalAlignment] constants. - Restricts the number of characters to display. Set to -1 to disable. - [b]Note:[/b] Setting this property updates [member percent_visible] based on current [method get_total_character_count]. + The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box. + [b]Note:[/b] Setting this property updates [member percent_visible] accordingly. Sets the clipping behavior when [member visible_characters] or [member percent_visible] is set. See [enum TextServer.VisibleCharactersBehavior] for more info. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 1d4304bd995..f96e136a57d 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -481,8 +481,8 @@ If [code]true[/code], the label uses the custom font color. - The range of characters to display, as a [float] between 0.0 and 1.0. - [b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count]. + The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. + [b]Note:[/b] Setting this property updates [member visible_characters] accordingly. The delay after which the loading progress bar is displayed, in milliseconds. Set to [code]-1[/code] to disable progress bar entirely. @@ -520,8 +520,8 @@ If [code]true[/code], text processing is done in a background thread. - The restricted number of characters to display in the label. If [code]-1[/code], all characters will be displayed. - [b]Note:[/b] Setting this property updates [member percent_visible] based on current [method get_total_character_count]. + The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box. + [b]Note:[/b] Setting this property updates [member percent_visible] accordingly. Sets the clipping behavior when [member visible_characters] or [member percent_visible] is set. See [enum TextServer.VisibleCharactersBehavior] for more info.