Abstract base class for GUI buttons.
[BaseButton] is an abstract base class for GUI buttons. It doesn't display anything by itself.
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.
Called when the button is toggled (only if [member toggle_mode] is active).
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 [enum DrawMode] enum.
Returns [code]true[/code] if the mouse has entered the button and has not left it yet.
Changes the [member button_pressed] state of the button, without emitting [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 [member toggle_mode] is [code]true[/code]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group].
- Determines when the button is considered clicked, one of the [enum ActionMode] constants.
- The [ButtonGroup] associated with the button. Not to be confused with node groups. [b]Note:[/b] The button will be configured as a radio button if a [ButtonGroup] is assigned to it.
- Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use [code]MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT[/code].
- If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] Changing the value of [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal].
- If [code]true[/code], the button is in disabled state and can't be clicked or toggled.
- If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. [b]Note:[/b] This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.
- [Shortcut] associated to the button.
- If [code]true[/code], the button will highlight for a short amount of time when its shortcut is activated. If [code]false[/code] and [member toggle_mode] is [code]false[/code], the shortcut will activate without any visual feedback.
- If [code]true[/code], the button will add information about its shortcut in the tooltip. [b]Note:[/b] This property does nothing when the tooltip control is customized using [method Control._make_custom_tooltip].
- If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
Emitted when the button starts being held down.
Emitted when the button stops being held down.
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.
Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [param toggled_on] argument.
The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
The state of buttons are pressed.
The state of buttons are hovered.
The state of buttons are disabled.
The state of buttons are both hovered and pressed.
Require just a press to consider the button clicked.
Require a press and a subsequent release before considering the button clicked.