Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyServerMessage

Type Alias: LobbyServerMessage ​

LobbyServerMessage = { payload: { lobbyId: string; playerId: string; }; type: "welcome"; } | { payload: LobbySnapshot; type: "snapshot"; } | { payload: LobbyAccessResponse; type: "matchmakingRelocated"; } | { payload: LobbyChatMessage; type: "chatMessage"; } | { payload: RoomPlayerPresenceEvent; type: "playerPresence"; } | { type: "started"; } | { payload: LobbyKickedPayload; type: "kicked"; } | { payload: ErrorPayload; type: "error"; } | { payload: { nonce?: string | null; }; type: "pong"; } | { payload: LobbyClosedPayload; type: "closed"; } | { payload: LobbyPrivateView; type: "privateView"; }

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

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

Union Members ​

Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: { lobbyId: string; playerId: string; }; type: "welcome"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbySnapshot; type: "snapshot"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbyAccessResponse; type: "matchmakingRelocated"; }

A ranked sweep moved this player into a paired lobby; reconnect with the supplied access.


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbyChatMessage; type: "chatMessage"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: RoomPlayerPresenceEvent; type: "playerPresence"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ type: "started"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbyKickedPayload; type: "kicked"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: ErrorPayload; type: "error"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: { nonce?: string | null; }; type: "pong"; }


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbyClosedPayload; type: "closed"; }

The lobby closed; a 4000/lobby_closed close frame follows.


Type Literal ​

Example:

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

const lobbyServerMessage: LobbyServerMessage = {
  "type": "welcome",
  "payload": {
    "lobbyId": 'example',
    "playerId": 'example',
  },
}

console.log(lobbyServerMessage)

{ payload: LobbyPrivateView; type: "privateView"; }

This participant's private view changed (host transfer, AI seats, started access).

Released under the MIT License.