Documentation

UpdateRequest

Properties

Optional Data

  • data: {}

Custom game-specific properties to add, update, or remove from the lobby (e.g. mapName or gameType). 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

UpdateRequest

Type declaration

Optional Host Id

  • hostId: string

The ID of the player to make the host of the lobby. As soon as this is updated, the current host will no longer have permission to modify the lobby.

memberof

UpdateRequest

Optional Is Locked

  • isLocked: boolean

Whether or not the lobby is locked. If true, new players will not be able to join.

memberof

UpdateRequest

Optional Is Private

  • isPrivate: boolean

Whether or not the lobby is private. Private lobbies do not appear in query results. If the lobby is not publicly visible, the creator can share the lobbyCode with other users who can use it to join this lobby.

memberof

UpdateRequest

Optional Max Players

  • maxPlayers: number

The maximum number of players that can be members of the lobby. Must be greater than or equal to the current number of players in the lobby.

memberof

UpdateRequest

Optional Name

  • name: string

The name of the lobby that should be displayed to users. All whitespace will be trimmed from the name.

memberof

UpdateRequest