Skip to content

five-on-it / packages/ai/src/roles / RoleState

Interface: RoleState ​

Defined in: packages/ai/src/roles.ts:108

What a role NPC remembers between ticks.

Properties ​

arrived ​

arrived: boolean

Defined in: packages/ai/src/roles.ts:130

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


fleeing ​

fleeing: boolean

Defined in: packages/ai/src/roles.ts:136

Fleeing (a mission's chase): a driver drives its getaway flat out.


follow ​

follow: number

Defined in: packages/ai/src/roles.ts:120

A driver: the entity it follows, or −1. A VIP: its leader's character, or −1.


hidden ​

hidden: number

Defined in: packages/ai/src/roles.ts:128

A target: the tick it began to cower (−1: not hiding).


kind ​

kind: RoleKind

Defined in: packages/ai/src/roles.ts:110

Its role.


leg ​

leg: number

Defined in: packages/ai/src/roles.ts:116

The point of the route it heads for.


loop ​

loop: boolean

Defined in: packages/ai/src/roles.ts:114

The route loops (else it ends at its last point).


race ​

race: RaceState | undefined

Defined in: packages/ai/src/roles.ts:134

A driver racing.


refuge ​

refuge: object

Defined in: packages/ai/src/roles.ts:122

A target: where it runs to when threatened.

x ​

x: number

z ​

z: number


riding ​

riding: number

Defined in: packages/ai/src/roles.ts:132

A VIP: the car it rides in with its leader, or −1.


route ​

route: object[]

Defined in: packages/ai/src/roles.ts:112

Its route: places in order (a driver drives them, a target walks them).

x ​

x: number

z ​

z: number


safe ​

safe: boolean

Defined in: packages/ai/src/roles.ts:126

A target: safe, cowering in its refuge.


speed ​

speed: number

Defined in: packages/ai/src/roles.ts:118

A driver: the share of its car's top speed it cruises at.


threatened ​

threatened: number

Defined in: packages/ai/src/roles.ts:124

A target: the tick it was threatened (−1: never).