Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / UpdateLobbyPlayerRequest

Interface: UpdateLobbyPlayerRequest ​

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

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

console.log(updateLobbyPlayerRequest)

Properties ​

authenticated? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { authenticated } = updateLobbyPlayerRequest

console.log(authenticated)

optional authenticated?: boolean | null

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

Optional replacement authentication state for this player.


avatarUrl? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { avatarUrl } = updateLobbyPlayerRequest

console.log(avatarUrl)

optional avatarUrl?: string | null

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

Optional public avatar image URL for this player. Blank strings clear the stored value; missing or null keeps the current value.


deck? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { deck: updateLobbyPlayerRequestDeck } = updateLobbyPlayerRequest

console.log(updateLobbyPlayerRequestDeck)

optional deck?: DeckInput | null

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


deckId? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { deckId } = updateLobbyPlayerRequest

console.log(deckId)

optional deckId?: string | null

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

Freeform client deck id for the submitted deck.


deckPlaceholder? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { deckPlaceholder } = updateLobbyPlayerRequest

console.log(deckPlaceholder)

optional deckPlaceholder?: boolean | null

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

Marks the submitted deck as a client default the player did not pick (e.g. the Twin Suns preset prefill). Placeholder decks do not arm the lobby auto-start countdown until every player is ready. Only meaningful alongside deck; reset whenever the deck changes.


deckTitle? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { deckTitle } = updateLobbyPlayerRequest

console.log(deckTitle)

optional deckTitle?: string | null

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

Optional display title for the submitted deck, shown to every player through the public [super::LobbyDeckPreview]. Only meaningful alongside deck; replaced (or cleared) whenever the deck changes.


formatSetup? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { formatSetup } = updateLobbyPlayerRequest

console.log(formatSetup)

optional formatSetup?: FormatSetupInput | null

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

Optional format-specific setup submitted with the lobby deck. Required by Trilogy match lobbies because the first deck only represents the active deck inside a three-deck set.


name? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { name } = updateLobbyPlayerRequest

console.log(name)

optional name?: string | null

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


playerToken ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { playerToken } = updateLobbyPlayerRequest

console.log(playerToken)

playerToken: string

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


profileUrl? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { profileUrl } = updateLobbyPlayerRequest

console.log(profileUrl)

optional profileUrl?: string | null

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

Optional public profile page URL for this player. Blank strings clear the stored value; missing or null keeps the current value.


ready? ​

Example:

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

const updateLobbyPlayerRequest: UpdateLobbyPlayerRequest = {
  "playerToken": 'example',
}

const { ready } = updateLobbyPlayerRequest

console.log(ready)

optional ready?: boolean | null

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

Released under the MIT License.