@my-swu/simulator-client

---

@my-swu/simulator-client / SimulatorAdminStatusResponse

Interface: SimulatorAdminStatusResponse

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

Admin status payload combining drain mode and live counters.

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

console.log(simulatorAdminStatusResponse)

Properties

acceptingNewMatches

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

const { acceptingNewMatches } = simulatorAdminStatusResponse

console.log(acceptingNewMatches)

acceptingNewMatches: boolean

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

Whether the engine is accepting new matches/sessions.

---

checkedAtMs

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

const { checkedAtMs } = simulatorAdminStatusResponse

console.log(checkedAtMs)

checkedAtMs: number

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

Epoch milliseconds when this status was generated.

---

maintenance

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

const { maintenance } = simulatorAdminStatusResponse

console.log(maintenance)

maintenance: MaintenanceStatus

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

Current drain-mode state.

---

ranked

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

const { ranked } = simulatorAdminStatusResponse

console.log(ranked)

ranked: RankedAdminStatus

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

Ranked-ladder availability and queue health.

---

stats

Example:

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

const simulatorAdminStatusResponse: SimulatorAdminStatusResponse = {
  "acceptingNewMatches": false,
  "maintenance": {
    "enabled": false,
  },
  "stats": {
    "activeMatches": 0,
    "retainedFinishedMatches": 0,
    "waitingLobbies": 0,
    "activeLimitedEvents": 0,
    "tournamentRooms": 0,
  },
  "ranked": {
    "enabled": false,
    "adminAdmissionEnabled": false,
    "admissionEnabled": false,
    "searchingCount": 0,
    "pendingMatches": 0,
  },
  "checkedAtMs": 0,
}

const { stats } = simulatorAdminStatusResponse

console.log(stats)

stats: SimulatorRuntimeStats

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

Current operational counters.