five-on-it / packages/protocol/src/messages / MissionMessage
Variable: MissionMessage
constMissionMessage:ZodObject<{chase:ZodOptional<ZodObject<{distance:ZodNumber; },$strip>>;checkpoint:ZodOptional<ZodBoolean>;completed:ZodNumber;escort:ZodOptional<ZodObject<{following:ZodBoolean;health:ZodNumber; },$strip>>;group:ZodOptional<ZodObject<{done:ZodNumber;need:ZodNumber; },$strip>>;hand:ZodOptional<ZodArray<ZodObject<{item:ZodString;tag:ZodString;x:ZodNumber;z:ZodNumber; },$strip>>>;helpline:ZodOptional<ZodString>;hold:ZodOptional<ZodObject<{distance:ZodOptional<ZodNumber>;left:ZodNumber;total:ZodNumber; },$strip>>;members:ZodOptional<ZodArray<ZodObject<{hold:ZodOptional<ZodObject<{left:ZodNumber;total:ZodNumber; },$strip>>;id:ZodString;state:ZodEnum<{active:"active";done:"done";failed:"failed"; }>;text:ZodString;verb:ZodString; },$strip>>>;mission:ZodOptional<ZodString>;objective:ZodOptional<ZodObject<{count:ZodNumber;id:ZodString;index:ZodNumber;text:ZodString;verb:ZodString; },$strip>>;party:ZodOptional<ZodArray<ZodObject<{id:ZodNumber;x:ZodNumber;z:ZodNumber; },$strip>>>;photo:ZodOptional<ZodObject<{x:ZodNumber;z:ZodNumber; },$strip>>;race:ZodOptional<ZodObject<{gate:ZodNumber;gates:ZodNumber;lap:ZodNumber;laps:ZodNumber;position:ZodNumber;racers:ZodNumber;startsIn:ZodOptional<ZodNumber>; },$strip>>;reason:ZodOptional<ZodString>;status:ZodEnum<{active:"active";complete:"complete";failed:"failed";none:"none"; }>;target:ZodOptional<ZodObject<{radius:ZodNumber;x:ZodNumber;y:ZodOptional<ZodNumber>;z:ZodNumber; },$strip>>;targets:ZodOptional<ZodArray<ZodObject<{radius:ZodNumber;x:ZodNumber;y:ZodOptional<ZodNumber>;z:ZodNumber; },$strip>>>;timeLeft:ZodOptional<ZodNumber>;title:ZodOptional<ZodString>;total:ZodNumber;type:ZodLiteral<"mission">;wallet:ZodObject<{cash:ZodNumber;rep:ZodNumber; },$strip>;winner:ZodOptional<ZodString>; },$strip>
Defined in: packages/protocol/src/messages.ts:621
The mission tracker of one player, sent when it changes: whether a mission is running (or just ended), its title, the objective under way with its text and place in the mission, the whole seconds left on its clock, the hold clock of an objective held out (survive, defend, lose: seconds left of the total, and how near the nearest pursuer is), where to go (a point and how close counts), the player's Cash and Rep in this room, how many of the game's missions they have completed, and a race under way (the lap, the gate next of how many, the player's position among the racers, the seconds before the start); a parallel group's members (each one's text and state, the group's count) and every target of those under way; an escort's VIP (its health, whether it follows), a chase's distance, where a give hands items over, a photograph's subject; the other members of the player's party, wherever they are; the name of the help line to call while a mission with one runs; and why a mission that just failed did, and whether it goes back to its last checkpoint; the name of the team that won a versus mission that just ended.