godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Reference the BaseButton class explicitly in button class documentations

Browse Source 
Users are sometimes confused as to the `pressed` property not being
visible in the Button class documentation. This is because `pressed`
is defined in BaseButton.

(cherry picked from commit 038baede5a)
This commit is contained in:
Hugo Locurcio
2020-09-23 23:34:28 +02:00
committed by Rémi Verschelde
parent 6036fdab70
commit c33373b80a
8 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/CheckButton.xml
View File

@@ -5,6 +5,7 @@
</brief_description>
<description>
CheckButton is a toggle button displayed as a check field. It's similar to [CheckBox] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckButton when toggling it has an [b]immediate[/b] effect on something. For instance, it should be used if toggling it enables/disables a setting without requiring the user to press a confirmation button.
See also [BaseButton] which contains common properties and methods associated with this node.
</description>
<tutorials>
</tutorials>