API Documentation for: 0.0.1
Show:

Animator.AnimTimeline Class

Defined in: Animator.AnimTimeline:461
Namespace: cloudkid

Internal Animator class for keeping track of animations. AnimTimelines are pooled internally, so please only keep references to them while they are actively playing an animation.

Constructor

Animator.AnimTimeline

(
  • clip
  • callback
  • speed
)

Defined in Animator.AnimTimeline:461

Parameters:

  • clip PIXI.MovieClip | Pixi.Spine

    The AnimTimeline's clip

  • callback Function

    The function to call when the clip is finished playing

  • speed Int

    The speed at which the clip should be played

Methods

init

(
  • clip
  • callback
  • speed
)
Animator.AnimTimeline

Defined in init:478

Initialize the AnimTimeline

Parameters:

  • clip PIXI.MovieClip | Pixi.Spine

    The AnimTimeline's clip

  • callback Function

    The function to call when the clip is finished playing

  • speed Number

    The speed at which the clip should be played

Returns:

Animator.AnimTimeline:

Properties

_paused

Bool private

Defined in _paused:580

If this animation is paused.

callback

Function public

Defined in callback:503

The function to call when the clip is finished playing

clip

PIXI.MovieClip | PIXI.Spine public

Defined in clip:489

The clip for this AnimTimeLine

isSpine

Bool public

Defined in isSpine:496

Whether the clip is a PIXI.Spine

loop

Bool public

Defined in loop:523

Not used by Animator, but potentially useful for other code to keep track of what type of animation is being played

paused

Bool public

Defined in paused:590

Sets and gets the animation's paused status.

playSound

Bool public

Defined in playSound:551

If the timeline will, but has yet to, play a sound

soundAlias

String public

Defined in soundAlias:537

Sound alias to sync to during the animation.

soundEnd

Number public

Defined in soundEnd:565

The time (seconds) into the animation that the sound ends

soundInst

Object public

Defined in soundInst:544

A sound instance object from cloudkid.Sound or cloudkid.Audio, used for tracking sound position.

soundStart

Number public

Defined in soundStart:558

The time (seconds) into the animation that the sound starts.

speed

Number public

Defined in speed:510

The speed at which the clip should be played

spineStates

Array public

Defined in spineStates:517

time

Number public

Defined in time:530

The position of the animation in seconds

useCaptions

Bool

Defined in useCaptions:572

If this timeline plays captions