springroll.AnimatorHint Class

Extends springroll.AbstractHint

Defined in: springroll.AnimatorHint:11

Module: Hints

Handle the hinting played with the Animator, usually a lip-synced animation.

Constructor

`springroll.AnimatorHint`

(

hints
done
instance
events
onComplete
onCancel

)

private

Defined in springroll.AnimatorHint:11

Parameters:

hints springroll.HintsPlayer

The instance of the hints
done Function

called on hint complete
instance createjs.MovieClip |

The media instance to play
events String | Object | Array

The event or events to play
onComplete Function

Callback when finished
onCancel Function | Boolean

If the call is cancelled, true set onComplete to also be the cancelled callback

Methods

_onPlayComplete
destroy
play

Properties

_hints

`_onPlayComplete`

(

original

)

private

Inherited from springroll.AbstractHint: _onPlayComplete:39

Handle when the media completes

Parameters:

original Function

The original callback, either complete or cancelled

`destroy`

()

Inherited from springroll.AbstractHint but overwritten in destroy:56

Clean-up the hint, don't use after this

`play`

()

Inherited from springroll.AbstractHint but overwritten in play:40

Run the hint

`_hints`

springroll.HintsPlayer

Inherited from springroll.AbstractHint: _hints:18

The reference to the hint play