Five On It

Appearance

five-on-it / packages/protocol/src/platform / JoinClaims

Interface: JoinClaims ​

Defined in: packages/protocol/src/platform.ts:320

What a join token says.

Properties ​

account ​

account: string

Defined in: packages/protocol/src/platform.ts:324

The player's account id.

debug? ​

optional debug?: boolean

Defined in: packages/protocol/src/platform.ts:340

The player's debug commands are honoured in the room, whatever the room's own switch (an account the platform's FOI_DEBUG_ACCOUNTS names, to test a game live); absent for anyone else. A run where one was honoured pays nothing (its RunResult's debug).

name ​

name: string

Defined in: packages/protocol/src/platform.ts:326

The name to show for the player.

party? ​

optional party?: string

Defined in: packages/protocol/src/platform.ts:328

The player's party (the platform's id): party members land in one room and share their missions.

room ​

room: string

Defined in: packages/protocol/src/platform.ts:322

The room.

run? ​

optional run?: string

Defined in: packages/protocol/src/platform.ts:330

The run the room is opened for, when it is a run's: the token is good for that run alone.

seat? ​

optional seat?: number

Defined in: packages/protocol/src/platform.ts:332

The player's seat in the run (its index in the run's roster).

team? ​

optional team?: string

Defined in: packages/protocol/src/platform.ts:334

The player's team in the run.