godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mention `toggled` signal for pressed state in BaseButton documentation 

This closes #40455.

(cherry picked from commit 43dae28e9d)
This commit is contained in:
Hugo Locurcio 2020-07-17 00:01:24 +02:00 committed by Rémi Verschelde
parent ca4fe82a7f
commit 7e9a51cdd5
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/BaseButton.xml
View File

@ -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">