five-on-it / apps/client/src/ui/social-view / mayVoteKick

Function: mayVoteKick()

mayVoteKick(roster): boolean

Defined in: apps/client/src/ui/social-view.ts:146

Whether the reader may start a vote to kick: none under way, three players or more in the room.

Parameters

roster

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

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

boolean = ...

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

players

object[] = ...

The players, in the order they came.

type

"roster" = ...

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

number = ...

The receiver's client id.

---

undefined

Returns

boolean