Five On It

Appearance

five-on-it / apps/client/src/renderer/social / SocialDeps

Interface: SocialDeps ​

Defined in: apps/client/src/renderer/social.ts:166

What the controller is built with.

Properties ​

go? ​

optional go?: (address) => void

Defined in: apps/client/src/renderer/social.ts:178

Goes to an address (a room the party lands in); the page's own by default.

Parameters ​

address ​

string

Returns ​

void

now? ​

optional now?: () => number

Defined in: apps/client/src/renderer/social.ts:176

The page's clock (ms).

Returns ​

number

platform? ​

optional platform?: Platform

Defined in: apps/client/src/renderer/social.ts:170

The platform's client, when the page has one.

room? ​

optional room?: string

Defined in: apps/client/src/renderer/social.ts:172

The room the page plays in (none: the default room).

optional search?: () => string

Defined in: apps/client/src/renderer/social.ts:180

The page's query string (the API's address it keeps); the page's own by default.

Returns ​

string

store ​

store: Store<OverlayState>

Defined in: apps/client/src/renderer/social.ts:174

The overlay's store.

transport ​

transport: Transport

Defined in: apps/client/src/renderer/social.ts:168

The game server's connection (the room's frames).