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

Function: encodeRun()

encodeRun(message): string

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

Serializes a run's state as a text frame.

Parameters

message

debug?

boolean = ...

game

string = ...

id

string = ...

lives?

{ count: number; left?: number; per: "player" | "team"; } = ...

lives.count

number = ...

lives.left?

number = ...

lives.per

"player" | "team" = ...

mission

string = ...

mode?

"solo" | "coop" | "versus" = ...

phase

"gathering" | "countdown" | "live" | "ended" = ...

playtest?

boolean = ...

result?

{ forfeit?: boolean; outcome: "complete" | "failed" | "abandoned" | "won" | "draw"; seats: object[]; seconds: number; winner?: string; } = ...

result.forfeit?

boolean = ...

result.outcome

"complete" | "failed" | "abandoned" | "won" | "draw" = ...

result.seats

object[] = ...

result.seconds

number = ...

result.winner?

string = ...

retries

{ left: number; total: number; } = ...

retries.left

number = ...

retries.total

number = ...

seat?

number = ...

seats

object[] = ...

startsIn?

number = ...

teams?

object[] = ...

title

string = ...

type

"run" = ...

Returns

string