diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-10-22 16:47:22 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-10-22 16:48:58 +0200 |
| commit | 2cd007fa4a75bd8a8d09620bf5bc4e4cc353447d (patch) | |
| tree | db44f807d3d0b002a6f2469d87123d737d38c6b9 /doc/classes | |
| parent | b3bcb2dc14691f7729984128dca26a844f662fa1 (diff) | |
| download | redot-engine-2cd007fa4a75bd8a8d09620bf5bc4e4cc353447d.tar.gz | |
Clarify `TextEdit.is_caret_visible()` behavior in the class reference
Diffstat (limited to 'doc/classes')
| -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 42558bf992..5bf8dc041d 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -764,7 +764,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"> |