Class SpriteAnimationClip

Handles playing of sprite animations and loading of relevant sprite assets.

Hierarchy (View Summary)

Constructors

constructor

Accessors

duration frame isPaused isPlaying sprite spriteAsset time

Methods

fire hasEvent off on once pause play resume stop

Events

EVENT_END EVENT_LOOP EVENT_PAUSE EVENT_PLAY EVENT_RESUME EVENT_STOP

Constructors

constructor

  • new SpriteAnimationClip(
        component: SpriteComponent,
        data: { fps?: number; loop?: boolean; name?: string; spriteAsset?: number },
    ): SpriteAnimationClip

  • Create a new SpriteAnimationClip instance.

    Parameters

    • component: SpriteComponent

      The sprite component managing this clip.

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

      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

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

    Returns SpriteAnimationClip

Accessors

duration

frame

isPaused

isPlaying

sprite

spriteAsset

time

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

pause

play

resume

stop

Events

StaticEVENT_END

EVENT_END: string = 'end'

Fired when the clip stops playing because it reached its end.

Example

clip.on('end', () => {
    console.log('Clip ended');
});

StaticEVENT_LOOP

EVENT_LOOP: string = 'loop'

Fired when the clip reached the end of its current loop.

Example

clip.on('loop', () => {
    console.log('Clip looped');
});

StaticEVENT_PAUSE

EVENT_PAUSE: string = 'pause'

Fired when the clip is paused.

Example

clip.on('pause', () => {
    console.log('Clip paused');
});

StaticEVENT_PLAY

EVENT_PLAY: string = 'play'

Fired when the clip starts playing.

Example

clip.on('play', () => {
    console.log('Clip started playing');
});

StaticEVENT_RESUME

EVENT_RESUME: string = 'resume'

Fired when the clip is resumed.

Example

clip.on('resume', () => {
    console.log('Clip resumed');
});

StaticEVENT_STOP

EVENT_STOP: string = 'stop'

Fired when the clip is stopped.

Example

clip.on('stop', () => {
    console.log('Clip stopped');
});

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
Events