Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LimitedEventSeatView

Interface: LimitedEventSeatView ​

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

Public summary for one event seat.

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

console.log(limitedEventSeatView)

Properties ​

hasPendingPick ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { hasPendingPick } = limitedEventSeatView

console.log(hasPendingPick)

hasPendingPick: boolean

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

Whether this seat has submitted the hidden pick for the current phase.


isAi? ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { isAi } = limitedEventSeatView

console.log(isAi)

optional isAi?: boolean

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

Whether a server AI controls this seat.


joined ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { joined } = limitedEventSeatView

console.log(joined)

joined: boolean

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

Whether a player has joined this seat.


leaderChoices ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { leaderChoices } = limitedEventSeatView

console.log(leaderChoices)

leaderChoices: number[]

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

Public leaders currently offered to this seat.


name? ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { name } = limitedEventSeatView

console.log(name)

optional name?: string | null

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

Public display name of the seat's player, when known.


pickedLeaders ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { pickedLeaders } = limitedEventSeatView

console.log(pickedLeaders)

pickedLeaders: number[]

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

Public leaders already kept by this seat.


playerId? ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { playerId } = limitedEventSeatView

console.log(playerId)

optional playerId?: string | null

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

Public player id used by clients for stable per-player avatar accents.


ready ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { ready } = limitedEventSeatView

console.log(ready)

ready: boolean

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

Whether this seat is ready during a review gate.


seatIndex ​

Example:

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

const limitedEventSeatView: LimitedEventSeatView = {
  "seatIndex": 0,
  "joined": false,
  "ready": false,
  "leaderChoices": [],
  "pickedLeaders": [],
  "hasPendingPick": false,
}

const { seatIndex } = limitedEventSeatView

console.log(seatIndex)

seatIndex: number

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

Zero-based seat index.

Released under the MIT License.