Skip to content

five-on-it / packages/missions/src/runtime / MissionView

Interface: MissionView ​

Defined in: packages/missions/src/runtime.ts:1146

What the mission tracker shows a player.

Properties ​

chase? ​

optional chase?: object

Defined in: packages/missions/src/runtime.ts:1180

A chase under way: how far the target is (m).

distance ​

distance: number


checkpoint? ​

optional checkpoint?: boolean

Defined in: packages/missions/src/runtime.ts:1158

A mission that just failed goes back to its last checkpoint (else it starts over).


completed ​

completed: number

Defined in: packages/missions/src/runtime.ts:1200

Missions this player has completed.


escort? ​

optional escort?: object

Defined in: packages/missions/src/runtime.ts:1178

An escort under way: the VIP's health (per cent) and whether it follows the player (a member of their party).

following ​

following: boolean

health ​

health: number


group? ​

optional group?: object

Defined in: packages/missions/src/runtime.ts:1174

done ​

done: number

need ​

need: number


hand? ​

optional hand?: object[]

Defined in: packages/missions/src/runtime.ts:1182

Where the interaction key hands items over to a person (a give under way), and what: the item's name, the tag the items answer to.

item ​

item: string

tag ​

tag: string

x ​

x: number

z ​

z: number


helpline? ​

optional helpline?: string

Defined in: packages/missions/src/runtime.ts:1160

The name of the mission's help line, while it runs (see Mission's helpline).


hold? ​

optional hold?: object

Defined in: packages/missions/src/runtime.ts:1169

A clock that runs while the player holds out (survive, defend, lose): whole seconds left of the total, and for lose how near the nearest of the group is (m).

distance? ​

optional distance?: number

left ​

left: number

total ​

total: number


members? ​

optional members?: MemberView[]

Defined in: packages/missions/src/runtime.ts:1173

A parallel group under way: its members, how many are done and how many it needs.


mission? ​

optional mission?: string

Defined in: packages/missions/src/runtime.ts:1150

The mission's id.


objective? ​

optional objective?: object

Defined in: packages/missions/src/runtime.ts:1162

The objective under way: its id, verb, text, and where it stands in the mission.

count ​

count: number

id ​

id: string

index ​

index: number

text ​

text: string

verb ​

verb: "pickup" | "goto" | "catch" | "use" | "give" | "unlock" | "talk" | "wait" | "group" | "escort" | "chase" | "race" | "steal_vehicle" | "deliver" | "collect" | "survive" | "defend" | "lose" | "eliminate" | "incapacitate" | "sneak" | "photograph" | "escape" | "destroy"


party? ​

optional party?: object[]

Defined in: packages/missions/src/runtime.ts:1186

The other members of the player's party in the room, wherever they are (to the metre).

id ​

id: number

x ​

x: number

z ​

z: number


photo? ​

optional photo?: object

Defined in: packages/missions/src/runtime.ts:1184

A photograph under way: where its subject stands.

x ​

x: number

z ​

z: number


race? ​

optional race?: object

Defined in: packages/missions/src/runtime.ts:1188

A race under way: the lap and the next gate of how many, the player's position among the racers (the other players' seats too, in versus), the seconds before the start.

gate ​

gate: number

gates ​

gates: number

lap ​

lap: number

laps ​

laps: number

position ​

position: number

racers ​

racers: number

startsIn? ​

optional startsIn?: number


reason? ​

optional reason?: string

Defined in: packages/missions/src/runtime.ts:1154

Why the mission that just failed did: what its failure says.


status ​

status: "none" | "active" | "complete" | "failed"

Defined in: packages/missions/src/runtime.ts:1148

No mission running, one running, or one that just ended.


target? ​

optional target?: ViewTarget

Defined in: packages/missions/src/runtime.ts:1171

Where to go: a point on the ground and how close counts (m); of a group's, the nearest.


targets? ​

optional targets?: ViewTarget[]

Defined in: packages/missions/src/runtime.ts:1176

Every target of a group's members under way (the world and the minimap draw them all).


timeLeft? ​

optional timeLeft?: number

Defined in: packages/missions/src/runtime.ts:1164

Whole seconds left of the objective's time limit.


title? ​

optional title?: string

Defined in: packages/missions/src/runtime.ts:1152

The mission's title.


total ​

total: number

Defined in: packages/missions/src/runtime.ts:1202

Missions the game has.


wallet ​

wallet: object

Defined in: packages/missions/src/runtime.ts:1198

The player's Cash and Rep in this room.

cash ​

cash: number

rep ​

rep: number


winner? ​

optional winner?: string

Defined in: packages/missions/src/runtime.ts:1156

The name of the team that won the versus mission that just ended (none: a draw).