1681-engine / index / RoomState

Interface: RoomState

Defined in: src/net/lobby/lobbyProtocol.ts:27

Your own room, whole.

Extends

• RoomSummary

Properties

busy

busy: boolean;

Defined in: src/net/lobby/lobbyProtocol.ts:16

The room is in the matchmaking queue or its game has started: nobody joins.

Inherited from

RoomSummary.busy

---

code

code: string;

Defined in: src/net/lobby/lobbyProtocol.ts:29

The code a friend joins a private room by.

---

host

host: number;

Defined in: src/net/lobby/lobbyProtocol.ts:30

---

id

id: string;

Defined in: src/net/lobby/lobbyProtocol.ts:8

Inherited from

RoomSummary.id

---

maxPlayers

maxPlayers: number;

Defined in: src/net/lobby/lobbyProtocol.ts:12

Inherited from

RoomSummary.maxPlayers

---

members

members: RoomMember[];

Defined in: src/net/lobby/lobbyProtocol.ts:31

---

mode

mode: string;

Defined in: src/net/lobby/lobbyProtocol.ts:10

Inherited from

RoomSummary.mode

---

name

name: string;

Defined in: src/net/lobby/lobbyProtocol.ts:9

Inherited from

RoomSummary.name

---

players

players: number;

Defined in: src/net/lobby/lobbyProtocol.ts:11

Inherited from

RoomSummary.players

---

private

private: boolean;

Defined in: src/net/lobby/lobbyProtocol.ts:14

Joined only by its code. Private rooms are never listed; this is set on your own room's state.

Inherited from

RoomSummary.private

---

queued

queued: boolean;

Defined in: src/net/lobby/lobbyProtocol.ts:35

In the matchmaking queue as one group.

---

settings

settings: unknown;

Defined in: src/net/lobby/lobbyProtocol.ts:33

The game's own settings for it (a map, a difficulty); only the host changes them.