Button

Inherits: BaseButton < Control < CanvasItem < Node < Object Inherited By: CheckBox, CheckButton, ColorPickerButton, MenuButton, OptionButton, ToolButton Standard themed Button.

Description

Theme. Example of creating a button and assigning an action when pressed by code:

  1. 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. 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.

Tutorials

  • 2D Dodge The Creeps Demo
  • OS Test Demo

    Properties

    Theme Properties

    Enumerations

    TextAlign:
  • ALIGN_LEFT = 0 —- Align the text to the left.
  • ALIGN_CENTER = 1 —- Align the text to the center.
  • ALIGN_RIGHT = 2 —- Align the text to the right.

    Property Descriptions

  • TextAlign align 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.
  • Texture icon Button’s icon, if text is present the icon will be placed before the text. hseparation theme property of Button and content_margin_* properties of the used StyleBoxes.
  • TextAlign icon_align 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 of the Button.
  • Color font_color_disabled Color used when the Button is disabled.
  • Color font_color_focus 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 used when the Button is being hovered.
  • Color font_color_pressed Color used when the Button is being pressed.
  • int hseparation Button‘s icon and text.
  • Font font Font of the Button‘s text.
  • StyleBox disabled StyleBox used when the Button is disabled.
  • StyleBox focus StyleBox used when the Button is focused. It is displayed over the current StyleBox, so using StyleBoxEmpty will just disable the focus visual effect.
  • StyleBox hover StyleBox used when the Button is being hovered.
  • StyleBox normal StyleBox for the Button.
  • StyleBox pressed StyleBox used when the Button is being pressed.