Skip to content

five-on-it / packages/ai/src/system / NpcState

Interface: NpcState ​

Defined in: packages/ai/src/system.ts:139

Everything an NPC remembers between ticks.

Properties ​

aimJitter ​

aimJitter: number

Defined in: packages/ai/src/system.ts:181

The aim jitter of the current burst (rad).


assigned ​

assigned: number

Defined in: packages/ai/src/system.ts:151

A character it was told to go after (the player who spawned it), or −1.


carEpisodes ​

carEpisodes: number

Defined in: packages/ai/src/system.ts:194

Stalls in a row within the episode window, and the tick of the last.


carRecoverDir ​

carRecoverDir: number

Defined in: packages/ai/src/system.ts:192


carRecoverUntil ​

carRecoverUntil: number

Defined in: packages/ai/src/system.ts:191

Reversing out of a stall until this tick, wheels turned this way (±1).


eid ​

eid: number

Defined in: packages/ai/src/system.ts:141

Its character entity.


firePause ​

firePause: number

Defined in: packages/ai/src/system.ts:179

No new burst before this tick.


fireUntil ​

fireUntil: number

Defined in: packages/ai/src/system.ts:177

The trigger is held until this tick.


heard ​

heard: { tick: number; x: number; z: number; } | undefined

Defined in: packages/ai/src/system.ts:155

The last noise it heard.


home ​

home: SpawnPoint

Defined in: packages/ai/src/system.ts:173

Where it came from: where it returns to, where it comes back after dying.


jumpCooldown ​

jumpCooldown: number

Defined in: packages/ai/src/system.ts:171

The tick it may jump again.


lastCar ​

lastCar: number

Defined in: packages/ai/src/system.ts:210

The car it sat in at its last update, or −1: a carjack of that car makes it flee.


lastCarStuck ​

lastCarStuck: number

Defined in: packages/ai/src/system.ts:195


lastSeen ​

lastSeen: { tick: number; vx: number; vz: number; x: number; y?: number; z: number; } | undefined

Defined in: packages/ai/src/system.ts:153

Where its target was last seen (y: the height of its body's centre, when known), and how it moved.


lastStuck ​

lastStuck: number

Defined in: packages/ai/src/system.ts:165

The tick of the last recovery.


leaveCar ​

leaveCar: boolean

Defined in: packages/ai/src/system.ts:204

Getting out of its car as soon as it may.


mode ​

mode: NpcMode

Defined in: packages/ai/src/system.ts:145

What it is doing.


modeSince ​

modeSince: number

Defined in: packages/ai/src/system.ts:147

The tick it started doing it.


nextRepath ​

nextRepath: number

Defined in: packages/ai/src/system.ts:159

The tick it may plan again.


nextReroute ​

nextReroute: number

Defined in: packages/ai/src/system.ts:187

The tick it may plan a route again.


ownCar ​

ownCar: number

Defined in: packages/ai/src/system.ts:175

The car it was spawned in, or −1; removed with it.


path ​

path: NpcPath | undefined

Defined in: packages/ai/src/system.ts:157

The path it follows, if any.


profile ​

profile: BehaviourProfile

Defined in: packages/ai/src/system.ts:143

How it behaves.


ramBackUntil ​

ramBackUntil: number

Defined in: packages/ai/src/system.ts:200

Backing off a car it has just rammed until this tick, to line up the next blow.


recoverDir ​

recoverDir: number

Defined in: packages/ai/src/system.ts:169

Which way the next sidestep goes (±1).


recoverUntil ​

recoverUntil: number

Defined in: packages/ai/src/system.ts:167

Sidestepping until this tick.


remove ​

remove: boolean

Defined in: packages/ai/src/system.ts:206

To be removed at the end of the tick.


role? ​

optional role?: RoleState

Defined in: packages/ai/src/system.ts:214

A role NPC (a driver, a target, a VIP) has its brain's state here (roles.ts).


route ​

route: NpcRoute | undefined

Defined in: packages/ai/src/system.ts:185

The route it drives, if any.


schedule? ​

optional schedule?: ScheduleState

Defined in: packages/ai/src/system.ts:216

An NPC with a schedule has its hours here (schedule.ts).


searchAt ​

searchAt: number

Defined in: packages/ai/src/system.ts:183

The tick it reached the spot it searches, or −1 on the way there.


sentry? ​

optional sentry?: SentryState

Defined in: packages/ai/src/system.ts:212

A sentry of stealth (a guard, a civilian) has its alert phases and rounds here; a chaser none.


stallTicks ​

stallTicks: number

Defined in: packages/ai/src/system.ts:189

Ticks its car has asked for speed and got none.


stuckEpisodes ​

stuckEpisodes: number

Defined in: packages/ai/src/system.ts:163

Recoveries in a row within the episode window.


stuckTicks ​

stuckTicks: number

Defined in: packages/ai/src/system.ts:161

Ticks it has wanted to move without moving.


target ​

target: number

Defined in: packages/ai/src/system.ts:149

The character it is after, or −1.


threat ​

threat: number

Defined in: packages/ai/src/system.ts:208

The character it flees (who carjacked it), or −1.


turnDir ​

turnDir: number

Defined in: packages/ai/src/system.ts:198


turnUntil ​

turnUntil: number

Defined in: packages/ai/src/system.ts:197

Backing round until this tick, wheels turned this way (±1).


wantsCar ​

wantsCar: number

Defined in: packages/ai/src/system.ts:202

The free car it walks to, to take, or −1.