-
-
-
-
-
-
-
-
- IdleTimer
-
-
-
-
-
-
-
- new IdleTimer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
time (Number
- = 15000)
- time in milliseconds
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- resets the timer, does not call subscribed functions
-
- reset(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- stop(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Calls all subscribed functions, and resets the timer.
-
- dispatch(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
subscribe(callback)
-
-
-
-
-
-
-
- Adds a function to be called when timer is dispatched
-
- subscribe(callback: any): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- callback (any)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
unsubscribe(callback)
-
-
-
-
-
-
-
- Removes a function from being called when timer is dispatched
-
- unsubscribe(callback: any): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- callback (any)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof IdleTimer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- IHintPlayer
-
-
-
-
-
-
- Hint Player interface to help enforce minimum requirements for hint players
-
- new IHintPlayer()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
play (function)
- : called by application to
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- UserData
-
-
-
-
-
-
- Manages data between SpringRoll Container and SpringRoll
-
- new UserData()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Gets data from SpringRoll Container
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- Promise:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
write(name, value)
-
-
-
-
-
-
-
- Sends data to SpringRoll Container
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- Promise:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Removes data from SpringRoll Container
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBOpen(dbName, dbVersion, additions, deletions, name)
-
-
-
-
-
-
-
- Opens a connection with the indexedDB database
-
- IDBOpen(dbName: any, dbVersion: any, additions: any, deletions: any, name:
string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
- dbVersion (any
- = null)
-
-
-
-
-
-
-
- additions (any
- = {})
-
-
-
-
-
-
-
- deletions (any
- = {})
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBAdd(storeName, value, key, name)
-
-
-
-
-
-
-
- Adds a record to the indexedDB database
-
- IDBAdd(storeName: any, value: any, key: any, name:
string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- storeName (any)
-
-
-
-
-
-
-
-
-
- key (any
- = null)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBRemove(storeName, key, name)
-
-
-
-
-
-
-
- Removes data from SpringRoll Container
-
- IDBRemove(storeName: any, key: any, name:
string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- storeName (any)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBRead(storeName, key, name)
-
-
-
-
-
-
-
- Removes data from SpringRoll Container
-
- IDBRead(storeName: any, key: any, name:
string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- storeName (any)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBUpdate(storeName, key, value, object)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBReadAll(storeName, count)
-
-
-
-
-
-
-
-
- IDBReadAll(storeName:
string, count: integer)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
storeName (string)
- The name of the store to read from
-
-
-
-
-
-
-
- count (integer
- = null)
- Specifies the number of values to return if more than one is found.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Close the connection with the database
-
- IDBClose()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
IDBDeleteDB(dbName, DBName)
-
-
-
-
-
-
-
- Delete a given database
-
- IDBDeleteDB(dbName: any, DBName:
string)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
DBName (string)
- The name of the database to be deleted
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- PositionCallback
-
-
-
-
-
-
- callback to used move game entities
-
- PositionCallback(position:
Point)
-
-
- Type:
- Function
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
position (Point)
- position relative to anchor direction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Anchor
-
-
-
-
-
-
- Used to fix positions to a relative point in the viewport.
-
- new Anchor()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- | Name |
- Description |
-
-
-
-
-
- param.viewArea Point
- |
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof Anchor
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Point
-
-
-
-
-
-
-
- Point
-
-
- Type:
- {x: Number, y: Number}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Point
-
-
-
-
-
-
-
- Point
-
-
- Type:
- {x: Number, y: Number}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ScaleCallback
-
-
-
-
-
-
- callback to used scale game and canvas
-
-
-
-
- Type:
- Function
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
width (Number)
- width canvas should be
-
-
-
-
-
-
-
-
height (Number)
- height canvas should be
-
-
-
-
-
-
-
-
scale (Point)
- x/y scale values
-
-
-
-
-
-
-
-
scaleRatio (Number)
- minimum aspect ratio that fit's in the screen.
-
-
-
-
-
-
-
-
viewArea (Object)
- Rectangle defining the total viewable area of game content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- SafeScaleManager
-
-
-
-
-
-
- Handles scaling the game
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- | Name |
- Description |
-
-
-
-
-
- $0.width any
- |
- |
-
-
-
-
-
- $0.height any
- |
- |
-
-
-
-
-
- $0.safeWidth any
-
- (default Infinity)
- |
- |
-
-
-
-
-
- $0.safeHeight any
-
- (default Infinity)
- |
- |
-
-
-
-
-
- $0.callback any
-
- (default ()=>{})
- |
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
calcOffset(scale)
-
-
-
-
-
-
-
- Calculates the offset for anchors.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
scale (Point)
- scale value
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Point:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
addEntity(entity)
-
-
-
-
-
-
-
- Adds and anchor to be updated during resize
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
- entities
-
-
- Type:
- Array<ScaledEntity>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- resizeEventData
-
-
- Type:
- EntityResizeEvent
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
removeEntity(entity)
-
-
-
-
-
-
-
- Removes an anchor
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- void:
- @memberof SafeScaleManager
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enables the scale manager listener. Will not be enabled if a callback is not supplied.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callback (ScaleCallback)
- The function to be called on resize events.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Disables the scale manager.
-
- disable()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ResizeHelper
-
-
-
-
-
-
- Utility class that handles resize events for ScaleManager and SafeScaleManager.
-
- new ResizeHelper(resizeCallback:
function)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Whether or not the application is running on an iOS device.
-
- iOS
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the enabled state of the ResizeHelper.
-
- enabled
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the enabled state of the ResizeHelper.
-Forces a resize event.
-
- enabled
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Handler for window resize events. Forwards this event to the scale manager if enabled.
-
- onWindowResize()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
getWindowResolution()
-
-
-
-
-
-
-
- Sets the window width and window height values of the ResizeHelper.
-
- getWindowResolution()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ScaledEntity
-
-
-
-
-
-
-
- ScaledEntity
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- void:
- @memberof ScaledEntity
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- EntityResizeEvent
-
-
-
-
-
-
-
- EntityResizeEvent
-
-
- Type:
- {offset: Point, gameSize: Point, scale: Point}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ScaleManager
-
-
-
-
-
-
- [Deprecated]
-Simplifies listening to resize events by passing the relevant data to a provided callback.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- Enables the scale manager listener. Will not be enabled if a callback is not supplied.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callback (Function)
- The function to be called on resize events.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Disables the scale manager.
-
- disable()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- SpeechSynth
-
-
-
-
-
-
- SpeechSync makes it easy to convert text to speech.
-Note: This is not supported on IE11 and below because of the underlying APIs are not implemented in those browsers
-
- new SpeechSynth(params:
object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- | Name |
- Description |
-
-
-
-
-
- params.voice number
-
- (default 0)
- |
- Indicates what voice to use.
- |
-
-
-
-
-
- params.rate number
-
- (default 1)
- |
- The rate at which the text is said. Supports a range from 0.1 to 10.
- |
-
-
-
-
-
- params.pitch number
-
- (default 0)
- |
- Voice Pitch. Supports a pitch from 0 to 2.
- |
-
-
-
-
-
- params.volume number
-
- (default 1)
- |
- Volume. Supports 0 to 1.
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
voicesLoaded (boolean)
- : voices are loaded async. This is will be set to true when they are loaded.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- Pauses the announcer.
-
- pause()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Resumes the announcer.
-
- resume()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Pauses the announcer and clears the queue.
-
- cancel()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Causes the announcer to say whatever message is passed to it.
-If the announcer is already saying something then it will be added to a queue.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the voice by array index.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the voice object.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- (object | null):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Rate at which text is spoken.
-
- rate
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns rate which text is spoken.
-
- rate
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- number:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the pitch at which text is spoken.
-
- pitch
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the pitch at which text is spoken.
-
- pitch
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- number:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the current volume of the announcer.
-
- volume
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the current volume of the announcer.
-
- volume
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- number:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ColorFilter
-
-
-
-
-
-
- The Color filter allows you to simulate colorblindness.
-
- new ColorFilter()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
applyFilter(element, type)
-
-
-
-
-
-
-
- Applies the specified filter to the element.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
changeFilter(type)
-
-
-
-
-
-
-
- Changes the currently applied filter to the element if the color filter has it.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- any:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Removes the filter from the element.
-
- removeFilter()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Supported filter types.
-
- types
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- object:
- Returns an object { name, value } with the colorblindness type:
-(Protanopia, Protanomaly, Deuteranopia, Deuteranomaly, Tritanopia, Tritanomaly, Achromatopsia, Achromatomaly)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- filterType
-
-
-
-
-
-
-
- filterType
-
-
- Type:
- ("protanopia" | "protanomaly" | "deuteranopia" | "deuteranomaly" | "tritanopia" | "tritanomaly" | "achromatopsia" | "achromatomaly")
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- KeyState
-
-
-
-
-
-
-
- KeyState
-
-
- Type:
- (0 | 1 | 2)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Controller
-
-
-
-
-
-
- Controller interface class to simplify working with key presses.
-
- new Controller(buttons:
Array<KeyTemplate>)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Calls all functions for buttons that are currently set to enabled.
-
- update()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Called on keyup. Sets flag to 1 if key is being watched.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Called on keyup. Sets flag to 2 if key is being watched.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- Called on window blur, sets button state to up if button was down;
-
- onWindowBlur(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof Controller
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Key
-
-
-
-
-
-
- Represents a single key on the keyboard and the functions related to it.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
key (string)
- What this object represents.
-
-
-
-
-
-
-
-
down (Function
- = ()=>{})
- Function to be called while the key is held down.
-
-
-
-
-
-
-
-
up (Function
- = ()=>{})
- Function to be called when the key is lifted up.
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
- state ((0 | 1 | 2))
- : The current state of the key. 0 = inactive, 1 = active, 2 = to be set to inactive.
-
-
-
-
-
-
key (string)
- : The name of the key we are targeting.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
updateState(state)
-
-
-
-
-
-
-
- Updates the internal state of the key. Accepts a range between 0-2. Will set key state to 0 if nothing is passed.
-
- updateState(state: (0 | 1 | 2))
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- state ((0 | 1 | 2)
- = 0)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Calls the relevant action for the current state of the key.
-
- action()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the current state of the key.
-
- state
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- number:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Application
-
-
-
-
-
-
- Main entry point for a game. Provides a single focal point for plugins and functionality to attach.
-
- new Application()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
features (object)
- : A configuration object denoting which features are enabled for this application
-
-
-
-
- features.captions boolean?
-
- A boolean value denoting that this game supports captions
-
-
- features.sound boolean?
-
- A boolean value denoting that this game has some audio in it
-
-
- features.vo boolean?
-
- A boolean denoting that this game has mutable voice-over audio in it
-
-
- features.music boolean?
-
- A boolean denoting that this game has mutable music in it
-
-
- features.sfx boolean?
-
- A boolean denoting that this game has mutable sound effects in it
-
-
- features.soundVolume boolean?
-
- A boolean denoting that this game has adjustable sound volume in it
-
-
- features.musicVolume boolean?
-
- A boolean denoting that this game has adjustable music volume in it
-
-
- features.voVolume boolean?
-
- A boolean denoting that this game has adjustable voice-over volume in it
-
-
- features.sfxVolume boolean?
-
- A boolean denoting that this game has adjustable sound effects volume in it
-
-
- features.pointerSize boolean?
-
- A boolean denoting that this game has adjustable pointer size in it
-
-
- features.controlSensitivity boolean?
-
- A boolean denoting that this game has adjustable control sensitivity in it
-
-
- features.buttonSize boolean?
-
- A boolean denoting that this game has adjustable button sizes in it
-
-
- features.removableLayers boolean?
-
- A boolean denoting that this game has removable game layers in it
-
-
- features.hudPosition boolean?
-
- A boolean denoting that this game has custom HUD positions.
-
-
- features.hitAreaScale boolean?
-
- A boolean denoting that this game has adjustable hit areas.
-
-
- features.dragThresholdScale boolean?
-
- A boolean denoting that this game has adjustable drag thresholds.
-
-
- features.health boolean?
-
- A boolean denoting that this game has adjustable health.
-
-
- features.objectCount boolean?
-
- A boolean denoting that this game has adjustable object count requirements.
-
-
- features.completionPercentage boolean?
-
- A boolean denoting that this game has adjustable completion percentage requirements.
-
-
- features.speedScale boolean?
-
- A boolean denoting that this game has adjustable speed.
-
-
- features.timersScale boolean?
-
- A boolean denoting that this game has adjustable timers.
-
-
- features.inputCount boolean?
-
- A boolean denoting that this game has adjustable input count requirements.
-
-
- features.keyBinding boolean?
-
- A boolean denoting that this game has re-mappable key bindings.
-
-
- features.colorVision boolean?
-
- A boolean denoting that this game has color blindess filters
-
-
- features.fullScreen boolean?
-
- A boolean denoting that this game has fullScreen capabilities
-
-
- features.indexedDb boolean?
-
- A boolean denoting that this game has fullScreen capabilities
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- preloads, initializes and starts plugins.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise<void>:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The list of plugins that are currently registered to run on Applications.
-
- _plugins
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Registers a plugin to be used by applications, sorting it by priority order.
-
- uses(plugin: SpringRoll.ApplicationPlugin)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- plugin (SpringRoll.ApplicationPlugin)
- The plugin to register.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Finds a plugin by name.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
name (string)
- The name of the plugin.
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- (SpringRoll.ApplicationPlugin | undefined):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- returns instance of a plugin.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- (SpringRoll.ApplicationPlugin | undefined):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
validateListeners()
-
-
-
-
-
-
-
- Validates that appropriate listeners are added for the features that were enabled in the constructor
-
- validateListeners()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Throws
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
setStateDefaults()
-
-
-
-
-
-
-
- Sets default values of application state properties.
-
- setStateDefaults()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Debugger
-
-
-
-
-
-
-
-
-
-
- Type:
- object
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
params (Object)
- Options
-
-
-
-
-
-
-
-
-
-
- | Name |
- Description |
-
-
-
-
-
- params.emitEnabled boolean
-
- (default false)
- |
- If this should emit events to the window.
- |
-
-
-
-
-
- params.minLevel ("GENERAL" | "DEBUG" | "INFO" | "WARN" | "ERROR")
-
- (default 'GENERAL')
- |
- The starting log level for the logger.
- |
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Returns the params of the debugger.
-
- params
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- DebuggerParams:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Sets the logging level of the debugger.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- If emitting is enabled for this instance, then it will dispatch an event on the window.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
eventName (string
- = 'Debugger')
- Name of the event
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns logging levels.
-
- LEVEL
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- object:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Console logs all supplied arguments if the log level is low enough for them to be logged.
-
- log(type: (
"log" |
"general" |
"warn" |
"error" |
"debug" |
"info"), args:
Array<any>)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- type (("log" | "general" | "warn" | "error" | "debug" | "info")
- = 'log')
- minimum level for this log to run at
-
-
-
-
-
-
-
-
args (Array<any>)
- Arguments you wish to log.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Will throw if statement is false.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
isTrue (boolean)
- The expression to evaluate.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns a boolean indicating if the debugger has been enabled or not.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Disables or enables all debugger instances.
-TODO: Remove the parameter here, and add a disable method as well
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- void:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns the global params key.
-
- paramKey
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- HintSequencePlayer
-
-
-
-
-
-
-
- new HintSequencePlayer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- invokes the next hint
-
- play(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof HintSequencePlayer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- removes all hints
-
- clear(): void
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof HintSequencePlayer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- add(callbacks:
Array<function ()>): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callbacks (Array<function ()>)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof HintSequencePlayer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
remove(callbacks)
-
-
-
-
-
-
-
-
- remove(callbacks:
Array<function ()>): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callbacks (Array<function ()>)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof HintSequencePlayer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Property
-
-
-
-
-
-
- A class for representing changeable/subscribable properties.
-
- new Property()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
- _value (any)
- : the value of the property
-
-
-
-
-
- listeners ([])
- : all the objects listening to this property
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- The current value of the property
-
- value
-
-
- Type:
- any
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Setting this value notifies all listeners of the change.
-
- value
-
-
- Type:
- any
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
subscribe(callback)
-
-
-
-
-
-
-
- Adds a subscriber to this property.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callback (function)
- The callback to call whenever the property changes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
unsubscribe(callback)
-
-
-
-
-
-
-
- Unsubscribes a listener from this property.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
callback (function)
- The callback to unsubscribe.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Whether or not this property has any subscribed listeners
-
- hasListeners
-
-
- Type:
- Boolean
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Caption
-
-
-
-
-
-
-
- new Caption()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
update(deltaTime)
-
-
-
-
-
-
-
- Updates content based on time passed.
-This ~should~ be called every frame that the caption is active.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
deltaTime (Number)
- Time in seconds since last frame.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
updateState(currentTime, lastTime)
-
-
-
-
-
-
-
- Handles calling callbacks and updating caption's current state.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Checks if caption has completed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
start(time, renderer)
-
-
-
-
-
-
-
- Sets time and line index of caption.
-
- start(time:
Number, renderer: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
time (Number
- = 0)
- Time in milliseconds.
-
-
-
-
-
-
-
- renderer (any
- = {lineBegin:()=>{},lineEnd:()=>{}})
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
updateTimeIndex(time)
-
-
-
-
-
-
-
- Updates the current time and index of the caption instance
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Caption
-
-
-
-
-
-
-
- new Caption(lines: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
update(deltaTime)
-
-
-
-
-
-
-
- Updates content based on time passed.
-This ~should~ be called every frame that the caption is active.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
deltaTime (Number)
- Time in seconds since last frame.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
updateState(currentTime, lastTime)
-
-
-
-
-
-
-
- Handles calling callbacks and updating caption's current state.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Checks if caption has completed.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Boolean:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
start(time, renderer)
-
-
-
-
-
-
-
- Sets time and line index of caption.
-
- start(time:
Number, renderer: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
time (Number
- = 0)
- Time in milliseconds.
-
-
-
-
-
-
-
- renderer (any
- = {lineBegin:()=>{},lineEnd:()=>{}})
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
updateTimeIndex(time)
-
-
-
-
-
-
-
- Updates the current time and index of the caption instance
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CaptionFactory
-
-
-
-
-
-
- Collection of functions for creating Captions
-
- new CaptionFactory()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
createCaptionMap(data)
-
-
-
-
-
-
-
- Creates a new Object<String, Caption>.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- Object:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
createCaption(captionData)
-
-
-
-
-
-
-
- Creates a new Caption from JSON data.
-
- createCaption(captionData: any):
Caption
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- captionData (any)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Caption:
- new Caption
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
createLine(lineData)
-
-
-
-
-
-
-
- Creates a new TimedLine from JSON data.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- lineData (any)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- TimedLine:
- new TimedLine;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CaptionPlayer
-
-
-
-
-
-
-
- new CaptionPlayer(captions: any, renderer: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- captions (any)
-
-
-
-
-
-
-
- renderer (any)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
update(deltaTime)
-
-
-
-
-
-
-
- Updates any currently playing caption.
-This ~should~ be called every frame.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
deltaTime (Number)
- Time passed in seconds since last update call.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
start(name, time, args)
-
-
-
-
-
-
-
- Starts playing a caption.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
name (String)
- Name of caption.
-
-
-
-
-
-
-
-
time (number
- = 0)
- Atart time in milliseconds.
-
-
-
-
-
-
-
-
args (object
- = {})
- Arguments that will get passed to the renderer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Stops any caption currently playing.
-
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- CaptionPlayer
-
-
-
-
-
-
- CaptionPlayer is used to start, stop and update captions.
-It applies the content of an active caption to a given CaptionRenderer.
-
- new CaptionPlayer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
update(deltaTime)
-
-
-
-
-
-
-
- Updates any currently playing caption.
-This ~should~ be called every frame.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
deltaTime (Number)
- Time passed in seconds since last update call.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
start(name, time, args)
-
-
-
-
-
-
-
- Starts playing a caption.
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
name (String)
- Name of caption.
-
-
-
-
-
-
-
-
time (number
- = 0)
- Atart time in milliseconds.
-
-
-
-
-
-
-
-
args (object
- = {})
- Arguments that will get passed to the renderer
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Stops any caption currently playing.
-
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- TimedLine
-
-
-
-
-
-
-
- new TimedLine()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
▸
-
setContent(content)
-
-
-
-
-
-
-
- Sets line's content. Removes HTML formatting for text.
-
- setContent(content: any): void
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
- content (any)
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- void:
- @memberof TimedLine
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- IRender
-
-
-
-
-
-
- Render interface to help enforce minimum requirements for caption renderers
-
- new IRender()
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
start (function)
- : called when the Caption Player starts playing captions
-
-
-
-
-
-
stop (function)
- : called when the Caption Player stops playing captions
-
-
-
-
-
-
lineBegin (function)
- : called when rendering a new line of text
-
-
-
-
-
-
lineEnd (function)
- : called when finished rendering a new of text
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DOMRenderer
-
-
-
-
-
-
- DOMRender is a incomplete renderer that is intended to supply just the basic start and stop functions
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
templateVariables (Object)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
start(templateVariables)
-
-
-
-
-
-
-
- Makes target element visible and ready to present captions
-
- start(templateVariables:
object)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
templateVariables (object
- = {})
- Variables that can used during caption play time
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- H
-
- stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- HtmlRenderer
-
-
-
-
-
-
- HTML Renderer is intended for rendering raw html in the use case of wanting to display styled captions
-
- new HtmlRenderer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Called by Caption Player when a new line needs to be displayed
-
- lineBegin(line: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Called by Caption Player when a line is complete
-
- lineEnd()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- TemplateRenderer
-
-
-
-
-
-
- TemplateRenderer accepts a string template e.g.The ball is {{color}} and a args object e.g. {color: 'red'}
-and swaps out the placeholder inside the double brackets with the matching key inside the args object
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
template (string)
- String template that will be rendered with the supplied arguments
-
-
-
-
-
-
-
-
args (Object)
- //An Object contain data to be inserted into the template This will match based on key values
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- string:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- TextRenderer
-
-
-
-
-
-
- TextRenderer is intended for just rendering test. It will attempt to sanitize any strings passed to it by removing html syntax
-
- new TextRenderer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
-
-
-
- Called by Caption Player when a new line needs to be displayed
-
- lineBegin(line: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Called by Caption Player when a line is complete
-
- lineEnd()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Will attempt to remove all html from a string before it's renderer to the page
-
- sanitize(html: any)
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Localizer
-
-
-
-
-
-
-
- new Localizer()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Static Members
-
-
-
-
-
-
▸
-
resolve(path, options)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
- options (any
- = {})
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- {path: string, language: string}:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
setPrimaryLocale(localeKey)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- boolean:
- True if language is set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
setFallbackLocale(localeKey)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- boolean:
- True if fallback is set.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
getLocaleKey(localeKey)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Parameters
-
-
-
-
-
-
-
- Returns
- string:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
▸
-
getBrowserLanguages()
-
-
-
-
-
-
-
-
- getBrowserLanguages()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Localizer.Options
-
-
-
-
-
-
-
- Localizer.Options
-
-
- Type:
- {language: string, fallback: string}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ApplicationPlugin
-
-
-
-
-
-
- Represents a single plugin for applications. Allows developers to inject code in the start up process of an
-application providing new features to the application.
-
- new ApplicationPlugin()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Instance Members
-
-
-
-
-
-
-
-
-
- A preload method for the plugin which allows for asynchronous setup tasks. Either takes a callback as first
-parameter, or should return a Promise indicating that loading is finished.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Returns
- Promise:
- A promise indicating when the plugin is finished loading.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- An init method for the plugin. This method is ran synchronously in the constructor of the Application.
-After all plugins preloads has completed
-
- init()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- A start method for the plugin. This method is ran synchronously in the constructor of the Application.
-After all plugins inits has completed
-
- start()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-