Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / MatchSpectatorAccessResponse

Interface: MatchSpectatorAccessResponse ​

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

Example:

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

const matchSpectatorAccessResponse: MatchSpectatorAccessResponse = {
  "matchId": 'example',
  "spectatorToken": 'example',
  "snapshot": {
    "matchId": 'example',
    "format": "premier",
    "playerCount": 2,
    "series": {
      "format": "premier",
      "bestOfGames": 1,
      "currentGameNumber": 0,
      "games": [],
      "seats": [],
    },
    "status": "lobby",
    "phase": "lobby",
    "prompt": "lobbyReady",
    "roundNumber": 0,
    "turnPlayer": "one",
    "initiative": {
      "available": false,
    },
    "availableCounters": [],
    "consecutivePasses": 0,
    "winners": [],
    "eventsApplied": 0,
    "activeEffects": [],
    "delayedEffects": [],
    "currentAttack": {
      "attackerId": 0,
      "target": {
        "playerBase": {
          "seat": "one",
        },
      },
    },
    "pendingAbilities": [],
    "availableLeaderDeploys": [],
    "availableAttacks": [],
    "playActions": [],
    "rejectedPlayReasons": [],
    "actionAbilities": [],
    "groundArena": [],
    "spaceArena": [],
    "players": [],
  },
}

console.log(matchSpectatorAccessResponse)

Properties ​

matchId ​

Example:

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

const matchSpectatorAccessResponse: MatchSpectatorAccessResponse = {
  "matchId": 'example',
  "spectatorToken": 'example',
  "snapshot": {
    "matchId": 'example',
    "format": "premier",
    "playerCount": 2,
    "series": {
      "format": "premier",
      "bestOfGames": 1,
      "currentGameNumber": 0,
      "games": [],
      "seats": [],
    },
    "status": "lobby",
    "phase": "lobby",
    "prompt": "lobbyReady",
    "roundNumber": 0,
    "turnPlayer": "one",
    "initiative": {
      "available": false,
    },
    "availableCounters": [],
    "consecutivePasses": 0,
    "winners": [],
    "eventsApplied": 0,
    "activeEffects": [],
    "delayedEffects": [],
    "currentAttack": {
      "attackerId": 0,
      "target": {
        "playerBase": {
          "seat": "one",
        },
      },
    },
    "pendingAbilities": [],
    "availableLeaderDeploys": [],
    "availableAttacks": [],
    "playActions": [],
    "rejectedPlayReasons": [],
    "actionAbilities": [],
    "groundArena": [],
    "spaceArena": [],
    "players": [],
  },
}

const { matchId } = matchSpectatorAccessResponse

console.log(matchId)

matchId: string

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


snapshot ​

Example:

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

const matchSpectatorAccessResponse: MatchSpectatorAccessResponse = {
  "matchId": 'example',
  "spectatorToken": 'example',
  "snapshot": {
    "matchId": 'example',
    "format": "premier",
    "playerCount": 2,
    "series": {
      "format": "premier",
      "bestOfGames": 1,
      "currentGameNumber": 0,
      "games": [],
      "seats": [],
    },
    "status": "lobby",
    "phase": "lobby",
    "prompt": "lobbyReady",
    "roundNumber": 0,
    "turnPlayer": "one",
    "initiative": {
      "available": false,
    },
    "availableCounters": [],
    "consecutivePasses": 0,
    "winners": [],
    "eventsApplied": 0,
    "activeEffects": [],
    "delayedEffects": [],
    "currentAttack": {
      "attackerId": 0,
      "target": {
        "playerBase": {
          "seat": "one",
        },
      },
    },
    "pendingAbilities": [],
    "availableLeaderDeploys": [],
    "availableAttacks": [],
    "playActions": [],
    "rejectedPlayReasons": [],
    "actionAbilities": [],
    "groundArena": [],
    "spaceArena": [],
    "players": [],
  },
}

const { snapshot: matchSnapshot } = matchSpectatorAccessResponse

console.log(matchSnapshot)

snapshot: GameState

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


spectatorToken ​

Example:

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

const matchSpectatorAccessResponse: MatchSpectatorAccessResponse = {
  "matchId": 'example',
  "spectatorToken": 'example',
  "snapshot": {
    "matchId": 'example',
    "format": "premier",
    "playerCount": 2,
    "series": {
      "format": "premier",
      "bestOfGames": 1,
      "currentGameNumber": 0,
      "games": [],
      "seats": [],
    },
    "status": "lobby",
    "phase": "lobby",
    "prompt": "lobbyReady",
    "roundNumber": 0,
    "turnPlayer": "one",
    "initiative": {
      "available": false,
    },
    "availableCounters": [],
    "consecutivePasses": 0,
    "winners": [],
    "eventsApplied": 0,
    "activeEffects": [],
    "delayedEffects": [],
    "currentAttack": {
      "attackerId": 0,
      "target": {
        "playerBase": {
          "seat": "one",
        },
      },
    },
    "pendingAbilities": [],
    "availableLeaderDeploys": [],
    "availableAttacks": [],
    "playActions": [],
    "rejectedPlayReasons": [],
    "actionAbilities": [],
    "groundArena": [],
    "spaceArena": [],
    "players": [],
  },
}

const { spectatorToken } = matchSpectatorAccessResponse

console.log(spectatorToken)

spectatorToken: string

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

Released under the MIT License.