Class SpriteComponent

Enables an Entity to render a simple static sprite or sprite animations.

Hierarchy (View Summary)

Constructors

constructor

Properties

entity system

Accessors

autoPlayClip batchGroupId clips color currentClip drawOrder enabled flipX flipY frame height layers opacity speed sprite spriteAsset type width

Methods

addClip clip fire hasEvent off on once pause play removeClip resume stop

Events

EVENT_END EVENT_LOOP EVENT_PAUSE EVENT_PLAY EVENT_RESUME EVENT_STOP

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

autoPlayClip

batchGroupId

clips

color

currentClip

drawOrder

enabled

flipX

flipY

frame

height

layers

opacity

speed

sprite

spriteAsset

type

width

Methods

addClip

  • addClip(
        data: {
            fps?: number;
            loop?: boolean;
            name?: string;
            spriteAsset?: number | Asset;
        },
    ): SpriteAnimationClip

  • Creates and adds a new SpriteAnimationClip to the component's clips.

    Parameters

    • data: { fps?: number; loop?: boolean; name?: string; spriteAsset?: number | Asset }

      Data for the new animation clip.

      • Optionalfps?: number

        Frames per second for the animation clip.

      • Optionalloop?: boolean

        Whether to loop the animation clip.

      • Optionalname?: string

        The name of the new animation clip.

      • OptionalspriteAsset?: number | Asset

        The asset id or the Asset of the sprite that this clip will play.

    Returns SpriteAnimationClip

    The new clip that was added.

clip

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

pause

play

removeClip

resume

stop

Events

StaticEVENT_END

EVENT_END: string = 'end'

Fired when an animation clip stops playing because it reached its end. The handler is passed the SpriteAnimationClip that ended.

Example

entity.sprite.on('end', (clip) => {
    console.log(`Animation clip ${clip.name} ended.`);
});

StaticEVENT_LOOP

EVENT_LOOP: string = 'loop'

Fired when an animation clip reached the end of its current loop. The handler is passed the SpriteAnimationClip that looped.

Example

entity.sprite.on('loop', (clip) => {
    console.log(`Animation clip ${clip.name} looped.`);
});

StaticEVENT_PAUSE

EVENT_PAUSE: string = 'pause'

Fired when an animation clip is paused. The handler is passed the SpriteAnimationClip that was paused.

Example

entity.sprite.on('pause', (clip) => {
    console.log(`Animation clip ${clip.name} paused.`);
});

StaticEVENT_PLAY

EVENT_PLAY: string = 'play'

Fired when an animation clip starts playing. The handler is passed the SpriteAnimationClip that started playing.

Example

entity.sprite.on('play', (clip) => {
    console.log(`Animation clip ${clip.name} started playing.`);
});

StaticEVENT_RESUME

EVENT_RESUME: string = 'resume'

Fired when an animation clip is resumed. The handler is passed the SpriteAnimationClip that was resumed.

Example

entity.sprite.on('resume', (clip) => {
    console.log(`Animation clip ${clip.name} resumed.`);
});

StaticEVENT_STOP

EVENT_STOP: string = 'stop'

Fired when an animation clip is stopped. The handler is passed the SpriteAnimationClip that was stopped.

Example

entity.sprite.on('stop', (clip) => {
    console.log(`Animation clip ${clip.name} stopped.`);
});

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events