Skip to content

Interface: WelcomeFrame<View> ​

Defined in: protocol.ts:66

First frame on every connection, reconnects included.

Type Parameters ​

Type ParameterDefault type
Viewunknown

Properties ​

PropertyTypeDescriptionDefined in
t"welcome"Frame type.protocol.ts:68
vnumberThe version of the protocol the room speaks on this connection: see PROTOCOL_VERSION.protocol.ts:70
youstringThis player's id.protocol.ts:72
seqnumberThe room's change counter. Every later state or patch carries the next one.protocol.ts:74
ticknumberTicks run so far; 0 in event mode.protocol.ts:76
tickRatenumberTicks a second; 0 in event mode.protocol.ts:78
stateViewThis player's whole view.protocol.ts:80
playersPlayer[]Everyone with a seat, in join order.protocol.ts:82

MIT licence. Tickflare is an independent project and is not affiliated with Cloudflare.