Documentation

BulkUpdateRequest

Properties

Optional Ignore Ineffectual Updates

  • ignoreIneffectualUpdates: boolean

Whether or not to silently ignore ineffectual updates (i.e. removing or updating players who are not in the lobby) instead of failing.

memberof

BulkUpdateRequest

Optional Lobby Update

memberof

BulkUpdateRequest

Optional Player Updates

  • playerUpdates: {}

A mapping from player IDs to player update requests.

memberof

BulkUpdateRequest

Type declaration

Optional Players To Add

An array of players to add to the lobby.

memberof

BulkUpdateRequest

Optional Players To Remove

  • playersToRemove: string[]

An array of player IDs to remove from the lobby.

memberof

BulkUpdateRequest