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

enabled	Enables or disables the component.
entity	The Entity that this Component is attached to.
system	The ComponentSystem used to create this Component.

Methods

fire	Fire an event, all additional arguments are passed on to the event listener.
hasEvent	Test if there are any handlers bound to an event name.
off	Detach an event handler from an event.
on	Attach an event handler to an event.
once	Attach an event handler to an event.

Details

Constructor

ButtonComponent(system, entity) 

Create a new ButtonComponent instance.

Parameters

system	ButtonComponentSystem	The ComponentSystem that created this component.
entity	Entity	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

event

ElementMouseEvent, ElementTouchEvent

event

ElementTouchEvent

The event.

Inherited

Properties

booleanenabled 

Enables or disables the component.

Entityentity 

The Entity that this Component is attached to.

ComponentSystemsystem 

The ComponentSystem used to create this Component.

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

name	string	Name of event to fire.
arg1	*	First argument that is passed to the event handler.
arg2	*	Second argument that is passed to the event handler.
arg3	*	Third argument that is passed to the event handler.
arg4	*	Fourth argument that is passed to the event handler.
arg5	*	Fifth argument that is passed to the event handler.
arg6	*	Sixth argument that is passed to the event handler.
arg7	*	Seventh argument that is passed to the event handler.
arg8	*	Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

const handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.