diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-17 00:01:24 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-17 00:01:24 +0200 |
| commit | 43dae28e9db1d3e6355ee1105075dd4a7d963dd2 (patch) | |
| tree | 1e431725cc9036d62ea901462ebae24add6b5aba | |
| parent | 9e34ba48556b71f1f672b5be47d12b0e3f679b86 (diff) | |
Mention `toggled` signal for pressed state in BaseButton documentation
This closes #40455.
| -rw-r--r-- | doc/classes/BaseButton.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 5e908b0e53..3812b45b13 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -13,7 +13,7 @@ <return type="void"> </return> <description> - Called when the button is pressed. + Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead. </description> </method> <method name="_toggled" qualifiers="virtual"> @@ -89,6 +89,7 @@ <signal name="pressed"> <description> Emitted when the button is toggled or pressed. This is on [signal button_down] if [member action_mode] is [constant ACTION_MODE_BUTTON_PRESS] and on [signal button_up] otherwise. + If you need to know the button's pressed state (and [member toggle_mode] is active), use [signal toggled] instead. </description> </signal> <signal name="toggled"> |