1681-engine / index / RoomOptions
Interface: RoomOptions<D, B> ​
Defined in: src/net/Room.ts:63
Type Parameters ​
| Type Parameter | Default type |
|---|---|
D | - |
B | unknown |
Properties ​
backlog? ​
optional backlog?: number;Defined in: src/net/Room.ts:73
grid ​
grid: CollisionGrid;Defined in: src/net/Room.ts:64
interest? ​
optional interest?: RoomInterest<D, B>;Defined in: src/net/Room.ts:77
Send each player only the bodies near it (default: everyone to everyone).
maxQueue? ​
optional maxQueue?: number;Defined in: src/net/Room.ts:70
Steps a player may have waiting before more are refused (default 30: half a second at 60).
maxStepsPerTick? ​
optional maxStepsPerTick?: number;Defined in: src/net/Room.ts:72
A player with more than backlog waiting catches up by running up to maxStepsPerTick a tick (default 3, 4).
onStep? ​
optional onStep?: (player, step) => void;Defined in: src/net/Room.ts:75
Called after each step a player takes (set aim, anim, flags from it).
Parameters ​
| Parameter | Type |
|---|---|
player | RoomPlayer<D> |
step | InputStep |
Returns ​
void
params ​
params: MovementParams;Defined in: src/net/Room.ts:66
Movement rules a new player starts with.
rewindMs? ​
optional rewindMs?: number;Defined in: src/net/Room.ts:82
Keep this many ms of positions for lag compensation (history), recorded as each round of snapshots goes out (record). Off by default.
spawn ​
spawn: (id, data) => object;Defined in: src/net/Room.ts:68
Where a player who joins stands.
Parameters ​
| Parameter | Type |
|---|---|
id | number |
data | D |
Returns ​
object
x ​
x: number;y ​
y: number;