Documentation

CreateRequest

Properties

Optional Data

  • data: {}

Custom game-specific properties that apply to the lobby (e.g. mapName or gameType).

memberof

CreateRequest

Type declaration

Optional Is Locked

  • isLocked: boolean

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

memberof

CreateRequest

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

CreateRequest

Max Players

  • maxPlayers: number

The maximum number of players that can be members of the lobby.

memberof

CreateRequest

Name

  • name: string

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

memberof

CreateRequest

Optional Player

memberof

CreateRequest