Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyPlayerView

Interface: LobbyPlayerView ​

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

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

console.log(lobbyPlayerView)

Properties ​

aiDifficulty? ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { aiDifficulty } = lobbyPlayerView

console.log(aiDifficulty)

optional aiDifficulty?: AiDifficulty | null

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


authenticated ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { authenticated } = lobbyPlayerView

console.log(authenticated)

authenticated: boolean

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

Whether this player joined from an authenticated app session.


avatarUrl? ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { avatarUrl } = lobbyPlayerView

console.log(avatarUrl)

optional avatarUrl?: string | null

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

Public avatar image URL supplied by this player, if any.


connected ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { connected } = lobbyPlayerView

console.log(connected)

connected: boolean

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


controller ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { controller } = lobbyPlayerView

console.log(controller)

controller: LobbyPlayerController

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


deck? ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { deck: lobbyPlayerViewDeck } = lobbyPlayerView

console.log(lobbyPlayerViewDeck)

optional deck?: LobbyDeckPreview | null

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

Public preview of this player's submitted deck. Deliberately limited to identity cards and the display title — main-deck contents stay private to the owner.


deckReady ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { deckReady } = lobbyPlayerView

console.log(deckReady)

deckReady: boolean

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


host ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { host: lobbyPlayerViewHost } = lobbyPlayerView

console.log(lobbyPlayerViewHost)

host: boolean

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


joinedAtMs ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { joinedAtMs } = lobbyPlayerView

console.log(joinedAtMs)

joinedAtMs: number

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


name ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { name } = lobbyPlayerView

console.log(name)

name: string

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


playerId ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { playerId } = lobbyPlayerView

console.log(playerId)

playerId: string

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


profileUrl? ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { profileUrl } = lobbyPlayerView

console.log(profileUrl)

optional profileUrl?: string | null

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

Public profile page URL supplied by this player, if any.


ready ​

Example:

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

const lobbyPlayerView: LobbyPlayerView = {
  "playerId": 'example',
  "name": 'example',
  "authenticated": false,
  "controller": "human",
  "host": false,
  "connected": false,
  "deckReady": false,
  "ready": false,
  "joinedAtMs": 0,
}

const { ready } = lobbyPlayerView

console.log(ready)

ready: boolean

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

Released under the MIT License.