API Documentation for: 2.3.1
Show:

PixiAnimator Class

Defined in: PixiAnimator:8
Namespace: cloudkid

[PIXI Only] Animator for interacting with Spine animations

Methods

_onMovieClipDone

(
  • timeline
)
private

Defined in _onMovieClipDone:453

Called when a movie clip is done playing, calls the AnimTimeline's callback if it has one

Parameters:

_repool

(
  • timeline
)
private

Defined in _repool:321

Put an AnimTimeline back into the general pool after it's done playing or has been manually stopped

Parameters:

_update

(
  • elapsed
)
private

Defined in _update:340

Update each frame

Parameters:

  • elapsed Int

    The time since the last frame

checkSpineForAnimation

(
  • clip
  • anim
)
Boolean

Defined in checkSpineForAnimation:262

Checks to see if a Spine animation includes a given animation alias

Parameters:

  • clip PIXI.spine

    The spine to search

  • anim String

    The animation alias to search for

Returns:

Boolean:

Returns true if the animation is found

destroy

()

Defined in destroy:482

Destroy this

init

() static

Defined in init:81

Initializes the singleton instance of PixiAnimator.

instanceHasAnimation

(
  • instance
  • anim
)
Boolean

Defined in instanceHasAnimation:247

Checks to see if a Spine animation includes a given animation alias

Parameters:

  • instance PIXI.spine

    The animation to search. This has to be a Spine animation.

  • anim String

    The animation alias to search for

Returns:

Boolean:

Returns true if the animation is found

play

(
  • clip
  • anim
  • [options]
)

Defined in play:103

Play a specified animation

Parameters:

  • clip PIXI.MovieClip | PIXI.Spine

    The clip to play

  • anim String | Array

    Depending on the type of clip, this could be one of several things.

    If animating a MovieClip, this should be the array of Textures that is the animation (or null to use the existing array on the clip).

    If animating a Spine object:

    • If anim is a string it will play that single animation by name.
    • If anim is an array of strings it will play as a list of animations (only the last one can loop).
    • If anim is an array of objects (with anim, loop, and speed properties) then multiple animations will be played simultaneously. When multiple animations play, animation stops when any non looping animation ends.
  • [options] Object | Function optional

    The object of optional parameters or onComplete callback function

    • [callback=null] Function optional

      The function to call once the animation has finished

    • [loop=false] Bool optional

      Whether the animation should loop

    • [speed=1] Int optional

      The speed at which to play the animation

    • [startTime=0] Int optional

      The time in milliseconds into the animation to start.

    • [soundData=null] Object | String optional

      Data about a sound to sync the animation to, as an alias or in the format {alias:"MyAlias", start:0}. start is the seconds into the animation to start playing the sound. If it is omitted or soundData is a string, it defaults to 0.

stop

(
  • clip
  • doCallback
)

Defined in stop:275

Stop a clip

Parameters:

  • clip PIXI.MovieClip | PIXI.Spine

    The clip to stop

  • doCallback Bool

    Whether the animations callback should be run

stop

()

Defined in stop:302

Stops all current animations

Properties

_animPool

Array private static

Defined in _animPool:66

Stored collection of AnimTimelines. This is internal to PixiAnimator and can't be accessed externally.

_boundUpdate

Function private

Defined in _boundUpdate:51

The function that PixiAnimator uses for update calls. Do not modify.

_instance

PixiAnimator private static

Defined in _instance:20

A reference to this instance of PixiAnimator. This is internal to PixiAnimator and can't be accessed externally.

_numAnims

Int private

Defined in _numAnims:35

The number of animations

_timelines

Array private

Defined in _timelines:28

The collection of AnimTimelines that are playing

_updateAlias

String private

Defined in _updateAlias:42

A string reference to PixiAnimator's update callback so it can be removed in the event that there are no animations to play

captions

cloudkid.Captions public

Defined in captions:74

The global captions object to use with animator

instance

PixiAnimator static

Defined in instance:92

Getter for the reference to this instance of PixiAnimator

soundLib

cloudkid.Audio | cloudkid.Sound public

Defined in soundLib:58

The instance of cloudkid.Audio or cloudkid.Sound for playing audio along with animations.