Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / PublicTournamentRoomSummary

Interface: PublicTournamentRoomSummary ​

Defined in: packages/ts-sdk/src/generated/types/common.ts:5171

Public summary used by tournament room browsers.

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

console.log(publicTournamentRoomSummary)

Properties ​

bestOfMatches ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { bestOfMatches } = publicTournamentRoomSummary

console.log(bestOfMatches)

bestOfMatches: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:5172


createdAtMs ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { createdAtMs } = publicTournamentRoomSummary

console.log(createdAtMs)

createdAtMs: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:5173


draftRounds ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { draftRounds } = publicTournamentRoomSummary

console.log(draftRounds)

draftRounds: DraftRoundConfig[]

Defined in: packages/ts-sdk/src/generated/types/common.ts:5174


eventKind ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { eventKind } = publicTournamentRoomSummary

console.log(eventKind)

eventKind: LimitedEventKind

Defined in: packages/ts-sdk/src/generated/types/common.ts:5175


playerCount ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { playerCount } = publicTournamentRoomSummary

console.log(playerCount)

playerCount: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:5176


requiredPlayerCount ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { requiredPlayerCount } = publicTournamentRoomSummary

console.log(requiredPlayerCount)

requiredPlayerCount: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:5177


roomId ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { roomId } = publicTournamentRoomSummary

console.log(roomId)

roomId: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:5178


sealedPackCount? ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { sealedPackCount } = publicTournamentRoomSummary

console.log(sealedPackCount)

optional sealedPackCount?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:5179


setCode ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { setCode } = publicTournamentRoomSummary

console.log(setCode)

setCode: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:5180


status ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { status: healthStatus } = publicTournamentRoomSummary

console.log(healthStatus)

status: TournamentRoomStatus

Defined in: packages/ts-sdk/src/generated/types/common.ts:5181


visibility ​

Example:

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

const publicTournamentRoomSummary: PublicTournamentRoomSummary = {
  "roomId": 'example',
  "status": "waiting",
  "visibility": "private",
  "eventKind": "draft",
  "setCode": 'example',
  "bestOfMatches": 1,
  "draftRounds": [],
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "createdAtMs": 0,
}

const { visibility } = publicTournamentRoomSummary

console.log(visibility)

visibility: LobbyVisibility

Defined in: packages/ts-sdk/src/generated/types/common.ts:5182

Released under the MIT License.