Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #40457 from Calinou/doc-basebutton-pressed-toggled

Browse source 
Mention `toggled` signal for pressed state in BaseButton documentation
This commit is contained in:
Rémi Verschelde 2020-07-21 21:05:58 +02:00 • committed by GitHub
commit e73de413db
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
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">