Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyClosedReason

Type Alias: LobbyClosedReason ​

LobbyClosedReason = "hostLeft" | "allPlayersLeft" | "allDisconnected" | "matchmakingClosed" | "relocated" | "pruned" | "completed" | "unknown"

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

Why a lobby stopped admitting its participants.

Carried by the lobby closed socket message and by [super::LobbySnapshot::closed_reason]. New variants may be added; clients should treat an unknown reason like [LobbyClosedReason::Unknown].

Example:

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

const lobbyClosedReason: LobbyClosedReason = "hostLeft"

console.log(lobbyClosedReason)

Released under the MIT License.