mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
336 lines
15 KiB
ReStructuredText
336 lines
15 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BaseButton.xml.
|
|
|
|
.. _class_BaseButton:
|
|
|
|
BaseButton
|
|
==========
|
|
|
|
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`Button<class_Button>`, :ref:`LinkButton<class_LinkButton>`, :ref:`TextureButton<class_TextureButton>`
|
|
|
|
Base class for different kinds of buttons.
|
|
|
|
Description
|
|
-----------
|
|
|
|
BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`button_group<class_BaseButton_property_button_group>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`MouseButton<enum_@GlobalScope_MouseButton>` | :ref:`button_mask<class_BaseButton_property_button_mask>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`button_pressed<class_BaseButton_property_button_pressed>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`Shortcut<class_Shortcut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`Node<class_Node>` | :ref:`shortcut_context<class_BaseButton_property_shortcut_context>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_pressed<class_BaseButton_method__pressed>` **(** **)** |virtual| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_toggled<class_BaseButton_method__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** |virtual| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`DrawMode<enum_BaseButton_DrawMode>` | :ref:`get_draw_mode<class_BaseButton_method_get_draw_mode>` **(** **)** |const| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_method_is_hovered>` **(** **)** |const| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressed_no_signal<class_BaseButton_method_set_pressed_no_signal>` **(** :ref:`bool<class_bool>` pressed **)** |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_BaseButton_signal_button_down:
|
|
|
|
- **button_down** **(** **)**
|
|
|
|
Emitted when the button starts being held down.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_button_up:
|
|
|
|
- **button_up** **(** **)**
|
|
|
|
Emitted when the button stops being held down.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_pressed:
|
|
|
|
- **pressed** **(** **)**
|
|
|
|
Emitted when the button is toggled or pressed. This is on :ref:`button_down<class_BaseButton_signal_button_down>` if :ref:`action_mode<class_BaseButton_property_action_mode>` is :ref:`ACTION_MODE_BUTTON_PRESS<class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS>` and on :ref:`button_up<class_BaseButton_signal_button_up>` otherwise.
|
|
|
|
If you need to know the button's pressed state (and :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active), use :ref:`toggled<class_BaseButton_signal_toggled>` instead.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_toggled:
|
|
|
|
- **toggled** **(** :ref:`bool<class_bool>` button_pressed **)**
|
|
|
|
Emitted when the button was just toggled between pressed and normal states (only if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active). The new state is contained in the ``button_pressed`` argument.
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_BaseButton_DrawMode:
|
|
|
|
.. _class_BaseButton_constant_DRAW_NORMAL:
|
|
|
|
.. _class_BaseButton_constant_DRAW_PRESSED:
|
|
|
|
.. _class_BaseButton_constant_DRAW_HOVER:
|
|
|
|
.. _class_BaseButton_constant_DRAW_DISABLED:
|
|
|
|
.. _class_BaseButton_constant_DRAW_HOVER_PRESSED:
|
|
|
|
enum **DrawMode**:
|
|
|
|
- **DRAW_NORMAL** = **0** --- The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
|
|
|
|
- **DRAW_PRESSED** = **1** --- The state of buttons are pressed.
|
|
|
|
- **DRAW_HOVER** = **2** --- The state of buttons are hovered.
|
|
|
|
- **DRAW_DISABLED** = **3** --- The state of buttons are disabled.
|
|
|
|
- **DRAW_HOVER_PRESSED** = **4** --- The state of buttons are both hovered and pressed.
|
|
|
|
----
|
|
|
|
.. _enum_BaseButton_ActionMode:
|
|
|
|
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS:
|
|
|
|
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_RELEASE:
|
|
|
|
enum **ActionMode**:
|
|
|
|
- **ACTION_MODE_BUTTON_PRESS** = **0** --- Require just a press to consider the button clicked.
|
|
|
|
- **ACTION_MODE_BUTTON_RELEASE** = **1** --- Require a press and a subsequent release before considering the button clicked.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_BaseButton_property_action_mode:
|
|
|
|
- :ref:`ActionMode<enum_BaseButton_ActionMode>` **action_mode**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_action_mode(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_action_mode() |
|
|
+----------+------------------------+
|
|
|
|
Determines when the button is considered clicked, one of the :ref:`ActionMode<enum_BaseButton_ActionMode>` constants.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_button_group:
|
|
|
|
- :ref:`ButtonGroup<class_ButtonGroup>` **button_group**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_button_group(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_button_group() |
|
|
+----------+-------------------------+
|
|
|
|
The :ref:`ButtonGroup<class_ButtonGroup>` associated with the button. Not to be confused with node groups.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_button_mask:
|
|
|
|
- :ref:`MouseButton<enum_@GlobalScope_MouseButton>` **button_mask**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_button_mask(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_button_mask() |
|
|
+----------+------------------------+
|
|
|
|
Binary mask to choose which mouse buttons this button will respond to.
|
|
|
|
To allow both left-click and right-click, use ``MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT``.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_button_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **button_pressed**
|
|
|
|
+----------+--------------------+
|
|
| *Setter* | set_pressed(value) |
|
|
+----------+--------------------+
|
|
| *Getter* | is_pressed() |
|
|
+----------+--------------------+
|
|
|
|
If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active). Only works if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is ``true``.
|
|
|
|
\ **Note:** Setting :ref:`button_pressed<class_BaseButton_property_button_pressed>` will result in :ref:`toggled<class_BaseButton_signal_toggled>` to be emitted. If you want to change the pressed state without emitting that signal, use :ref:`set_pressed_no_signal<class_BaseButton_method_set_pressed_no_signal>`.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **disabled**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_disabled(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | is_disabled() |
|
|
+----------+---------------------+
|
|
|
|
If ``true``, the button is in disabled state and can't be clicked or toggled.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_keep_pressed_outside:
|
|
|
|
- :ref:`bool<class_bool>` **keep_pressed_outside**
|
|
|
|
+----------+---------------------------------+
|
|
| *Setter* | set_keep_pressed_outside(value) |
|
|
+----------+---------------------------------+
|
|
| *Getter* | is_keep_pressed_outside() |
|
|
+----------+---------------------------------+
|
|
|
|
If ``true``, the button stays pressed when moving the cursor outside the button while pressing it.
|
|
|
|
\ **Note:** This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_shortcut:
|
|
|
|
- :ref:`Shortcut<class_Shortcut>` **shortcut**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_shortcut(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_shortcut() |
|
|
+----------+---------------------+
|
|
|
|
:ref:`Shortcut<class_Shortcut>` associated to the button.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_shortcut_context:
|
|
|
|
- :ref:`Node<class_Node>` **shortcut_context**
|
|
|
|
+----------+-----------------------------+
|
|
| *Setter* | set_shortcut_context(value) |
|
|
+----------+-----------------------------+
|
|
| *Getter* | get_shortcut_context() |
|
|
+----------+-----------------------------+
|
|
|
|
The :ref:`Node<class_Node>` which must be a parent of the focused GUI :ref:`Control<class_Control>` for the shortcut to be activated. If ``null``, the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_shortcut_in_tooltip:
|
|
|
|
- :ref:`bool<class_bool>` **shortcut_in_tooltip**
|
|
|
|
+----------+----------------------------------+
|
|
| *Setter* | set_shortcut_in_tooltip(value) |
|
|
+----------+----------------------------------+
|
|
| *Getter* | is_shortcut_in_tooltip_enabled() |
|
|
+----------+----------------------------------+
|
|
|
|
If ``true``, the button will add information about its shortcut in the tooltip.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_toggle_mode:
|
|
|
|
- :ref:`bool<class_bool>` **toggle_mode**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_toggle_mode(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | is_toggle_mode() |
|
|
+----------+------------------------+
|
|
|
|
If ``true``, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_BaseButton_method__pressed:
|
|
|
|
- void **_pressed** **(** **)** |virtual|
|
|
|
|
Called when the button is pressed. If you need to know the button's pressed state (and :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active), use :ref:`_toggled<class_BaseButton_method__toggled>` instead.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method__toggled:
|
|
|
|
- void **_toggled** **(** :ref:`bool<class_bool>` button_pressed **)** |virtual|
|
|
|
|
Called when the button is toggled (only if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active).
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_get_draw_mode:
|
|
|
|
- :ref:`DrawMode<enum_BaseButton_DrawMode>` **get_draw_mode** **(** **)** |const|
|
|
|
|
Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the :ref:`DrawMode<enum_BaseButton_DrawMode>` enum.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_is_hovered:
|
|
|
|
- :ref:`bool<class_bool>` **is_hovered** **(** **)** |const|
|
|
|
|
Returns ``true`` if the mouse has entered the button and has not left it yet.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_set_pressed_no_signal:
|
|
|
|
- void **set_pressed_no_signal** **(** :ref:`bool<class_bool>` pressed **)**
|
|
|
|
Changes the :ref:`button_pressed<class_BaseButton_property_button_pressed>` state of the button, without emitting :ref:`toggled<class_BaseButton_signal_toggled>`. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is ``true``.
|
|
|
|
\ **Note:** This method doesn't unpress other buttons in :ref:`button_group<class_BaseButton_property_button_group>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|