SWU Simulator SDK

Appearance

@my-swu/simulator-client

@my-swu/simulator-client / SeatState

Interface: SeatState ​

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

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

console.log(seatState)

Properties ​

authenticated ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { authenticated } = seatState

console.log(authenticated)

authenticated: boolean

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

Whether this player joined from an authenticated app session.

autoPassed ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { autoPassed } = seatState

console.log(autoPassed)

autoPassed: boolean

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

avatarUrl? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { avatarUrl } = seatState

console.log(avatarUrl)

optional avatarUrl?: string | null

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

Optional public avatar image URL for this player.

base? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { base } = seatState

console.log(base)

optional base?: number | null

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

baseDamage ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { baseDamage } = seatState

console.log(baseDamage)

baseDamage: number

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

Public damage currently marked on this base.

baseEpicActionUsed ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { baseEpicActionUsed } = seatState

console.log(baseEpicActionUsed)

baseEpicActionUsed: boolean

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

Whether this base's once-per-game epic action has been spent.

baseHp ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { baseHp } = seatState

console.log(baseHp)

baseHp: number

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

Public remaining base health after damage.

baseUpgrades ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { baseUpgrades } = seatState

console.log(baseUpgrades)

baseUpgrades: UpgradeStateView[]

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

Upgrades attached to this player's base.

capturedUnits ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { capturedUnits } = seatState

console.log(capturedUnits)

capturedUnits: CapturedUnitView[]

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

cardsDrawnThisTurn? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { cardsDrawnThisTurn } = seatState

console.log(cardsDrawnThisTurn)

optional cardsDrawnThisTurn?: number[] | null

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

Physical ids of the cards this seat drew during the current turn — drives the client's "just drawn" badge. Serialized only for the viewing seat's own seat: which cards a player drew is hidden information for everyone else.

creditTokens ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { creditTokens } = seatState

console.log(creditTokens)

creditTokens: number

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

deckCount ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { deckCount } = seatState

console.log(deckCount)

deckCount: number

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

deckSubmitted ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { deckSubmitted } = seatState

console.log(deckSubmitted)

deckSubmitted: boolean

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

Whether this seat has a deck registered. Seats may join without a deck and submit one later; the seat cannot ready until this is true.

deckTopCard? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { deckTopCard } = seatState

console.log(deckTopCard)

optional deckTopCard?: number | null

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

Top card of this deck when the viewer has an active look-at-deck-top permission.

discard ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { discard } = seatState

console.log(discard)

discard: CardInstanceView[]

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

discardCount ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { discardCount } = seatState

console.log(discardCount)

discardCount: number

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

eliminated ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { eliminated } = seatState

console.log(eliminated)

eliminated: boolean

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

forceTokenActive ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { forceTokenActive } = seatState

console.log(forceTokenActive)

forceTokenActive: boolean

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

hand? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { hand } = seatState

console.log(hand)

optional hand?: CardInstanceView[] | null

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

handCount ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { handCount } = seatState

console.log(handCount)

handCount: number

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

joined ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { joined } = seatState

console.log(joined)

joined: boolean

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

leader? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leader } = seatState

console.log(leader)

optional leader?: number | null

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

DEPRECATED: read [Self::leaders] for multi-leader-safe state.

leaderDeployAvailable ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leaderDeployAvailable } = seatState

console.log(leaderDeployAvailable)

leaderDeployAvailable: boolean

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

DEPRECATED: read [Self::leaders] for multi-leader-safe state.

leaderDeployed ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leaderDeployed } = seatState

console.log(leaderDeployed)

leaderDeployed: boolean

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

DEPRECATED: read [Self::leaders] for multi-leader-safe state.

leaderExhausted ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leaderExhausted } = seatState

console.log(leaderExhausted)

leaderExhausted: boolean

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

DEPRECATED: read [Self::leaders] for multi-leader-safe state.

leaders ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leaders } = seatState

console.log(leaders)

leaders: LeaderStateView[]

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

leaderUnitId? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { leaderUnitId } = seatState

console.log(leaderUnitId)

optional leaderUnitId?: number | null

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

DEPRECATED: read [Self::leaders] for multi-leader-safe state.

mulliganTaken ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { mulliganTaken } = seatState

console.log(mulliganTaken)

mulliganTaken: boolean

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

name? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { name } = seatState

console.log(name)

optional name?: string | null

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

Human-friendly display name captured when this seat joined the match. Public — visible to every viewer so the UI can render per-player labels in multiplayer ("Give to Akryum", "Resolve Bob's first") instead of bare seat enums. None when the joining client did not supply a name; the UI should fall back to the seat identifier in that case.

profileUrl? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { profileUrl } = seatState

console.log(profileUrl)

optional profileUrl?: string | null

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

Optional public profile page URL for this player.

ready ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { ready } = seatState

console.log(ready)

ready: boolean

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

resourceExhaustedStates ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { resourceExhaustedStates } = seatState

console.log(resourceExhaustedStates)

resourceExhaustedStates: boolean[]

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

Public exhausted-state row for resources, one boolean per resource slot. Resource card identities still live in resources and are only projected to the owning viewer.

resources? ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { resources } = seatState

console.log(resources)

optional resources?: ResourceCardView[] | null

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

resourcesCount ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { resourcesCount } = seatState

console.log(resourcesCount)

resourcesCount: number

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

seat ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { seat: seatStateSeat } = seatState

console.log(seatStateSeat)

seat: Seat

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

sideboardCount ​

Example:

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

const seatState: SeatState = {
  "seat": "one",
  "joined": false,
  "deckSubmitted": false,
  "ready": false,
  "eliminated": false,
  "authenticated": false,
  "leaderExhausted": false,
  "leaderDeployed": false,
  "leaderDeployAvailable": false,
  "leaders": [],
  "baseEpicActionUsed": false,
  "baseDamage": 0,
  "baseHp": 0,
  "baseUpgrades": [],
  "deckCount": 0,
  "sideboardCount": 0,
  "handCount": 0,
  "resourcesCount": 0,
  "resourceExhaustedStates": [],
  "capturedUnits": [],
  "creditTokens": 0,
  "forceTokenActive": false,
  "discardCount": 0,
  "discard": [],
  "autoPassed": false,
  "mulliganTaken": false,
}

const { sideboardCount } = seatState

console.log(sideboardCount)

sideboardCount: number

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

Number of cards in the seat's sideboard.

Released under the MIT License.

Copyright © 2025-present Guillaume Chau