Documentation

PlayerUpdateRequest

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

PlayerUpdateRequest

Optional Connection Info

  • connectionInfo: string

Connection information for connecting to a relay with this player.

memberof

PlayerUpdateRequest

deprecated

Optional Data

  • data: {}

Custom game-specific properties to add, update, or remove from the player (e.g. role or skill). To remove an existing property, include it in data but set the property object to null. To update the value to null, set the value property of the object to null.

memberof

PlayerUpdateRequest

Type declaration