five-on-it / packages/protocol/src/messages / parseRun

Function: parseRun()

parseRun(text): { debug?: boolean; game: string; id: string; lives?: { count: number; left?: number; per: "player" | "team"; }; mission: string; mode?: "solo" | "coop" | "versus"; phase: "countdown" | "ended" | "gathering" | "live"; playtest?: boolean; result?: { forfeit?: boolean; outcome: "failed" | "complete" | "won" | "draw" | "abandoned"; seats: object[]; seconds: number; winner?: string; }; retries: { left: number; total: number; }; roles?: Record<string, ("driver" | "gunner" | "hacker" | "dispatcher" | "medic")[]>; seat?: number; seats: object[]; startsIn?: number; teams?: object[]; title: string; type: "run"; } | undefined

Defined in: packages/protocol/src/messages.ts:975

Parses a text frame as a run's state; undefined when it is not one.

Parameters

text

string

Returns

Type Literal

{ debug?: boolean; game: string; id: string; lives?: { count: number; left?: number; per: "player" | "team"; }; mission: string; mode?: "solo" | "coop" | "versus"; phase: "countdown" | "ended" | "gathering" | "live"; playtest?: boolean; result?: { forfeit?: boolean; outcome: "failed" | "complete" | "won" | "draw" | "abandoned"; seats: object[]; seconds: number; winner?: string; }; retries: { left: number; total: number; }; roles?: Record<string, ("driver" | "gunner" | "hacker" | "dispatcher" | "medic")[]>; seat?: number; seats: object[]; startsIn?: number; teams?: object[]; title: string; type: "run"; }

debug?

optional debug?: boolean

game

game: string

id

id: string

lives?

optional lives?: object

lives.count

count: number

lives.left?

optional left?: number

lives.per

per: "player" | "team"

mission

mission: string

mode?

optional mode?: "solo" | "coop" | "versus"

phase

phase: "countdown" | "ended" | "gathering" | "live"

playtest?

optional playtest?: boolean

result?

optional result?: object

result.forfeit?

optional forfeit?: boolean

result.outcome

outcome: "failed" | "complete" | "won" | "draw" | "abandoned"

result.seats

seats: object[]

result.seconds

seconds: number

result.winner?

optional winner?: string

retries

retries: object

retries.left

left: number

retries.total

total: number

roles?

optional roles?: Record<string, ("driver" | "gunner" | "hacker" | "dispatcher" | "medic")[]>

The roles each team offers its players (P2, P3), by team id.

seat?

optional seat?: number

seats

seats: object[]

startsIn?

optional startsIn?: number

teams?

optional teams?: object[]

title

title: string

type

type: "run"

---

undefined