Reference the BaseButton class explicitly in button class documentations

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
No known key found for this signature in database
GPG key ID: C3336907360768E1
8 changed files with 8 additions and 0 deletions

View file

@ -17,6 +17,7 @@
print("Hello world!") print("Hello world!")
[/codeblock] [/codeblock]
Buttons (like all Control nodes) can also be created in the editor, but some situations may require creating them from code. Buttons (like all Control nodes) can also be created in the editor, but some situations may require creating them from code.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to [CheckButton] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed. A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to [CheckButton] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For instance, it should be used when toggling it will only do something once a confirmation button is pressed.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<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. 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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility. Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
This kind of button is primarily used when the interaction with the button causes a context change (like linking to a web page). This kind of button is primarily used when the interaction with the button causes a context change (like linking to a web page).
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -6,6 +6,7 @@
<description> <description>
Special button that brings up a [PopupMenu] when clicked. Special button that brings up a [PopupMenu] when clicked.
New items can be created inside this [PopupMenu] using [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from the editor. To do so, select the [MenuButton] node, then in the toolbar at the top of the 2D editor, click [b]Items[/b] then click [b]Add[/b] in the popup. You will be able to give each items new properties. New items can be created inside this [PopupMenu] using [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from the editor. To do so, select the [MenuButton] node, then in the toolbar at the top of the 2D editor, click [b]Items[/b] then click [b]Add[/b] in the popup. You will be able to give each items new properties.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -6,6 +6,7 @@
<description> <description>
[TextureButton] has the same functionality as [Button], except it uses sprites instead of Godot's [Theme] resource. It is faster to create, but it doesn't support localization like more complex [Control]s. [TextureButton] has the same functionality as [Button], except it uses sprites instead of Godot's [Theme] resource. It is faster to create, but it doesn't support localization like more complex [Control]s.
The "normal" state must contain a texture ([member texture_normal]); other textures are optional. The "normal" state must contain a texture ([member texture_normal]); other textures are optional.
See also [BaseButton] which contains common properties and methods associated with this node.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>