LinkButton

Inherits: BaseButton < Control < CanvasItem < Node < Object

Simple button used to represent a link to some resource.

Description

This kind of button is primarily used when the interaction with the button causes a context change (like linking to a web page).

See also BaseButton which contains common properties and methods associated with this node.

Properties

FocusModefocus_mode0 (parent override)
CursorShapemouse_default_cursor_shape2 (parent override)
Stringtext“”
UnderlineModeunderline0

Theme Properties

StyleBoxfocus 
Fontfont 
Colorfont_colorColor( 0.88, 0.88, 0.88, 1 )
Colorfont_color_hoverColor( 0.94, 0.94, 0.94, 1 )
Colorfont_color_pressedColor( 1, 1, 1, 1 )
intunderline_spacing2

Enumerations

enum UnderlineMode:

  • UNDERLINE_MODE_ALWAYS = 0 —- The LinkButton will always show an underline at the bottom of its text.
  • UNDERLINE_MODE_ON_HOVER = 1 —- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
  • UNDERLINE_MODE_NEVER = 2 —- The LinkButton will never show an underline at the bottom of its text.

Property Descriptions

Default“”
Setterset_text(value)
Getterget_text()

The button’s text that will be displayed inside the button’s area.

Default0
Setterset_underline_mode(value)
Getterget_underline_mode()

Determines when to show the underline. See UnderlineMode for options.