Skip to content

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

Interface: RoleSpec ​

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

How a role NPC is spawned.

Properties ​

at ​

at: SpawnPoint

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

Where it starts (its centre on foot; the car's chassis centre for a driver), facing which way.


loop? ​

optional loop?: boolean

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

The route loops (the default).


refuge? ​

optional refuge?: object

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

A target's refuge (its spot when absent).

x ​

x: number

z ​

z: number


role ​

role: RoleKind

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

Its role.


route? ​

optional route?: readonly object[]

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

Its route (a driver's places, a target's walk).


speed? ​

optional speed?: number

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

A driver's share of its car's top speed.


vehicle? ​

optional vehicle?: number

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

A driver's car class (an index into the class table; the sedan when absent).