Documentation

Player

Properties

Optional Allocation Id

  • allocationId: string

The allocationId from the Relay service which associates this player in this lobby with a persistent connection. When a disconnect notification is received, this value is used to identify the associated player in a lobby to mark them as disconnected.

memberof

Player

Optional Connection Info

  • connectionInfo: string

Connection information for connecting to a relay with this player.

memberof

Player

deprecated

Optional Data

  • data: {}

Custom game-specific properties that apply to an individual player (e.g. role or skill).

memberof

Player

Type declaration

Optional Id

  • id: string

The unique identifier for the player. If not provided for a create or join request, it will be set to the ID of the caller.

memberof

Player

Optional Joined

  • joined: string

The time at which the player joined the lobby.

memberof

Player

Optional Last Updated

  • lastUpdated: string

The last time the metadata for this player was updated.

memberof

Player