Standard themed Button.
Button is the standard themed button. It can contain text and an icon, and will display them according to the current Theme.
Example of creating a button and assigning an action when pressed by code:
func _ready(): var button = Button.new() button.text = "Click me" button.connect("pressed", self, "_button_pressed") add_child(button) func _button_pressed(): print("Hello world!")
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.
Note: Buttons do not interpret touch input and therefore don't support multitouch, since mouse emulation can only press one button at a given time. Use TouchScreenButton for buttons that trigger gameplay movement or actions, as TouchScreenButton supports multitouch.
TextAlign ALIGN_LEFT =
Align the text to the left.
TextAlign ALIGN_CENTER =
Align the text to the center.
TextAlign ALIGN_RIGHT =
Align the text to the right.
TextAlign align =
Text alignment policy for the button's text, use one of the TextAlign constants.
bool clip_text =
When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.
bool expand_icon =
When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.
bool flat =
Flat buttons don't display decoration.
Button's icon, if text is present the icon will be placed before the text.
To edit margin and spacing of the icon, use
hseparation theme property of Button and
content_margin_* properties of the used StyleBoxes.
TextAlign icon_align =
Specifies if the icon should be aligned to the left, right, or center of a button. Uses the same TextAlign constants as the text alignment. If centered, text will draw on top of the icon.
String text =
The button's text that will be displayed inside the button's area.
Theme Property Descriptions¶
Color font_color =
Color( 0.88, 0.88, 0.88, 1 )
Default text Color of the Button.
Color font_color_disabled =
Color( 0.9, 0.9, 0.9, 0.2 )
Text Color used when the Button is disabled.
Color font_color_focus =
Color( 0.94, 0.94, 0.94, 1 )
Text Color used when the Button is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
Color font_color_hover =
Color( 0.94, 0.94, 0.94, 1 )
Text Color used when the Button is being hovered.
Color font_color_pressed =
Color( 1, 1, 1, 1 )
Text Color used when the Button is being pressed.
int hseparation =
The horizontal space between Button's icon and text.
Font of the Button's text.
StyleBox used when the Button is disabled.
StyleBox used when the Button is being hovered.
Default StyleBox for the Button.
StyleBox used when the Button is being pressed.