1681-engine / index / LobbyRooms

Class: LobbyRooms

Defined in: src/net/lobby/LobbyRooms.ts:28

The rooms of a lobby and who is in which, with no sockets: create, join by id or code, leave (the host's place passing to the next member, an empty room closing), kick, ready. LobbyHost speaks for it.

Constructors

Constructor

new LobbyRooms(random?): LobbyRooms;

Defined in: src/net/lobby/LobbyRooms.ts:34

Parameters

Parameter	Type	Default value
random	() => number	Math.random

Returns

LobbyRooms

Accessors

count

Get Signature

get count(): number;

Defined in: src/net/lobby/LobbyRooms.ts:36

Returns

number

Methods

all()

all(): IterableIterator<LobbyRoom>;

Defined in: src/net/lobby/LobbyRooms.ts:52

Returns

IterableIterator<LobbyRoom>

---

allReady()

allReady(room): boolean;

Defined in: src/net/lobby/LobbyRooms.ts:96

Everyone but the host has said they are ready.

Parameters

Parameter	Type
room	LobbyRoom

Returns

boolean

---

byInvite()

byInvite(code): LobbyRoom | undefined;

Defined in: src/net/lobby/LobbyRooms.ts:44

Parameters

Parameter	Type
code	string

Returns

LobbyRoom | undefined

---

create()

create(host, o): LobbyRoom;

Defined in: src/net/lobby/LobbyRooms.ts:56

Parameters

Parameter	Type
host	number
o	{ maxPlayers: number; mode: string; name: string; private: boolean; settings: unknown; }
o.maxPlayers	number
o.mode	string
o.name	string
o.private	boolean
o.settings	unknown

Returns

LobbyRoom

---

get()

get(id): LobbyRoom | undefined;

Defined in: src/net/lobby/LobbyRooms.ts:40

Parameters

Parameter	Type
id	string

Returns

LobbyRoom | undefined

---

join()

join(player, room): void;

Defined in: src/net/lobby/LobbyRooms.ts:68

Parameters

Parameter	Type
player	number
room	LobbyRoom

Returns

void

---

leave()

leave(player): 
  | {
  closed: boolean;
  room: LobbyRoom;
}
  | null;

Defined in: src/net/lobby/LobbyRooms.ts:75

Takes a player out of their room; returns the room (closed when it emptied, closed true).

Parameters

Parameter	Type
player	number

Returns

| { closed: boolean; room: LobbyRoom; } | null

---

listed()

listed(limit): RoomSummary[];

Defined in: src/net/lobby/LobbyRooms.ts:110

The rooms anyone may browse: public, open, not full; the fullest first, so players gather.

Parameters

Parameter	Type
limit	number

Returns

RoomSummary[]

---

of()

of(player): LobbyRoom | undefined;

Defined in: src/net/lobby/LobbyRooms.ts:48

Parameters

Parameter	Type
player	number

Returns

LobbyRoom | undefined

---

state()

state(room, dataOf): RoomState;

Defined in: src/net/lobby/LobbyRooms.ts:104

Parameters

Parameter	Type
room	LobbyRoom
dataOf	(id) => unknown

Returns

RoomState

---

summary()

summary(room): RoomSummary;

Defined in: src/net/lobby/LobbyRooms.ts:100

Parameters

Parameter	Type
room	LobbyRoom

Returns

RoomSummary