API Reference

Class List

ButtonComponent

Extends: Component

A ButtonComponent enables a group of entities to behave like a button, with different visual states for hover and press interactions.

Summary

Properties

active

If set to false, the button will be visible but will not respond to hover or touch interactions.

fadeDuration

Duration to be used when fading between tints, in milliseconds.

hitPadding

Padding to be used in hit-test calculations.

hoverSpriteAsset

Sprite to be used as the button image when the user hovers over it.

hoverSpriteFrame

Frame to be used from the hover sprite.

hoverTint

Color to be used on the button image when the user hovers over it.

imageEntity

A reference to the entity to be used as the button background.

inactiveSpriteAsset

Sprite to be used as the button image when the button is not interactive.

inactiveSpriteFrame

Frame to be used from the inactive sprite.

inactiveTint

Color to be used on the button image when the button is not interactive.

pressedSpriteAsset

Sprite to be used as the button image when the user presses it.

pressedSpriteFrame

Frame to be used from the pressed sprite.

pressedTint

Color to be used on the button image when the user presses it.

transitionMode

Controls how the button responds when the user hovers over it/presses it.

Events

click

Fired when the mouse is pressed and released on the component or when a touch starts and ends on the component.

hoverend

Fired when the button changes state to be not hovered.

hoverstart

Fired when the button changes state to be hovered.

mousedown

Fired when the mouse is pressed while the cursor is on the component.

mouseenter

Fired when the mouse cursor enters the component.

mouseleave

Fired when the mouse cursor leaves the component.

mouseup

Fired when the mouse is released while the cursor is on the component.

pressedend

Fired when the button changes state to be not pressed.

pressedstart

Fired when the button changes state to be pressed.

selectend

Fired when a xr select ends on the component.

selectenter

Fired when a xr select now hovering over the component.

selectleave

Fired when a xr select not hovering over the component.

selectstart

Fired when a xr select starts on the component.

touchcancel

Fired when a touch is canceled on the component.

touchend

Fired when a touch ends on the component.

touchleave

Fired when a touch leaves the component.

touchstart

Fired when a touch starts on the component.

Inherited

Properties

system

The ComponentSystem used to create this Component.

entity

The Entity that this Component is attached to.

enabled

Enables or disables the component.

Details

Constructor

ButtonComponent(system, entity)

Create a new ButtonComponent.

Parameters

systemButtonComponentSystem

The ComponentSystem that created this Component.

entityEntity

The Entity that this Component is attached to.

Properties

booleanactive

If set to false, the button will be visible but will not respond to hover or touch interactions.

numberfadeDuration

Duration to be used when fading between tints, in milliseconds.

Vec4hitPadding

Padding to be used in hit-test calculations. Can be used to expand the bounding box so that the button is easier to tap.

AssethoverSpriteAsset

Sprite to be used as the button image when the user hovers over it.

numberhoverSpriteFrame

Frame to be used from the hover sprite.

ColorhoverTint

Color to be used on the button image when the user hovers over it.

EntityimageEntity

A reference to the entity to be used as the button background. The entity must have an ImageElement component.

AssetinactiveSpriteAsset

Sprite to be used as the button image when the button is not interactive.

numberinactiveSpriteFrame

Frame to be used from the inactive sprite.

ColorinactiveTint

Color to be used on the button image when the button is not interactive.

AssetpressedSpriteAsset

Sprite to be used as the button image when the user presses it.

numberpressedSpriteFrame

Frame to be used from the pressed sprite.

ColorpressedTint

Color to be used on the button image when the user presses it.

numbertransitionMode

Controls how the button responds when the user hovers over it/presses it.

Events

click

Fired when the mouse is pressed and released on the component or when a touch starts and ends on the component.

Parameters

eventElementMouseEvent, ElementTouchEvent

The event.

hoverend

Fired when the button changes state to be not hovered.

hoverstart

Fired when the button changes state to be hovered.

mousedown

Fired when the mouse is pressed while the cursor is on the component.

Parameters

eventElementMouseEvent

The event.

mouseenter

Fired when the mouse cursor enters the component.

Parameters

eventElementMouseEvent

The event.

mouseleave

Fired when the mouse cursor leaves the component.

Parameters

eventElementMouseEvent

The event.

mouseup

Fired when the mouse is released while the cursor is on the component.

Parameters

eventElementMouseEvent

The event.

pressedend

Fired when the button changes state to be not pressed.

pressedstart

Fired when the button changes state to be pressed.

selectend

Fired when a xr select ends on the component.

Parameters

eventElementSelectEvent

The event.

selectenter

Fired when a xr select now hovering over the component.

Parameters

eventElementSelectEvent

The event.

selectleave

Fired when a xr select not hovering over the component.

Parameters

eventElementSelectEvent

The event.

selectstart

Fired when a xr select starts on the component.

Parameters

eventElementSelectEvent

The event.

touchcancel

Fired when a touch is canceled on the component.

Parameters

eventElementTouchEvent

The event.

touchend

Fired when a touch ends on the component.

Parameters

eventElementTouchEvent

The event.

touchleave

Fired when a touch leaves the component.

Parameters

eventElementTouchEvent

The event.

touchstart

Fired when a touch starts on the component.

Parameters

eventElementTouchEvent

The event.

Inherited

Properties

ComponentSystemsystem

The ComponentSystem used to create this Component.

Entityentity

The Entity that this Component is attached to.

booleanenabled

Enables or disables the component.