springroll.GroupHint Class

Class to create tiered hinting or randomized hinting. this.app.hints.group() .vo('Something', onCompleted) .vo('Another', onComplete) .addTier() .vo('DetailedSomething', onComplete) .vo('DetailedAnother', onComplete);

Constructor

springroll.GroupHint

(
  • hints
  • done
)
private

Parameters:

_onPlayComplete

(
  • original
)
private

Handle when the media completes

Parameters:

  • original Function

    The original callback, either complete or cancelled

addTier

() springroll.GroupHint

Defined in addTier:134

Add a new timeout tier of hinting

Returns:

springroll.GroupHint:

The instance of the group hint, for chaining

anim

(
  • instance
  • events
  • onComplete
  • [onCancel]
)
springroll.AnimatorHint

Defined in anim:94

Add an animator hint to the player

Parameters:

  • instance createjs.MovieClip |

    The instance of the clip to play with Animator

  • events String | Array | Object

    The event aliases to play, see Animator.play

  • onComplete Function

    Call when the VO is done playing

  • [onCancel] Function | Boolean optional

    Call when the VO is cancelled playing, a value of true sets onComplete to also be the onCancelled callback.

Returns:

springroll.AnimatorHint:

The newly added hint

destroy

()

Inherited from springroll.AbstractHint but overwritten in destroy:176

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

func

(
  • onStart
)
springroll.FunctionHint

Defined in func:117

Add an animator hint to the player. If you use this hinting method, you NEED to re-enable the hinting when it's done. Whereas the VO and ANIM methods with automatically re-enable the hinting button.

Parameters:

  • onStart Function

    The instance of the clip to play with Animator

Returns:

springroll.FunctionHint:

The newly added hint

nextTier

() springroll.GroupHint

Defined in nextTier:146

Advance to the next tier of hints.

Returns:

springroll.GroupHint:

The instance of the group hint, for chaining

play

()

Inherited from springroll.AbstractHint but overwritten in play:62

Run the hint

reset

() type

Defined in reset:165

Reset the current tier to be the first

Returns:

type:

[description]

vo

(
  • [idOrList]
  • onComplete
  • [onCancel]
)
springroll.VOHint

Defined in vo:73

Add a VO hint to the player.

Parameters:

  • [idOrList] String | Array optional

    The list of VO element, see VOPlayer.play

  • onComplete Function

    Call when the VO is done playing

  • [onCancel] Function | Boolean optional

    Call when the VO is cancelled playing, a value of true sets onComplete to also be the onCancelled callback.

Returns:

springroll.VOHint:

The newly added hint

_current

Int private

Defined in _current:41

The current tier index

_hints

springroll.HintsPlayer

The reference to the hint play

_tier

Array private

Defined in _tier:48

The current tier selected

tiers

Array

Defined in tiers:33

The collection of tiers