Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyAccessResponse

Interface: LobbyAccessResponse ​

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:250

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

console.log(lobbyAccessResponse)

Properties ​

lobbyId ​

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

const { lobbyId } = lobbyAccessResponse

console.log(lobbyId)

lobbyId: string

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:251


playerId ​

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

const { playerId } = lobbyAccessResponse

console.log(playerId)

playerId: string

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:252


playerToken ​

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

const { playerToken } = lobbyAccessResponse

console.log(playerToken)

playerToken: string

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:253


private ​

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

const { private: lobbyAccessResponsePrivate } = lobbyAccessResponse

console.log(lobbyAccessResponsePrivate)

private: LobbyPrivateView

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:255


snapshot ​

Example:

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

const lobbyAccessResponse: LobbyAccessResponse = {
  "lobbyId": 'example',
  "playerId": 'example',
  "playerToken": 'example',
  "snapshot": {
    "lobbyId": 'example',
    "status": "waiting",
    "visibility": "private",
    "config": {
      "type": "match",
      "format": "premier",
      "playerCount": 2,
      "bestOfMatches": 1,
      "gameTimerEnabled": false,
    },
    "hostPlayerId": 'example',
    "requiredPlayerCount": 0,
    "players": [],
    "chat": [],
    "activity": [],
    "spectators": [],
  },
  "private": {
    "playerId": 'example',
    "role": "player",
    "host": false,
  },
}

const { snapshot: matchSnapshot } = lobbyAccessResponse

console.log(matchSnapshot)

snapshot: LobbySnapshot

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:254

Released under the MIT License.