diff options
| author | Sylvain Beucler <beuc@beuc.net> | 2021-02-15 11:45:58 +0100 |
|---|---|---|
| committer | Sylvain Beucler <beuc@beuc.net> | 2021-02-15 11:45:58 +0100 |
| commit | 9e21077fadafac3ba62ea9c5bbdb9c7883167453 (patch) | |
| tree | b0033e13bf1d45444928b1e96a108b32150d993c | |
| parent | cdfd3ffe15dbf6f41bdade308d69a75f3d4eb3a7 (diff) | |
doc: explain TouchScreenButton passby mode
| -rw-r--r-- | doc/classes/TouchScreenButton.xml | 3 |
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. |