User Manual

Button

The Button Component is a convenient shortcut for creating User Interface buttons for use with Screen and Element Components.

The Button Component can be used in two Transition Modes. Sprite Swap, which uses a different sprite or frame for each button state or Tint, which tints a single sprite with a different color for each state.

Common Properties

PropertyDescription
ActiveWhen enabled the button will respond to and fire event. When disabled the button is set to the Inactive State.
ImageThe Image Element Entity that is used to detect input events.
Hit PaddingAdditional space around the Image Element that will be included when testing for input events.
Transition ModeThe type of effect to use when transitioning between states. Either Sprite Swap or Tint.

Sprite Swap Properties

Sprite Swap Button

PropertyDescription
Hover SpriteThe Sprite Asset used when the button is in the Hover State.
Hover FrameThe Sprite Frame to display when the button is in the Hover State.
Pressed SpriteThe Sprite Asset used when the button is in the Pressed State.
Pressed FrameThe Sprite Frame to display when the button is in the Pressed State.
Inactive SpriteThe Sprite Asset used when the button is not active.
Inactive FrameThe Sprite Frame used when the button is not active.

Tint Properties

Tint Button

PropertyDescription
Hover TintThe color to tint the Image Element with when the button is in the Hover State.
Pressed TintThe color to tint the Image Element with when the button is in the Pressed State.
Inactive TintThe color to tint the Image Element with when the button is in the Inactive State.
Fade DurationThe time in milliseconds to blend between the different state colors

Scripting Interface

You can control the properties of a Button component using a script component. The scripting interface for the Sprite component is here.