springroll.FunctionHint Class

Extends springroll.AbstractHint
Defined in: springroll.FunctionHint:11
Module: Hints

Generic function to act as a hint

Constructor

springroll.FunctionHint

(
  • hints
  • done
  • onStart
)
private

Defined in springroll.FunctionHint:11

Parameters:

  • hints springroll.HintsPlayer

    The instance of the hints

  • done Function

    called on hint done

  • onStart Function

    Function to call should accept 2 arguments (callbacks: onComplete and onCancelled and call them when complete or cancelled

Methods

Properties

_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:47

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

play

()

Inherited from springroll.AbstractHint but overwritten in play:34

Start function hint

_hints

springroll.HintsPlayer

Inherited from springroll.AbstractHint: _hints:18

The reference to the hint play