Class ButtonComponent

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

Hierarchy (View Summary)

Constructors

constructor

Properties

entity system

Accessors

active enabled fadeDuration hitPadding hoverSpriteAsset hoverSpriteFrame hoverTint imageEntity inactiveSpriteAsset inactiveSpriteFrame inactiveTint pressedSpriteAsset pressedSpriteFrame pressedTint transitionMode

Methods

fire hasEvent off on once

Events

EVENT_CLICK EVENT_HOVEREND EVENT_HOVERSTART EVENT_MOUSEDOWN EVENT_MOUSEENTER EVENT_MOUSELEAVE EVENT_MOUSEUP EVENT_PRESSEDEND EVENT_PRESSEDSTART EVENT_SELECTEND EVENT_SELECTENTER EVENT_SELECTLEAVE EVENT_SELECTSTART EVENT_TOUCHCANCEL EVENT_TOUCHEND EVENT_TOUCHLEAVE EVENT_TOUCHSTART

Constructors

constructor

Properties

entity

entity: Entity

The Entity that this Component is attached to.

system

system: ComponentSystem

The ComponentSystem used to create this Component.

Accessors

active

enabled

fadeDuration

hitPadding

hoverSpriteAsset

hoverSpriteFrame

hoverTint

imageEntity

inactiveSpriteAsset

inactiveSpriteFrame

inactiveTint

pressedSpriteAsset

pressedSpriteFrame

pressedTint

transitionMode

Methods

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

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

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

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

hasEvent

  • hasEvent(name: string): boolean

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

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

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

    Example

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

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • 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.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    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

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    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.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

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

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

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

    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.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    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

Events

StaticEVENT_CLICK

EVENT_CLICK: string = 'click'

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.

Example

entity.button.on('click', (event) => {
    console.log(`Clicked entity ${entity.name}`);
});

StaticEVENT_HOVEREND

EVENT_HOVEREND: string = 'hoverend'

Fired when the button changes state to be not hovered.

Example

entity.button.on('hoverend', () => {
    console.log(`Entity ${entity.name} unhovered`);
});

StaticEVENT_HOVERSTART

EVENT_HOVERSTART: string = 'hoverstart'

Fired when the button changes state to be hovered.

Example

entity.button.on('hoverstart', () => {
    console.log(`Entity ${entity.name} hovered`);
});

StaticEVENT_MOUSEDOWN

EVENT_MOUSEDOWN: string = 'mousedown'

Fired when the mouse is pressed while the cursor is on the component. The handler is passed a ElementMouseEvent.

Example

entity.button.on('mousedown', (event) => {
    console.log(`Mouse down on entity ${entity.name}`);
});

StaticEVENT_MOUSEENTER

EVENT_MOUSEENTER: string = 'mouseenter'

Fired when the mouse cursor enters the component. The handler is passed a ElementMouseEvent.

Example

entity.button.on('mouseenter', (event) => {
    console.log(`Mouse entered entity ${entity.name}`);
});

StaticEVENT_MOUSELEAVE

EVENT_MOUSELEAVE: string = 'mouseleave'

Fired when the mouse cursor leaves the component. The handler is passed a ElementMouseEvent.

Example

entity.button.on('mouseleave', (event) => {
    console.log(`Mouse left entity ${entity.name}`);
});

StaticEVENT_MOUSEUP

EVENT_MOUSEUP: string = 'mouseup'

Fired when the mouse is released while the cursor is on the component. The handler is passed a ElementMouseEvent.

Example

entity.button.on('mouseup', (event) => {
    console.log(`Mouse up on entity ${entity.name}`);
});

StaticEVENT_PRESSEDEND

EVENT_PRESSEDEND: string = 'pressedend'

Fired when the button changes state to be not pressed.

Example

entity.button.on('pressedend', () => {
    console.log(`Entity ${entity.name} unpressed`);
});

StaticEVENT_PRESSEDSTART

EVENT_PRESSEDSTART: string = 'pressedstart'

Fired when the button changes state to be pressed.

Example

entity.button.on('pressedstart', () => {
    console.log(`Entity ${entity.name} pressed`);
});

StaticEVENT_SELECTEND

EVENT_SELECTEND: string = 'selectend'

Fired when a xr select ends on the component. The handler is passed a ElementSelectEvent.

Example

entity.button.on('selectend', (event) => {
    console.log(`Select ended on entity ${entity.name}`);
});

StaticEVENT_SELECTENTER

EVENT_SELECTENTER: string = 'selectenter'

Fired when a xr select now hovering over the component. The handler is passed a ElementSelectEvent.

Example

entity.button.on('selectenter', (event) => {
    console.log(`Select entered entity ${entity.name}`);
});

StaticEVENT_SELECTLEAVE

EVENT_SELECTLEAVE: string = 'selectleave'

Fired when a xr select not hovering over the component. The handler is passed a ElementSelectEvent.

Example

entity.button.on('selectleave', (event) => {
    console.log(`Select left entity ${entity.name}`);
});

StaticEVENT_SELECTSTART

EVENT_SELECTSTART: string = 'selectstart'

Fired when a xr select starts on the component. The handler is passed a ElementSelectEvent.

Example

entity.button.on('selectstart', (event) => {
    console.log(`Select started on entity ${entity.name}`);
});

StaticEVENT_TOUCHCANCEL

EVENT_TOUCHCANCEL: string = 'touchcancel'

Fired when a touch is canceled on the component. The handler is passed a ElementTouchEvent.

Example

entity.button.on('touchcancel', (event) => {
    console.log(`Touch canceled on entity ${entity.name}`);
});

StaticEVENT_TOUCHEND

EVENT_TOUCHEND: string = 'touchend'

Fired when a touch ends on the component. The handler is passed a ElementTouchEvent.

Example

entity.button.on('touchend', (event) => {
    console.log(`Touch ended on entity ${entity.name}`);
});

StaticEVENT_TOUCHLEAVE

EVENT_TOUCHLEAVE: string = 'touchleave'

Fired when a touch leaves the component. The handler is passed a ElementTouchEvent.

Example

entity.button.on('touchleave', (event) => {
    console.log(`Touch left entity ${entity.name}`);
});

StaticEVENT_TOUCHSTART

EVENT_TOUCHSTART: string = 'touchstart'

Fired when a touch starts on the component. The handler is passed a ElementTouchEvent.

Example

entity.button.on('touchstart', (event) => {
    console.log(`Touch started on entity ${entity.name}`);
});

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events