Document ScrollContainer signals being emitted for touch events only

(cherry picked from commit d01184fbb7)
This commit is contained in:
Hugo Locurcio 2023-09-10 18:26:13 +02:00 committed by Yuri Sizov
parent 3b4748f6b5
commit 9812dfd450
1 changed files with 5 additions and 3 deletions

View File

@ -78,12 +78,14 @@
<signals> <signals>
<signal name="scroll_ended"> <signal name="scroll_ended">
<description> <description>
Emitted when scrolling stops. Emitted when scrolling stops when dragging the scrollable area [i]with a touch event[/i]. This signal is [i]not[/i] emitted 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.
</description> </description>
</signal> </signal>
<signal name="scroll_started"> <signal name="scroll_started">
<description> <description>
Emitted when scrolling is started. Emitted when scrolling starts when dragging the scrollable area w[i]ith a touch event[/i]. This signal is [i]not[/i] emitted 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.
</description> </description>
</signal> </signal>
</signals> </signals>