Skip to content

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

Interface: PlayerFacts ​

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

Where a player is and how healthy.

Properties ​

alerts? ​

optional alerts?: number

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


arrested? ​

optional arrested?: boolean

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

Arrested by the police since the last step.


carHealth? ​

optional carHealth?: number

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

Their car's health in per cent while seated (100 when absent).


cash? ​

optional cash?: number

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

The player's Cash ($), the room's purse (the interpreter's own count of what it paid when absent).


down? ​

optional down?: boolean

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

Whether the character is down for good (dead); false when absent.


downedBy? ​

optional downedBy?: number

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

The client id of the player whose hit put them down, on the step they went down.


health? ​

optional health?: number

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

The character's health in per cent (100 when absent).


id ​

id: number

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

The player's client id.


items? ​

optional items?: readonly StackFacts[]

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

What the player carries (nothing when absent).


kills? ​

optional kills?: number

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

People the player has killed, alarms they caused, times a guard or a camera came to see them, since they joined (0 when absent).


seated? ​

optional seated?: boolean

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

Seated in a car.


seen? ​

optional seen?: number

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


speed? ​

optional speed?: number

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

How fast they move (m/s): their car's speed while seated (0 when absent).


status? ​

optional status?: StatusName

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

The character's status (awake when absent): stunned, knocked out or asleep is not awake.


wanted? ​

optional wanted?: number

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

The player's Wanted level in stars (0 when absent).


x ​

x: number

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

x (m): the car's position while seated, the character's otherwise.


y? ​

optional y?: number

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

y (m): the height of the body's centre; a zone whose place has a height counts it (absent: any height).


z ​

z: number

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

z (m).