View Source Teiserver.Game.LobbySummary (Teiserver v0.0.4)

LobbySummary

A type used to represent only part of a lobby (e.g. for lists of lobbies)

Attributes

:id - The id of the lobby in question
:host_id - The user_id of the creator of the lobby
:match_ongoing? - True if the match is currently in progress
:name - The name of the lobby as displayed in lobby lists
:tags - A list of strings representing tagged values
:password - The (plaintext) password for the lobby, nil if no password
:locked? - Boolean of the room being locked to the general public at this stage
:public? - Boolean of the room being public or not, when set to false updates to this lobby won't appear in global_battle updates
:rated? - When set to true it means the game will be rated (assuming all other requirements are met)
:queue_id - The ID of the queue (matchmaking) this lobby belongs to
:game_name - String of the game name
:game_version - String of the game version
:player_count - Count of the number of players
:spectator_count - Count of the number of spectators

Summary

Types

t()

A lobby

Functions

new(lobby)

Types

t()

@type t() :: %Teiserver.Game.LobbySummary{
  game_name: String.t() | nil,
  game_version: String.t() | nil,
  host_id: Teiserver.user_id() | nil,
  id: Teiserver.lobby_id() | nil,
  locked?: boolean(),
  match_ongoing?: boolean(),
  name: String.t() | nil,
  passworded?: boolean(),
  player_count: non_neg_integer(),
  public?: boolean(),
  rated?: boolean(),
  spectator_count: non_neg_integer(),
  tags: [String.t()]
}

A lobby

Functions

new(lobby)

@spec new(Teiserver.Game.Lobby.t()) :: t()