@my-swu/simulator-client

---

@my-swu/simulator-client / LobbyConfig

Type Alias: LobbyConfig

LobbyConfig = { bestOfMatches: 1 | 3; format: MatchFormat; gameTimerEnabled: boolean; playerCount: number; trilogyFormat?: ConstructedFormat | null; type: "match"; } | { bestOfMatches: 1 | 3; draftRounds: object[]; eventKind: LimitedEventKind; gameTimerEnabled: boolean; pickTimerEnabled: boolean; playerCount: number; sealedPackCount?: number | null; setCode: string; tournament?: LimitedTournamentConfig | null; type: "limitedEvent"; }

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:133

Example:

import type { LobbyConfig } from '@my-swu/simulator-client'

const lobbyConfig: LobbyConfig = {
  "type": "match",
  "format": "premier",
  "playerCount": 2,
  "bestOfMatches": 1,
  "gameTimerEnabled": false,
}

console.log(lobbyConfig)

Union Members

Type Literal

Example:

import type { LobbyConfig } from '@my-swu/simulator-client'

const lobbyConfig: LobbyConfig = {
  "type": "match",
  "format": "premier",
  "playerCount": 2,
  "bestOfMatches": 1,
  "gameTimerEnabled": false,
}

console.log(lobbyConfig)

{ bestOfMatches: 1 | 3; format: MatchFormat; gameTimerEnabled: boolean; playerCount: number; trilogyFormat?: ConstructedFormat | null; type: "match"; }

bestOfMatches

bestOfMatches: 1 | 3

format

format: MatchFormat

gameTimerEnabled

gameTimerEnabled: boolean

Enables the AFK game timer for started lobby matches.

playerCount

playerCount: number

trilogyFormat?

optional trilogyFormat?: ConstructedFormat | null

Constructed legality profile used when format is trilogy.

type

type: "match"

---

Type Literal

Example:

import type { LobbyConfig } from '@my-swu/simulator-client'

const lobbyConfig: LobbyConfig = {
  "type": "match",
  "format": "premier",
  "playerCount": 2,
  "bestOfMatches": 1,
  "gameTimerEnabled": false,
}

console.log(lobbyConfig)

{ bestOfMatches: 1 | 3; draftRounds: object[]; eventKind: LimitedEventKind; gameTimerEnabled: boolean; pickTimerEnabled: boolean; playerCount: number; sealedPackCount?: number | null; setCode: string; tournament?: LimitedTournamentConfig | null; type: "limitedEvent"; }

bestOfMatches

bestOfMatches: 1 | 3

draftRounds

draftRounds: object[]

Per-round booster set configuration. Empty outside chaos draft.

eventKind

eventKind: LimitedEventKind

gameTimerEnabled

gameTimerEnabled: boolean

Enables the AFK game timer for started lobby matches.

pickTimerEnabled

pickTimerEnabled: boolean

Enables the per-pick countdown for chaos draft.

playerCount

playerCount: number

sealedPackCount?

optional sealedPackCount?: number | null

setCode

setCode: string

tournament?

optional tournament?: LimitedTournamentConfig | null

Pairs every pod seat into tournament rounds. Omitted by lobbies created before tournaments, which hand off to a single head-to-head match.

type

type: "limitedEvent"