Skip to content

five-on-it / apps/client/src/ui/platform / PlatformInfo

Interface: PlatformInfo ​

Defined in: apps/client/src/ui/platform.ts:313

What a platform says of itself (GET /info): its release, its protocol, where its cities are played.

Properties ​

entitlement ​

entitlement: "open" | "steam"

Defined in: apps/client/src/ui/platform.ts:327

Whether it is for anyone or for the game's owners on Steam.


game ​

game: string | null

Defined in: apps/client/src/ui/platform.ts:319

The WebSocket address of its game server's cities (wss://…/game); none when it has no game server.


join ​

join: "open" | "token"

Defined in: apps/client/src/ui/platform.ts:329

Whether its game servers ask every player for a join token (then only /play's addresses play).


legal: object

Defined in: apps/client/src/ui/platform.ts:321

Who runs it, as the privacy policy and the terms name them (empty fields: unsaid).

contact ​

contact: string

country ​

country: string

operator ​

operator: string


protocolVersion ​

protocolVersion: number

Defined in: apps/client/src/ui/platform.ts:317

Its protocol version, which this game's must equal to play there.


signIn ​

signIn: SignInWay[]

Defined in: apps/client/src/ui/platform.ts:325

How one signs in there (a platform of an older release: a guest or an e-mail).


store ​

store: string | null

Defined in: apps/client/src/ui/platform.ts:331

The game's page on the Steam store, if it names one.


telemetryDays ​

telemetryDays: number

Defined in: apps/client/src/ui/platform.ts:323

How long it keeps the players' crash reports and statistics (days).


version ​

version: string

Defined in: apps/client/src/ui/platform.ts:315

Its release (0.42.0).