Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
BaseButton¶
Inherits: Control < CanvasItem < Node < Object
Inherited By: Button, LinkButton, TextureButton
Abstract base class for GUI buttons.
Description¶
BaseButton is an abstract base class for GUI buttons. It doesn't display anything by itself.
Properties¶
|
||
BitField<MouseButtonMask> |
|
|
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
Methods¶
void |
_pressed ( ) virtual |
void |
|
get_draw_mode ( ) const |
|
is_hovered ( ) const |
|
void |
set_pressed_no_signal ( bool pressed ) |
Signals¶
button_down ( )
Emitted when the button starts being held down.
button_up ( )
Emitted when the button stops being held down.
pressed ( )
Emitted when the button is toggled or pressed. This is on button_down if action_mode is ACTION_MODE_BUTTON_PRESS and on button_up otherwise.
If you need to know the button's pressed state (and toggle_mode is active), use toggled instead.
toggled ( bool toggled_on )
Emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the toggled_on
argument.
Enumerations¶
enum DrawMode:
DrawMode DRAW_NORMAL = 0
The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
DrawMode DRAW_PRESSED = 1
The state of buttons are pressed.
DrawMode DRAW_HOVER = 2
The state of buttons are hovered.
DrawMode DRAW_DISABLED = 3
The state of buttons are disabled.
DrawMode DRAW_HOVER_PRESSED = 4
The state of buttons are both hovered and pressed.
enum ActionMode:
ActionMode ACTION_MODE_BUTTON_PRESS = 0
Require just a press to consider the button clicked.
ActionMode ACTION_MODE_BUTTON_RELEASE = 1
Require a press and a subsequent release before considering the button clicked.
Property Descriptions¶
ActionMode action_mode = 1
void set_action_mode ( ActionMode value )
ActionMode get_action_mode ( )
Determines when the button is considered clicked, one of the ActionMode constants.
ButtonGroup button_group
void set_button_group ( ButtonGroup value )