Five On It

Appearance

five-on-it / packages/protocol/src/social / parseRoster

Function: parseRoster() ​

parseRoster(text): { moderated: boolean; players: object[]; type: "roster"; vote: { by: number; needed: number; seconds: number; target: number; voted: boolean; yes: number; } | null; you: number; } | undefined

Defined in: packages/protocol/src/social.ts:177

Parses a text frame as the roster; undefined when it is not.

Parameters ​

text ​

string

Returns ​

Type Literal ​

{ moderated: boolean; players: object[]; type: "roster"; vote: { by: number; needed: number; seconds: number; target: number; voted: boolean; yes: number; } | null; you: number; }

moderated ​

moderated: boolean

Whether the room is public: its chat goes through the platform's moderation.

players ​

players: object[]

The players, in the order they came.

type ​

type: "roster"

vote ​

vote: { by: number; needed: number; seconds: number; target: number; voted: boolean; yes: number; } | null

The vote to kick under way: whom, who started it, the yes so far, the yes it needs, the seconds left; the receiver's own vote.

you ​

you: number

The receiver's client id.

undefined