Skip to content

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

Interface: NpcFacts ​

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

An NPC actor (a person, a guard, a civilian): where it is, whether it is down, its alert phase's rank (0 normal to 4 alert) and its status.

Properties ​

arrived? ​

optional arrived?: boolean

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

A driver at the end of a route that does not loop.


called? ​

optional called?: boolean

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

A witness through to the police.


captive? ​

optional captive?: "free" | "handsUp" | "restrained" | "surrendered"

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

Held up (its hands up), kneeling, or restrained (free when absent): the simulation's CAPTIVE_STATES.


captor? ​

optional captor?: number

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

The client id of the player who held it up or restrained it (0 for none).


down ​

down: boolean

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

Knocked down, out, asleep, dead or gone: nobody to talk to.


dragged? ​

optional dragged?: boolean

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

Its body dragged by somebody now.


fled? ​

optional fled?: boolean

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

A hostage left alone: it ran off.


health? ​

optional health?: number

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

Its health in per cent (100 when absent).


hidden? ​

optional hidden?: string

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

Its body hidden in a dumpster: that object actor's key (any dumpster's when not a mission's: an empty key).


indoors? ​

optional indoors?: boolean

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

Gone indoors (home by its schedule, a target safe in its refuge).


leader? ​

optional leader?: number

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

A VIP's leader: the client id of the player it follows (0 for none).


phase ​

phase: number

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

Its alert phase's rank.


race? ​

optional race?: object

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

A racer: gates passed in all, the tick it finished (−1 not yet), how far it is from its next gate (m).

distance ​

distance: number

finished ​

finished: number

passed ​

passed: number


riding? ​

optional riding?: boolean

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

A VIP riding in its leader's car.


safe? ​

optional safe?: boolean

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

A target safe in its refuge.


sees? ​

optional sees?: boolean

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

It has the player (a member of their party) in sight now (a sentry's, a role's eyes; never when absent).


speed? ​

optional speed?: number

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

How fast it moves (m/s): its car's speed at the wheel (0 when absent).


status ​

status: StatusName

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

Its status.


threatened? ​

optional threatened?: boolean

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

A target threatened.


x ​

x: number

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

x (m).


z ​

z: number

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

z (m).