resets the timer, does not call subscribed functions

Calls all subscribed functions, and resets the timer.

Adds a function to be called when timer is dispatched

Removes a function from being called when timer is dispatched

Gets data from SpringRoll Container

Sends data to SpringRoll Container

Removes data from SpringRoll Container

Checks if the current date falls within a provided date range.

// Check if current date is within Christmas season

import { DateUtil } from "springroll";

if (DateUtil.isInSeason('2024-12-01', '2024-12-31')) {
  showChristmasContent();
}

// Using Date objects

import { DateUtil } from "springroll";

const summerStart = new Date(2024, 5, 21); // June 21, 2024
const summerEnd = new Date(2024, 8, 22);   // September 22, 2024
if (DateUtil.isInSeason(summerStart, summerEnd)) {
  showSummerContent();
}

Calculates the offset for anchors.

Adds and anchor to be updated during resize

Type: Array<ScaledEntity>

Type: EntityResizeEvent

Removes an anchor

Enables the scale manager listener. Will not be enabled if a callback is not supplied.

Disables the scale manager.

Whether or not the application is running on an iOS device.

Returns the enabled state of the ResizeHelper.

Sets the enabled state of the ResizeHelper. Forces a resize event.

Handler for window resize events. Forwards this event to the scale manager if enabled.

Sets the window width and window height values of the ResizeHelper.

Enables the scale manager listener. Will not be enabled if a callback is not supplied.

Disables the scale manager.

Pauses the announcer.

Resumes the announcer.

Pauses the announcer and clears the queue.

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.

Sets the voice by array index.

Returns the voice object.

Rate at which text is spoken.

Returns rate which text is spoken.

Sets the pitch at which text is spoken.

Returns the pitch at which text is spoken.

Sets the current volume of the announcer.

Returns the current volume of the announcer.

Applies the specified filter to the element.

Changes the currently applied filter to the element if the color filter has it.

Removes the filter from the element.

Supported filter types.

Calls all functions for buttons that are currently set to enabled.

Called on keyup. Sets flag to 1 if key is being watched.

Called on keyup. Sets flag to 2 if key is being watched.

Sets an object of button functions to the controller to be called.

Called on window blur, sets button state to up if button was down;

Updates the internal state of the key. Accepts a range between 0-2. Will set key state to 0 if nothing is passed.

Calls the relevant action for the current state of the key.

Returns the current state of the key.

preloads, initializes and starts plugins.

The list of plugins that are currently registered to run on Applications.

Registers a plugin to be used by applications, sorting it by priority order.

Finds a plugin by name.

returns instance of a plugin.

Validates that appropriate listeners are added for the features that were enabled in the constructor

• any: Error

Sets default values of application state properties.

Returns the params of the debugger.

Sets the logging level of the debugger.

If emitting is enabled for this instance, then it will dispatch an event on the window.

Returns logging levels.

Console logs all supplied arguments if the log level is low enough for them to be logged.

Will throw if statement is false.

Returns a boolean indicating if the debugger has been enabled or not.

Disables or enables all debugger instances. TODO: Remove the parameter here, and add a disable method as well

Returns the global params key.

invokes the next hint

removes all hints

The current value of the property

Type: any

Setting this value notifies all listeners of the change.

Type: any

Adds a subscriber to this property.

Unsubscribes a listener from this property.

Whether or not this property has any subscribed listeners

Type: Boolean

Updates content based on time passed. This should be called every frame that the caption is active.

Handles calling callbacks and updating caption's current state.

Checks if caption has completed.

Sets time and line index of caption.

Updates the current time and index of the caption instance

Updates content based on time passed. This should be called every frame that the caption is active.

Handles calling callbacks and updating caption's current state.

Checks if caption has completed.

Sets time and line index of caption.

Updates the current time and index of the caption instance

Creates a new Object<String, Caption>.

Creates a new Caption from JSON data.

Creates a new TimedLine from JSON data.

Updates any currently playing caption. This should be called every frame.

Starts playing a caption.

Stops any caption currently playing.

Updates any currently playing caption. This should be called every frame.

Starts playing a caption.

Stops any caption currently playing.

Sets line's content. Removes HTML formatting for text.

Makes target element visible and ready to present captions

H

Called by Caption Player when a new line needs to be displayed

Called by Caption Player when a line is complete

Called by Caption Player when a new line needs to be displayed

Called by Caption Player when a line is complete

Will attempt to remove all html from a string before it's renderer to the page

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.

An init method for the plugin. This method is ran synchronously in the constructor of the Application. After all plugins preloads has completed

A start method for the plugin. This method is ran synchronously in the constructor of the Application. After all plugins inits has completed