@my-swu/simulator-client

---

@my-swu/simulator-client / MatchSeriesView

Interface: MatchSeriesView

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

Public match-series summary exposed in snapshots.

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

console.log(matchSeriesView)

Properties

bestOfGames

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { bestOfGames } = matchSeriesView

console.log(bestOfGames)

bestOfGames: number

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

Odd number of games used to determine the series winner.

---

canExtendSeries?

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { canExtendSeries } = matchSeriesView

console.log(canExtendSeries)

optional canExtendSeries?: boolean

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

Whether this finished single game may still become a best-of-three.

Engine-computed so clients never re-derive the eligibility rules. It says nothing about who owns the match: a room-managed game is rejected one layer up, in the match runtime.

---

canOfferRematch?

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { canOfferRematch } = matchSeriesView

console.log(canOfferRematch)

optional canOfferRematch?: boolean

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

Whether a rematch against the same opponent may be offered.

---

currentGameNumber

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { currentGameNumber } = matchSeriesView

console.log(currentGameNumber)

currentGameNumber: number

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

One-based current game number.

---

format

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { format } = matchSeriesView

console.log(format)

format: MatchFormat

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

Match format family for this series.

---

games

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { games } = matchSeriesView

console.log(games)

games: SeriesGameRecord[]

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

Completed game records.

---

limited?

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { limited } = matchSeriesView

console.log(limited)

optional limited?: LimitedEventView | null

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

Limited event summary, when Sealed or Draft provenance exists.

---

rematchReady?

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { rematchReady } = matchSeriesView

console.log(rematchReady)

optional rematchReady?: boolean

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

Whether every seat has asked for a rematch against the same opponent.

---

result?

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { result } = matchSeriesView

console.log(result)

optional result?: SeriesResultView | null

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

Completed series result.

---

seats

Example:

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

const matchSeriesView: MatchSeriesView = {
  "format": "premier",
  "bestOfGames": 1,
  "currentGameNumber": 0,
  "games": [],
  "seats": [],
}

const { seats } = matchSeriesView

console.log(seats)

seats: FormatSeatView[]

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

Per-seat format state.