Skip to content

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

Interface: RoleState ​

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

What a role NPC remembers between ticks.

Properties ​

alone ​

alone: number

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

A hostage: the tick its leader went out of reach (−1: within it).


arrived ​

arrived: boolean

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

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


called ​

called: number

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

A witness: the tick its call went through (−1: not yet).


calling ​

calling: number

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

A witness: the tick it began its call to the police (−1: not calling).


culprit ​

culprit: number

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

A witness: the player's character it saw doing it (−1: nobody it knows).


fled ​

fled: boolean

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

A hostage: left alone, it ran off (and cowers in its refuge).


fleeing ​

fleeing: boolean

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

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


follow ​

follow: number

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

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

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


kind ​

kind: RoleKind

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

Its role.


leg ​

leg: number

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

The point of the route it heads for.


loop ​

loop: boolean

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

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


race ​

race: RaceState | undefined

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

A driver racing.


refuge ​

refuge: object

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

A target: where it runs to when threatened.

x ​

x: number

z ​

z: number


riding ​

riding: number

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

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


route ​

route: object[]

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

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

A target: safe, cowering in its refuge.


speed ​

speed: number

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

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


threatened ​

threatened: number

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

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