Skip to content

Commit 45509c2

Browse files
committed
Merge pull request #108029 from Joy-less/clarify-visible_characters
Clarify `visible_characters`
2 parents ca515cf + 4be5de0 commit 45509c2

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

doc/classes/Label.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1">
109109
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.
110110
[b]Note:[/b] Setting this property updates [member visible_ratio] accordingly.
111+
[b]Note:[/b] Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
111112
</member>
112113
<member name="visible_characters_behavior" type="int" setter="set_visible_characters_behavior" getter="get_visible_characters_behavior" enum="TextServer.VisibleCharactersBehavior" default="0">
113114
The clipping behavior when [member visible_characters] or [member visible_ratio] is set.

doc/classes/RichTextLabel.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -803,6 +803,7 @@
803803
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1">
804804
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.
805805
[b]Note:[/b] Setting this property updates [member visible_ratio] accordingly.
806+
[b]Note:[/b] Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
806807
</member>
807808
<member name="visible_characters_behavior" type="int" setter="set_visible_characters_behavior" getter="get_visible_characters_behavior" enum="TextServer.VisibleCharactersBehavior" default="0">
808809
The clipping behavior when [member visible_characters] or [member visible_ratio] is set.

0 commit comments

Comments
 (0)