Create a new ButtonComponent instance.
The ComponentSystem that created this component.
The entity that this component is attached to.
The Entity that this Component is attached to.
The ComponentSystem used to create this Component.
If set to false, the button will be visible but will not respond to hover or touch interactions.
Duration to be used when fading between tints, in milliseconds.
Frame to be used from the hover sprite.
Frame to be used from the inactive sprite.
Frame to be used from the pressed sprite.
Controls how the button responds when the user hovers over it/presses it.
Fire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optional arg1: anyFirst argument that is passed to the event handler.
Optional arg2: anySecond argument that is passed to the event handler.
Optional arg3: anyThird argument that is passed to the event handler.
Optional arg4: anyFourth argument that is passed to the event handler.
Optional arg5: anyFifth argument that is passed to the event handler.
Optional arg6: anySixth argument that is passed to the event handler.
Optional arg7: anySeventh argument that is passed to the event handler.
Optional arg8: anyEighth argument that is passed to the event handler.
Self for chaining.
obj.fire('test', 'This is the message');
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
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.
Optional name: stringName of the event to unbind.
Optional callback: HandleEventCallbackFunction to be unbound.
Optional scope: objectScope that was used as the this when the event is fired.
Self for chaining.
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
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
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
Static EVENT_Fired when the mouse is pressed and released on the component or when a touch starts and ends on the component. The handler is passed a ElementMouseEvent or ElementTouchEvent.
entity.button.on('click', (event) => {
console.log(`Clicked entity ${entity.name}`);
});
Static EVENT_Fired when the button changes state to be not hovered.
entity.button.on('hoverend', () => {
console.log(`Entity ${entity.name} unhovered`);
});
Static EVENT_Fired when the button changes state to be hovered.
entity.button.on('hoverstart', () => {
console.log(`Entity ${entity.name} hovered`);
});
Static EVENT_Fired when the mouse is pressed while the cursor is on the component. The handler is passed a ElementMouseEvent.
entity.button.on('mousedown', (event) => {
console.log(`Mouse down on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse cursor enters the component. The handler is passed a ElementMouseEvent.
entity.button.on('mouseenter', (event) => {
console.log(`Mouse entered entity ${entity.name}`);
});
Static EVENT_Fired when the mouse cursor leaves the component. The handler is passed a ElementMouseEvent.
entity.button.on('mouseleave', (event) => {
console.log(`Mouse left entity ${entity.name}`);
});
Static EVENT_Fired when the mouse is released while the cursor is on the component. The handler is passed a ElementMouseEvent.
entity.button.on('mouseup', (event) => {
console.log(`Mouse up on entity ${entity.name}`);
});
Static EVENT_Fired when the button changes state to be not pressed.
entity.button.on('pressedend', () => {
console.log(`Entity ${entity.name} unpressed`);
});
Static EVENT_Fired when the button changes state to be pressed.
entity.button.on('pressedstart', () => {
console.log(`Entity ${entity.name} pressed`);
});
Static EVENT_Fired when a xr select ends on the component. The handler is passed a ElementSelectEvent.
entity.button.on('selectend', (event) => {
console.log(`Select ended on entity ${entity.name}`);
});
Static EVENT_Fired when a xr select now hovering over the component. The handler is passed a ElementSelectEvent.
entity.button.on('selectenter', (event) => {
console.log(`Select entered entity ${entity.name}`);
});
Static EVENT_Fired when a xr select not hovering over the component. The handler is passed a ElementSelectEvent.
entity.button.on('selectleave', (event) => {
console.log(`Select left entity ${entity.name}`);
});
Static EVENT_Fired when a xr select starts on the component. The handler is passed a ElementSelectEvent.
entity.button.on('selectstart', (event) => {
console.log(`Select started on entity ${entity.name}`);
});
Static EVENT_Fired when a touch is canceled on the component. The handler is passed a ElementTouchEvent.
entity.button.on('touchcancel', (event) => {
console.log(`Touch canceled on entity ${entity.name}`);
});
Static EVENT_Fired when a touch ends on the component. The handler is passed a ElementTouchEvent.
entity.button.on('touchend', (event) => {
console.log(`Touch ended on entity ${entity.name}`);
});
Static EVENT_Fired when a touch leaves the component. The handler is passed a ElementTouchEvent.
entity.button.on('touchleave', (event) => {
console.log(`Touch left entity ${entity.name}`);
});
Static EVENT_Fired when a touch starts on the component. The handler is passed a ElementTouchEvent.
entity.button.on('touchstart', (event) => {
console.log(`Touch started on entity ${entity.name}`);
});
A ButtonComponent enables a group of entities to behave like a button, with different visual states for hover and press interactions.