springroll.VOHint Class

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

A hint designed to be played with the VOPlayer, typically off-screen voice-over.

Constructor

springroll.VOHint

(
  • hints
  • done
  • idOrList
  • onComplete
  • onCancel
)
private

Defined in springroll.VOHint:11

Parameters:

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:52

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

play

()

Inherited from springroll.AbstractHint but overwritten in play:37

Run the hint

_hints

springroll.HintsPlayer

Inherited from springroll.AbstractHint: _hints:18

The reference to the hint play