Home Reference Source Test

Cdk-std Reference

summary
public

F asset(path: ...string): string

Returns the fully qualified URL to a static project asset.

public

Since your interactive controls can be run by any client, it's sometimes useful (particularly if you do fancier service integration) to be able to verify that the player is who they say they are. This method provides a means for you to do that. This is what happens:

  1. You create a cryptographically secure challenge for the user. This MUST be done on your service; the challenge is used so that adversaries cannot impersonate users (for instance, by gathering challenge responses for their own integrations then injecting those into your controls).

  2. Mixer servers will create a token based on the challenge and a secret, and return that in the response to this method.

  3. You may transmit the token and challenge to your services and call /api/v1/interactive/identity/verify to get the user ID that corresponds to the token. The API will return a 400 if the challenge is invalid.

Visualized, that's something like this:

public

F isLoaded()

This signals to Mixer that the controls have been bound and are ready to start taking Interactive calls.

public

F Control(options: IControlOptions): *

Scene is a decorator you can use to designate a class as a Scene.

public

F Input(_options: IInputOptions): *

public

F Scene(options: ISceneOptions): *

Scene is a decorator you can use to designate a class as a Scene.

public

Singleton Clock instance.

public

Singleton Display instance.

public

The list of available locales.

public

V log: {"debug": function, "info": function, "warn": function, "error": function}

log has methods to capture messages from your controls.

public

Singleton Navigation instance.

public

Your project's package configuration.

public

Singleton Socket instance.

Directories