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

Function: parseMission()

parseMission(text): { chase?: { distance: number; }; checkpoint?: boolean; completed: number; escort?: { following: boolean; health: number; }; group?: { done: number; need: number; }; hand?: object[]; helpline?: string; hold?: { distance?: number; left: number; total: number; }; members?: object[]; mission?: string; objective?: { count: number; id: string; index: number; text: string; verb: string; }; party?: object[]; photo?: { x: number; z: number; }; race?: { gate: number; gates: number; lap: number; laps: number; position: number; racers: number; startsIn?: number; }; reason?: string; status: "none" | "active" | "complete" | "failed"; target?: { radius: number; x: number; y?: number; z: number; }; targets?: object[]; timeLeft?: number; title?: string; total: number; type: "mission"; wallet: { cash: number; rep: number; }; winner?: string; } | undefined

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

Parses a text frame as a mission tracker; undefined when it is not one.

Parameters

text

string

Returns

{ chase?: { distance: number; }; checkpoint?: boolean; completed: number; escort?: { following: boolean; health: number; }; group?: { done: number; need: number; }; hand?: object[]; helpline?: string; hold?: { distance?: number; left: number; total: number; }; members?: object[]; mission?: string; objective?: { count: number; id: string; index: number; text: string; verb: string; }; party?: object[]; photo?: { x: number; z: number; }; race?: { gate: number; gates: number; lap: number; laps: number; position: number; racers: number; startsIn?: number; }; reason?: string; status: "none" | "active" | "complete" | "failed"; target?: { radius: number; x: number; y?: number; z: number; }; targets?: object[]; timeLeft?: number; title?: string; total: number; type: "mission"; wallet: { cash: number; rep: number; }; winner?: string; } | undefined