SWU Simulator SDK

Appearance

@my-swu/simulator-client

@my-swu/simulator-client / PublicLobbySummary

Interface: PublicLobbySummary ​

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

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

console.log(publicLobbySummary)

Properties ​

canJoinAsPlayer ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { canJoinAsPlayer } = publicLobbySummary

console.log(canJoinAsPlayer)

canJoinAsPlayer: boolean

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

canSpectate ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { canSpectate } = publicLobbySummary

console.log(canSpectate)

canSpectate: boolean

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

config ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { config } = publicLobbySummary

console.log(config)

config: LobbyConfig

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

createdAtMs ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { createdAtMs } = publicLobbySummary

console.log(createdAtMs)

createdAtMs: number

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

deckPreviews ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { deckPreviews } = publicLobbySummary

console.log(deckPreviews)

deckPreviews: LobbyDeckPreview[]

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

lobbyId ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { lobbyId } = publicLobbySummary

console.log(lobbyId)

lobbyId: string

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

playerCount ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { playerCount } = publicLobbySummary

console.log(playerCount)

playerCount: number

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

requiredPlayerCount ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { requiredPlayerCount } = publicLobbySummary

console.log(requiredPlayerCount)

requiredPlayerCount: number

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

spectatorCount ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { spectatorCount } = publicLobbySummary

console.log(spectatorCount)

spectatorCount: number

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

status ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { status: healthStatus } = publicLobbySummary

console.log(healthStatus)

status: LobbyStatus

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

visibility ​

Example:

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

const publicLobbySummary: PublicLobbySummary = {
  "lobbyId": 'example',
  "status": "waiting",
  "visibility": "private",
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "requiredPlayerCount": 0,
  "playerCount": 2,
  "spectatorCount": 0,
  "canJoinAsPlayer": false,
  "canSpectate": false,
  "deckPreviews": [],
  "createdAtMs": 0,
}

const { visibility } = publicLobbySummary

console.log(visibility)

visibility: LobbyVisibility

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

Released under the MIT License.

Copyright © 2025-present Guillaume Chau