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

Function: encodeMission()

encodeMission(message): string

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

Serializes a mission tracker as a text frame.

Parameters

message

chase?

{ distance: number; } = ...

chase.distance

number = ...

checkpoint?

boolean = ...

completed

number = ...

escort?

{ following: boolean; health: number; } = ...

escort.following

boolean = ...

escort.health

number = ...

group?

{ done: number; need: number; } = ...

group.done

number = ...

group.need

number = ...

hand?

object[] = ...

helpline?

string = ...

hold?

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

hold.distance?

number = ...

hold.left

number = ...

hold.total

number = ...

members?

object[] = ...

mission?

string = ...

objective?

{ count: number; id: string; index: number; text: string; verb: string; } = ...

objective.count

number = ...

objective.id

string = ...

objective.index

number = ...

objective.text

string = ...

objective.verb

string = ...

party?

object[] = ...

photo?

{ x: number; z: number; } = ...

photo.x

number = ...

photo.z

number = ...

race?

{ gate: number; gates: number; lap: number; laps: number; position: number; racers: number; startsIn?: number; } = ...

race.gate

number = ...

race.gates

number = ...

race.lap

number = ...

race.laps

number = ...

race.position

number = ...

race.racers

number = ...

race.startsIn?

number = ...

reason?

string = ...

status

"none" | "active" | "complete" | "failed" = ...

target?

{ radius: number; x: number; y?: number; z: number; } = ...

target.radius

number = ...

target.x

number = ...

target.y?

number = ...

target.z

number = ...

targets?

object[] = ...

timeLeft?

number = ...

title?

string = ...

total

number = ...

type

"mission" = ...

wallet

{ cash: number; rep: number; } = ...

wallet.cash

number = ...

wallet.rep

number = ...

winner?

string = ...

Returns

string