Five On It

Appearance

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

Interface: NpcState ​

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

Everything an NPC remembers between ticks.

Properties ​

aimJitter ​

aimJitter: number

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

The aim jitter of the current burst (rad).

assigned ​

assigned: number

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

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

block? ​

optional block?: object

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

A rolling block's spot (police-roadblocks.ts): its driver drives there and holds, whatever its target does.

x ​

x: number

z ​

z: number

carEpisodes ​

carEpisodes: number

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

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

carRecoverDir ​

carRecoverDir: number

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

carRecoverUntil ​

carRecoverUntil: number

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

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

climb ​

climb: ClimbState | undefined

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

Taking a link of its path (a ladder, a lift, a drop, a hop, narrow stairs: steer-climb.ts), if it is.

doing? ​

optional doing?: PoseOrder

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

Told to hold a pose where it stands (poses.ts: a mission's npcDo).

eid ​

eid: number

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

Its character entity.

firePause ​

firePause: number

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

No new burst before this tick.

fireUntil ​

fireUntil: number

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

The trigger is held until this tick.

halt? ​

optional halt?: number

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

At the wheel, it holds its car stopped until this tick (a red light a player hacked, police-tech.ts).

heard ​

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

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

The last noise it heard.

hire? ​

optional hire?: HireState

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

A hired hand's brain (crew-hire.ts): a getaway driver, a gunner or a hacker, and its employer.

holdup? ​

optional holdup?: HoldupState

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

Held up (holdup.ts): by whom, since when, when a gun was last on it; or when it last refused.

home ​

home: SpawnPoint

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

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

jumpCooldown ​

jumpCooldown: number

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

The tick it may jump again.

lastCar ​

lastCar: number

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

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:239

lastSeen ​

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

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

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:209

The tick of the last recovery.

leaveCar ​

leaveCar: boolean

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

Getting out of its car as soon as it may.

mode ​

mode: NpcMode

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

What it is doing.

modeSince ​

modeSince: number

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

The tick it started doing it.

nextRepath ​

nextRepath: number

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

The tick it may plan again.

nextReroute ​

nextReroute: number

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

The tick it may plan a route again.

ownCar ​

ownCar: number

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

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

path ​

path: NpcPath | undefined

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

The path it follows, if any.

profile ​

profile: BehaviourProfile

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

How it behaves.

ramBackUntil ​

ramBackUntil: number

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

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:213

Which way the next sidestep goes (±1).

recoverUntil ​

recoverUntil: number

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

Sidestepping until this tick.

remove ​

remove: boolean

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

To be removed at the end of the tick.

role? ​

optional role?: RoleState

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

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:229

The route it drives, if any.

schedule? ​

optional schedule?: ScheduleState

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

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

searchAt ​

searchAt: number

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

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

seat? ​

optional seat?: SeatBotState

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

A seat bot (a run's AI player, seat-bot.ts) has its brain's state here.

sentry? ​

optional sentry?: SentryState

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

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:233

Ticks its car has asked for speed and got none.

stuckEpisodes ​

stuckEpisodes: number

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

Recoveries in a row within the episode window.

stuckTicks ​

stuckTicks: number

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

Ticks it has wanted to move without moving.

swat? ​

optional swat?: SwatMember

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

A police specialist of six stars (police-swat.ts: a SWAT team's officer, its van's driver, a K9 handler, a negotiator) has its orders here; its brain is swat-brain.ts'.

target ​

target: number

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

The character it is after, or −1.

threat ​

threat: number

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

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

turnDir ​

turnDir: number

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

turnUntil ​

turnUntil: number

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

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

wantsCar ​

wantsCar: number

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

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