Beamable SDK
Public Member Functions | List of all members
Beamable.Experimental.Api.Sim.GameRelayService Class Reference

This type defines the Client main entry point for the Multiplayer feature. More...

Public Member Functions

 GameRelayService (IPlatformService platform, PlatformRequester requester)
 
Promise< GameRelaySyncMsgSync (string roomId, GameRelaySyncMsg request)
 Report a set of events to the relay. More...
 
Promise< GameResultsReportResults (string roomId, params PlayerResult[] results)
 Report the results of the game to the platform. More...
 

Detailed Description

This type defines the Client main entry point for the Multiplayer feature.

Related Links

img beamable-logo

Member Function Documentation

◆ ReportResults()

Promise< GameResults > Beamable.Experimental.Api.Sim.GameRelayService.ReportResults ( string  roomId,
params PlayerResult[]  results 
)
inline

Report the results of the game to the platform.

Parameters
roomIdThe ID of the game session.
resultsThe array of PlayerResult to send to the platform for verification.
Returns
A promise of the confirmed game results

◆ Sync()

Promise< GameRelaySyncMsg > Beamable.Experimental.Api.Sim.GameRelayService.Sync ( string  roomId,
GameRelaySyncMsg  request 
)
inline

Report a set of events to the relay.

Parameters
roomIdThe relay room id
requestA GameRelaySyncMsg
Returns
A Promise containing a GameRelaySyncMsg will the messages that other players generatoed

The documentation for this class was generated from the following file: