diff options
| author | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 09:28:14 -0600 |
|---|---|---|
| committer | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 09:28:14 -0600 |
| commit | ab5a5395496751e09b2bc5100ff6352d0ee5f16c (patch) | |
| tree | ac01b025fffbf9fb2cbb159753e76187c0d2b797 | |
| parent | 686b1c4d98741a3693feddd23ad8d2c3c6d8fe9b (diff) | |
| parent | 2cd007fa4a75bd8a8d09620bf5bc4e4cc353447d (diff) | |
| download | redot-engine-ab5a5395496751e09b2bc5100ff6352d0ee5f16c.tar.gz | |
Merge pull request #98423 from Calinou/doc-textedit-is-caret-visible
Clarify `TextEdit.is_caret_visible()` behavior in the class reference
| -rw-r--r-- | doc/classes/TextEdit.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 39e478de30..13721d9d62 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -763,7 +763,8 @@ <return type="bool" /> <param index="0" name="caret_index" type="int" default="0" /> <description> - Returns [code]true[/code] if the caret is visible on the screen. + Returns [code]true[/code] if the caret is visible, [code]false[/code] otherwise. A caret will be considered hidden if it is outside the scrollable area when scrolling is enabled. + [b]Note:[/b] [method is_caret_visible] does not account for a caret being off-screen if it is still within the scrollable area. It will return [code]true[/code] even if the caret is off-screen as long as it meets [TextEdit]'s own conditions for being visible. This includes uses of [member scroll_fit_content_width] and [member scroll_fit_content_height] that cause the [TextEdit] to expand beyond the viewport's bounds. </description> </method> <method name="is_dragging_cursor" qualifiers="const"> |