@my-swu/simulator-client / FormatSetupInput
Type Alias: FormatSetupInput
FormatSetupInput = {
bestOfGames:number;type:"premierSeries"; } | {bestOfGames:number;type:"eternalSeries"; } | {bestOfGames:number;type:"peasantSeries"; } | {bestOfGames:number;type:"previewSeries"; } | {bestOfGames:number;type:"openSeries"; } | {decks:DeckInput[];format:ConstructedFormat;type:"trilogy"; } | {commonBases:number[];packs:number[][];pool:number[];type:"sealed"; } | {commonBases:number[];packs:number[][];pool:number[];seatCount:number;type:"draft"; }
Defined in: packages/ts-sdk/src/generated/types/common.ts:1739
Optional format-event setup data supplied with match creation or joining.
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput)Union Members
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ bestOfGames: number; type: "premierSeries"; }
bestOfGames
bestOfGames:
number
Odd number of games used to determine the series winner.
type
type:
"premierSeries"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ bestOfGames: number; type: "eternalSeries"; }
bestOfGames
bestOfGames:
number
Odd number of games used to determine the series winner.
type
type:
"eternalSeries"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ bestOfGames: number; type: "peasantSeries"; }
bestOfGames
bestOfGames:
number
Odd number of games used to determine the series winner.
type
type:
"peasantSeries"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ bestOfGames: number; type: "previewSeries"; }
bestOfGames
bestOfGames:
number
Odd number of games used to determine the series winner.
type
type:
"previewSeries"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ bestOfGames: number; type: "openSeries"; }
bestOfGames
bestOfGames:
number
Odd number of games used to determine the series winner.
type
type:
"openSeries"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ decks: DeckInput[]; format: ConstructedFormat; type: "trilogy"; }
decks
decks:
DeckInput[]
Three validated Trilogy deck lists for this seat.
format
format:
ConstructedFormat
Constructed legality profile applied to all three decks.
type
type:
"trilogy"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ commonBases: number[]; packs: number[][]; pool: number[]; type: "sealed"; }
commonBases
commonBases:
number[]
Common bases from the selected set available outside the sealed pool.
packs
packs:
number[][]
Generated sealed pack contents; flattened into the sealed pool.
pool
pool:
number[]
Explicit sealed pool card ids.
type
type:
"sealed"
Type Literal
Example:
import type { FormatSetupInput } from '@my-swu/simulator-client'
const formatSetupInput: FormatSetupInput = {
"type": "premierSeries",
"bestOfGames": 1,
}
console.log(formatSetupInput){ commonBases: number[]; packs: number[][]; pool: number[]; seatCount: number; type: "draft"; }
commonBases
commonBases:
number[]
Common bases from the selected set available outside the drafted pool.
packs
packs:
number[][]
Draft packs assigned to this seat.
pool
pool:
number[]
Explicit drafted pool card ids, used after draft picks are modeled.
seatCount
seatCount:
number
Number of seats in the modeled draft pod.
type
type:
"draft"