springroll.Container Class

Defined in: springroll.Container:7
Module: Container

_addEventListeners

(
  • minigame
  • client
)
private

Defined in _addEventListeners:77

Bind handlers to events between the client and minigame instances.

Parameters:

  • minigame Minigame

    Instance of the Minigame API.

  • client Bellhop

    Bellhop instance on the container.

connectLoggingService

()

Defined in connectLoggingService:64

Handler to connect to the remote host for logging progress tracker

envToQuery

(
  • env
)
String
private

Defined in envToQuery:154

Convert an environment object into an API query string

Parameters:

  • env Object

    The environment settings

Returns:

String:

The query string

onGoogleAnalyticEvent

(
  • event
)
private

Defined in onGoogleAnalyticEvent:30

Track an event for Google Analtyics

Parameters:

  • event Event

    Bellhop analyticEvent

onKarKingdomInit

(
  • event
)
private

Defined in onKarKingdomInit:30

Initialize the Kart Kingdom API

Parameters:

onLearningEvent

(
  • event
)
private

Defined in onLearningEvent:42

Track an event for springroll Learning

Parameters:

  • event Event

    The bellhop learningEvent

open

(
  • game
  • [options]
)

Defined in open:54

Open application based on a slug or bundleId in SpringRoll Connect

Parameters:

  • game String

    The game's bundleId or slug property

  • [options] Object optional

    The open options

    • [singlePlay=false] Boolean optional

      If we should play in single play mode

    • [playOptions=null] Object optional

      The optional play options

    • [query=''] String optional

      The application query string options (e.g., "?level=1")

open

(
  • [options]
)

Defined in open:63

Open application based on a slug or bundleId in SpringRoll Connect, the game sould be set via the data-game attribute on the iframe.

Parameters:

  • [options] Object optional

    The open options

    • [singlePlay=false] Boolean optional

      If we should play in single play mode

    • [playOptions=null] Object optional

      The optional play options

    • [query=''] String optional

      The application query string options (e.g., "?level=1")

apiDomain

String

Defined in apiDomain:32

The place where to load games from

Default: 'http://springroll.pbskids.org'

hasHeadband

Boolean

Defined in hasHeadband:39

If we're currently on a producer site

headbandReady

Boolean

Defined in headbandReady:46

If the headband is ready/loaded

isProduction

Boolean

Defined in isProduction:23

If we're running in production mode, this is automatically set by calling open(), otherwise for openRemote() or openPath() it should be handled manually.

Default: false

learning

springroll.pbskids.LearningAnalytics

Defined in learning:17

The Learning Analytics client for sending events

loggingService

springroll.pbskids.LoggingService

Defined in loggingService:17

The Progress tracker client for sending events

minigame

Minigame

Defined in minigame:18

The instance of the Kart Kingdom Minigame API

REMOTE_HOST_COOKIE

String private final static

Defined in REMOTE_HOST_COOKIE:52

The name of the remote cookie for saving the host name

remoteButton

Jquery

Defined in remoteButton:104

The toggle button for the settings

remoteChannel

Jquery

Defined in remoteChannel:98

The name of the remote channel name

remoteConnect

Jquery

Defined in remoteConnect:84

Button for connecting to the remote host

remoteHost

Jquery

Defined in remoteHost:91

The name of the remote host or ip address

analyticEvent

Defined in analyticEvent:55

Event when dispatching a Google Analytics event

Event Payload:

  • data Object

    The event data

    • category String

      The event category

    • action String

      The event action

    • [label] String optional

      The optional label

    • [value] Number optional

      The optional value

learningEvent

Defined in learningEvent:58

Event when dispatching a Learning Dispatcher event

Event Payload: