From 9e21077fadafac3ba62ea9c5bbdb9c7883167453 Mon Sep 17 00:00:00 2001
From: Sylvain Beucler <beuc@beuc.net>
Date: Mon, 15 Feb 2021 11:45:58 +0100
Subject: doc: explain TouchScreenButton passby mode

---
 doc/classes/TouchScreenButton.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml
index 355804f2a3..9833f0dc23 100644
--- a/doc/classes/TouchScreenButton.xml
+++ b/doc/classes/TouchScreenButton.xml
@@ -30,7 +30,8 @@
 			The button's texture for the normal state.
 		</member>
 		<member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled" default="false">
-			If [code]true[/code], pass-by presses are enabled.
+			If [code]true[/code], the [signal pressed] and [signal released] signals are emitted whenever a pressed finger goes in and out of the button, even if the pressure started outside the active area of the button.
+			[b]Note:[/b] this is a "pass-by" (not "bypass") press mode.
 		</member>
 		<member name="pressed" type="Texture2D" setter="set_texture_pressed" getter="get_texture_pressed">
 			The button's texture for the pressed state.
-- 
cgit v1.2.3