Namespace StreamSIX
Classes
AppConfigDef
BigScreenConfig
BigScreenManager
Entry point to manage game sessions for BigScreen application
This behaviour calls DontDestroyOnLoad(this) to keep itself alive across scene load.
Actor
Use ActorTag to specify what actor to load in the cloud. This has no effect for running local RMB.
Local RMB
Sets LocalRMB config when running rmb locally. When this is null, RMB will be spawned in the cloud.
Manage session
BigScreen application manage the lifecycle of a session.
Call CreateSessionAsync(UserManager, Int32) 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(UserManager, Int32) 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.
CleanUpUsersException
ClientConfig
ClientManager
Entry point to manage game sessions for the Client application
This behaviour calls DontDestroyOnLoad(this) to keep itself alive across scene load.
Join
Call JoinRoomAsync(UserManager, String, String, String) to join a session. This connects to the actor.
Manage session
Call EndSession() at end of gameplay to stop client from attempting to reconnect.
CreateRoomException
DeleteMessageBusException
DeleteRoomException
DeleteUserEntityException
Dispatcher
Dispatcher validates the join code and returns the join info
EntityManager
EntityManager is a cloud resource that stores game and user data.
See !:EntityType
for the 3 types of entity.
This SDK only provide functions that BigScreen/Client have permission to access.
A registered user is required to access user entity. Guest user is able to access game entity.
LicenseID is used to specify the game.
This behaviour calls DontDestroyOnLoad(this) to keep itself alive across scene load.
EntityManagerConfig
GetGameEntityException
GetJoinCodeException
GetLatestPlayersTimeoutException
GetLatestScoresTimeoutException
GetMessageBusException
GetRoomException
GetTopPlayersTimeoutException
GetUserEntityException
JoinCodeData
JoinInfoDef
JoinRoomException
LocalRMBConfig
Configuration to spawn RMB locally.
Attach this object to BigScreenConfig to spawn RMB locally
MessageBusPlayerInfo
Player data return from message bus. When the return data does not implied score, Score and Rank are -1.