1681-engine / index / RoomHostOptions
Interface: RoomHostOptions<D> ​
Defined in: src/net/RoomHost.ts:12
Type Parameters ​
| Type Parameter |
|---|
D |
Properties ​
admit? ​
ts
optional admit?: (data, id) => D;Defined in: src/net/RoomHost.ts:17
Turns a hello's data into the player's data (validate it here); throw to refuse the player.
Parameters ​
| Parameter | Type |
|---|---|
data | unknown |
id | number |
Returns ​
D
maxStrikes? ​
ts
optional maxStrikes?: number;Defined in: src/net/RoomHost.ts:19
Refused inputs before the player is disconnected (default 20).
now? ​
ts
optional now?: () => number;Defined in: src/net/RoomHost.ts:26
Wall clock, for tests (default Date.now).
Returns ​
number
onJoin? ​
ts
optional onJoin?: (id) => void;Defined in: src/net/RoomHost.ts:23
Called when a player joins or leaves.
Parameters ​
| Parameter | Type |
|---|---|
id | number |
Returns ​
void
onLeave? ​
ts
optional onLeave?: (id) => void;Defined in: src/net/RoomHost.ts:24
Parameters ​
| Parameter | Type |
|---|---|
id | number |
Returns ​
void
onMessage? ​
ts
optional onMessage?: (id, msg) => void;Defined in: src/net/RoomHost.ts:21
The game's own messages (anything the engine does not handle).
Parameters ​
| Parameter | Type |
|---|---|
id | number |
msg | { [k: string]: unknown; t: string; } |
msg.t | string |
Returns ​
void
snapRate? ​
ts
optional snapRate?: number;Defined in: src/net/RoomHost.ts:15
stepRate? ​
ts
optional stepRate?: number;Defined in: src/net/RoomHost.ts:14
Simulation steps a second (default 60) and snapshots a second (default 20).