From 44f62a4f97881918182db55a6c3e1c259ed14f7b Mon Sep 17 00:00:00 2001
From: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Date: Thu, 19 Oct 2023 22:28:04 +0200
Subject: [PATCH] Clarify `NOTIFICATION_SCROLL_BEGIN/END` behavior
Documents that these notifications are only sent for touch events.
---
doc/classes/Control.xml | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml
index 21d6cb2756e..b5333a045b2 100644
--- a/doc/classes/Control.xml
+++ b/doc/classes/Control.xml
@@ -1172,10 +1172,12 @@
[b]Note:[/b] As an optimization, this notification won't be sent from changes that occur while this node is outside of the scene tree. Instead, all of the theme item updates can be applied at once when the node enters the scene tree.
- Sent when this node is inside a [ScrollContainer] which has begun being scrolled.
+ Sent when this node is inside a [ScrollContainer] which has begun being scrolled when dragging the scrollable area [i]with a touch event[/i]. This notification is [i]not[/i] sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
+ [b]Note:[/b] This signal is only emitted on Android or iOS, or on desktop/web platforms when [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is enabled.
- Sent when this node is inside a [ScrollContainer] which has stopped being scrolled.
+ Sent when this node is inside a [ScrollContainer] which has stopped being scrolled when dragging the scrollable area [i]with a touch event[/i]. This notification is [i]not[/i] sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
+ [b]Note:[/b] This signal is only emitted on Android or iOS, or on desktop/web platforms when [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse] is enabled.
Sent when control layout direction is changed.