Five On It

Appearance

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

Interface: RoleSpec ​

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

How a role NPC is spawned.

Properties ​

at ​

at: SpawnPoint

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

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

bound? ​

optional bound?: boolean

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

A hostage starts tied up (restrained; the default).

loop? ​

optional loop?: boolean

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

The route loops (the default).

refuge? ​

optional refuge?: object

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

A target's, a witness's or a hostage's refuge (its spot when absent).

x ​

x: number

z ​

z: number

role ​

role: RoleKind

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

Its role.

route? ​

optional route?: readonly object[]

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

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

speed? ​

optional speed?: number

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

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

vehicle? ​

optional vehicle?: number

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

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