Class reference
Button
Inherits BaseButton
A themed button that can contain text and an icon.
Description
Button is the standard themed button. It can contain text and an icon, and it will display them according to the current Theme. Example: Create a button and connect a method that will be called when the button is pressed:
func _ready():
var button = Button.new()
button.text = "Click me"
button.pressed.connect(_button_pressed)
add_child(button)
func _button_pressed():
print("Hello world!")
public override void _Ready()
{
var button = new Button();
button.Text = "Click me";
button.Pressed += ButtonPressed;
AddChild(button);
}
private void ButtonPressed()
{
GD.Print("Hello world!");
}
See also BaseButton which contains common properties and methods associated with this node. Note: Buttons do not detect 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.
Properties
int alignment = 1
int alignment = 1Text alignment policy for the button's text.
int autowrap_mode = 0
int autowrap_mode = 0If set to something other than TextServer.AUTOWRAP_OFF, the text gets wrapped inside the node's bounding rectangle.
int autowrap_trim_flags = 128
int autowrap_trim_flags = 128Autowrap space trimming flags. See TextServer.BREAK_TRIM_START_EDGE_SPACES and TextServer.BREAK_TRIM_END_EDGE_SPACES for more info.
bool clip_text = false
bool clip_text = falseIf true, text that is too large to fit the button is clipped horizontally. If false, the button will always be wide enough to hold the text. The text is not vertically clipped, and the button's height is not affected by this property.
bool expand_icon = false
bool expand_icon = falseWhen enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. See also icon_max_width.
bool flat = false
bool flat = falseFlat buttons don't display decoration.
Texture2D icon
Texture2D iconButton's icon, if text is present the icon will be placed before the text. To edit margin and spacing of the icon, use h_separation theme property and content_margin_* properties of the used StyleBoxes.
int icon_alignment = 0
int icon_alignment = 0Specifies if the icon should be aligned horizontally to the left, right, or center of a button. Uses the same HorizontalAlignment constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon.
String language = ""
String language = ""Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
String text = ""
String text = ""The button's text that will be displayed inside the button's area.
int text_direction = 0
int text_direction = 0Base text writing direction.
int text_overrun_behavior = 0
int text_overrun_behavior = 0Sets the clipping behavior when the text exceeds the node's bounding rectangle.
int vertical_icon_alignment = 1
int vertical_icon_alignment = 1Specifies if the icon should be aligned vertically to the top, bottom, or center of a button. Uses the same VerticalAlignment constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon.
Theme properties
Color font_color = Color(0.875, 0.875, 0.875, 1)
Color font_color = Color(0.875, 0.875, 0.875, 1)Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5)
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5)Color font_focus_color = Color(0.95, 0.95, 0.95, 1)
Color font_focus_color = Color(0.95, 0.95, 0.95, 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_hover_color = Color(0.95, 0.95, 0.95, 1)
Color font_hover_color = Color(0.95, 0.95, 0.95, 1)Color font_hover_pressed_color = Color(1, 1, 1, 1)
Color font_hover_pressed_color = Color(1, 1, 1, 1)Text Color used when the Button is being hovered and pressed.
Color font_outline_color = Color(0, 0, 0, 1)
Color font_outline_color = Color(0, 0, 0, 1)The tint of text outline of the Button.
Color font_pressed_color = Color(1, 1, 1, 1)
Color font_pressed_color = Color(1, 1, 1, 1)Color icon_disabled_color = Color(1, 1, 1, 0.4)
Color icon_disabled_color = Color(1, 1, 1, 0.4)Color icon_focus_color = Color(1, 1, 1, 1)
Color icon_focus_color = Color(1, 1, 1, 1)Icon modulate Color used when the Button is focused. Only replaces the normal modulate color of the button. Disabled, hovered, and pressed states take precedence over this color.
Color icon_hover_color = Color(1, 1, 1, 1)
Color icon_hover_color = Color(1, 1, 1, 1)Color icon_hover_pressed_color = Color(1, 1, 1, 1)
Color icon_hover_pressed_color = Color(1, 1, 1, 1)Icon modulate Color used when the Button is being hovered and pressed.
Color icon_normal_color = Color(1, 1, 1, 1)
Color icon_normal_color = Color(1, 1, 1, 1)Color icon_pressed_color = Color(1, 1, 1, 1)
Color icon_pressed_color = Color(1, 1, 1, 1)int align_to_largest_stylebox = 0
int align_to_largest_stylebox = 0This constant acts as a boolean. If true, the minimum size of the button and text/icon alignment is always based on the largest stylebox margins, otherwise it's based on the current button state stylebox margins.
int h_separation = 4
int h_separation = 4The horizontal space between Button's icon and text. Negative values will be treated as 0 when used.
int icon_max_width = 0
int icon_max_width = 0The maximum allowed width of the Button's icon. This limit is applied on top of the default size of the icon, or its expanded size if expand_icon is true. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. CheckBox), they will also be limited.
int line_spacing = 0
int line_spacing = 0Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
int outline_size = 0
int outline_size = 0The size of the text outline. Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Font font
Font fontint font_size
int font_sizeFont size of the Button's text.
Texture2D icon
Texture2D iconDefault icon for the Button. Appears only if icon is not assigned.
StyleBox disabled
StyleBox disabledStyleBox disabled_mirrored
StyleBox disabled_mirroredStyleBox used when the Button is disabled (for right-to-left layouts).
StyleBox focus
StyleBox focusStyleBox used when the Button is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
StyleBox hover
StyleBox hoverStyleBox hover_mirrored
StyleBox hover_mirroredStyleBox used when the Button is being hovered (for right-to-left layouts).
StyleBox hover_pressed
StyleBox hover_pressedStyleBox used when the Button is being pressed and hovered at the same time.
StyleBox hover_pressed_mirrored
StyleBox hover_pressed_mirroredStyleBox used when the Button is being pressed and hovered at the same time (for right-to-left layouts).
StyleBox normal
StyleBox normalStyleBox normal_mirrored
StyleBox normal_mirroredDefault StyleBox for the Button (for right-to-left layouts).
StyleBox pressed
StyleBox pressedStyleBox pressed_mirrored
StyleBox pressed_mirroredStyleBox used when the Button is being pressed (for right-to-left layouts).