Namespace STREAMSIX.BigScreen

Entry point to manage game sessions for BigScreen application

Call Init() before using this class. Target environment is automatically loaded from either PlayerPref or from Debugger if running in editor.

To switch to another environment at runtime, destroy the current BigScreenManager and create a new one. Call Init(S6Environment) with the new target environment.

This behaviour calls DontDestroyOnLoad(this) to keep itself alive across scene load.

Actor and RMB Build

Use BranchName to specify what rmb and actor to load in the cloud. This has no effect for running local RMB.

Manage session

BigScreen application manage the lifecycle of a session.

Call CreateSessionAsync(Int32, String, DistributionPayload, String, Boolean) to create a new session. This creates room and actor instances.

Use EndSessionAsync(Object) to end a session. This removes the room instance and discard the running actor. Call CreateSessionAsync(Int32, String, DistributionPayload, String, Boolean) again to create a new session.

BigScreen application should end the session before quitting.

Application Quit

If there is still an active session when BigScreen application quits, BigScreenManager may delay the quit process until session is ended.

BigScreenManager does this by listen for Application.wantsToQuit.

When running in Editor, because Editor ignores wantsToQuit, BigScreen application does not have time to send out the end session message. In this scenario, both room and actor instances are remove immediately. This means that if the actor normally perform some processing at end of session, it may not have the time to do so when BigScreen runs in Editor.

The best way to avoid this scenario is to build End Session into the game flow. Avoid relying on application quit to end the session.

Leaderboard client wrapper for the BigScreen that provides functions to access custom leaderboard.

Use this class to hook up various events from the SDK.

Entity client wrapper for the BigScreen that provides functions to access game data.

Inventory client wrapper for the BigScreen that provides functions to access item and product definition.

Leaderboard client wrapper for the BigScreen that provides functions to access points leaderboard.

Inventory client wrapper for the BigScreen that provides functions to access user's share inventory.

Entity client wrapper for the BigScreen that provides functions to access user data.

Inventory client wrapper for the BigScreen that provides functions to access user inventory.

Event when session ends.

First parameter is session id. Second parameter is exception if session did not end normally.