Skip to content

Button#

alt text The Button is a Label with associated actions that are triggered when the button is pressed/released/held/hovered.

Properties#

Unique properties of the Button

Layout#

Adjust these properties to customize the dimensions of the button relative to the screen

Properties
  • Controls if the widget should stretch to fill the available space or not 
    Boolean variable, defaults to False

Text#

Adjust these properties to customize the look and feel of the text

Properties
  • Controls the text displayed on the widget 
    String variable, defaults to "Button"
  • The higher the value,the smaller the width available for the text
  • Controls the horizontal alignment 
    Provides: Left ; Center ; Right ; Auto ; Justify

    defaults to Center
  • Controls the vertical alignment 
    Provides: Top ; Middle ; Bottom ; Center

    defaults to Center

Theme#

Apply a theme to this widget.

Individual Color#

Adjust these properties to customize the colors of the: background, text, highlight background, and highlight text.

Font#

Adjust these properties to customize the font of the button.

Properties
  • Controls the height of the font size 
    Floating point variable, defaults to 1.5

    min:1

    max:10
  • The higher the value,the smaller the font
  • Controls the width of the font size 
    Floating point variable, defaults to 1

    min:1

    max:10
  • The higher the value,the smaller the font
  • Controls the width of the text, if the lenght of text exceeds the width, the text will wrap letter by letter 
    Floating point variable, defaults to 1

    min:1

    max:10

Widget#

Adjust these properties to customize the opacity of the widget

Properties
  • Controls the opacity of the widget 
    Floating point variable, defaults to 1.0

    min:0.0

    max:1.0
  • at 0 the button is transparent
  • Controls the rotation of the widget 
    Floating point variable, defaults to 0.0

    min:0.0

    max:360.0

Texture#

Select a background image.

Properties
  • Import and set a background image
  • Import and set a background image that will be displayed while the button is clicked

Material Style#

Adjust these properties to customize the overall style of the widget

Properties
  • Controls the visibility of the border 
    Boolean variable, defaults to False
  • If this is checked it makes the border visible ```
  • Controls the widget of the border 
    Floating point variable, defaults to 2.0
  • Controls the curvature of the border 
    Floating point variable, defaults to 0.0

    min:0.0

    max:1.0
  • Controls the color of the border
  • The alpha chanel of this property defaults to FF if the Show Border is check otherwise it is 00
  • Enable the ripple effect of this widget. 
    Boolean variable, defaults to True
  • Controls the color of the effect
  • Controls the visibility of the ripple effect. 
    Floating point variable, defaults to 0.5
  • Controls the duration of the ripple effect. 
    Floating point variable, defaults to 1