summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-02-28 13:46:01 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-02-28 13:46:23 +0100
commit4a1397b58cf3cbdddf657efc575c6066860daf6d (patch)
tree0fe1af7851ba2dedd4b0532047cd23948cc52f80
parentdf78c0636d79c9545a283e0e2a926d623998cc27 (diff)
downloadredot-engine-4a1397b58cf3cbdddf657efc575c6066860daf6d.tar.gz
RTL: Clarify that line, paragraph, and character numbers are zero-indexed
Closes #82885.
-rw-r--r--doc/classes/RichTextLabel.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml
index 85dea1485a..0700baec5e 100644
--- a/doc/classes/RichTextLabel.xml
+++ b/doc/classes/RichTextLabel.xml
@@ -69,7 +69,7 @@
<return type="int" />
<param index="0" name="character" type="int" />
<description>
- Returns the line number of the character position provided.
+ Returns the line number of the character position provided. Line and character numbers are both zero-indexed.
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
</description>
</method>
@@ -77,7 +77,7 @@
<return type="int" />
<param index="0" name="character" type="int" />
<description>
- Returns the paragraph number of the character position provided.
+ Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed.
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
</description>
</method>