summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkobewi <kobewi4e@gmail.com>2022-01-12 01:23:04 +0100
committerkobewi <kobewi4e@gmail.com>2022-01-12 12:49:21 +0100
commit4eec0032ea30dc3b61b9d0b623aa89bcdc40df21 (patch)
treecdb114bf1d2d469d119b90ef1a98b11daf44d252
parent96a20e477b8cf2760dacab830ba7807c6f61bb8d (diff)
Improve description of mouse_exited signal
-rw-r--r--doc/classes/Control.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index 3d8199831d..d5551e1e04 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -1113,6 +1113,12 @@
<description>
Emitted when the mouse leaves the control's [code]Rect[/code] area, provided its [member mouse_filter] lets the event reach it.
[b]Note:[/b] [signal mouse_exited] will be emitted if the mouse enters a child [Control] node, even if the mouse cursor is still inside the parent's [code]Rect[/code] area.
+ If you want to check whether the mouse truly left the area, ignoring any top nodes, you can use code like this:
+ [codeblock]
+ func _on_mouse_exited():
+ if not Rect2(Vector2(), rect_size).has_point(get_local_mouse_position()):
+ # Not hovering over area.
+ [/codeblock]
</description>
</signal>
<signal name="resized">