summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-02-15 12:54:25 +0100
committerGitHub <noreply@github.com>2021-02-15 12:54:25 +0100
commite13312db7976fd78a75b29944e0f96a174653a1c (patch)
tree2f03813796d1ad5af478962af88b0e9c62737a78 /doc/classes
parent3f6295a1ed91975dcbf7f5ba9e0bb36f525538a1 (diff)
parent9e21077fadafac3ba62ea9c5bbdb9c7883167453 (diff)
Merge pull request #46028 from Beuc/patch-passby
doc: explain TouchScreenButton passby mode
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/TouchScreenButton.xml3
1 files changed, 2 insertions, 1 deletions
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.