Five On It

Appearance

five-on-it / packages/world/src/level / NpcDef

Interface: NpcDef ​

Defined in: packages/world/src/level.ts:487

An NPC of the level, placed by an NPC spawner (GAME_DESIGN §5.4, §5.5): a person of a role standing at its home, who walks a patrol path (points on the ground, looping back to the first or back and forth) or keeps a post (facing its yaw, looking turn either way), with a loadout (a weapon by name, none for none) and pockets (items, searched off it once it is down). The server spawns it with the level (@foi/ai's sentries).

Properties ​

items ​

items: ItemCount[]

Defined in: packages/world/src/level.ts:503

What its pockets hold.

loop? ​

optional loop?: boolean

Defined in: packages/world/src/level.ts:507

A patrol loops from its last point back to its home (true), or walks back and forth.

name ​

name: string

Defined in: packages/world/src/level.ts:489

The node's name in the editor.

patrol? ​

optional patrol?: [number, number][]

Defined in: packages/world/src/level.ts:505

Its patrol path, points [x, z] on the ground (m) after its home; absent for a post.

refuge? ​

optional refuge?: [number, number]

Defined in: packages/world/src/level.ts:513

Where a target runs to when threatened ([x, z], m); its home when absent.

role ​

role: NpcRole

Defined in: packages/world/src/level.ts:491

What it is for.

schedule? ​

optional schedule?: ScheduleDef[]

Defined in: packages/world/src/level.ts:515

Its schedule, earliest hour first; absent for an NPC that keeps its rounds all day.

turn? ​

optional turn?: number

Defined in: packages/world/src/level.ts:509

How far a post looks either way of its yaw (rad); absent for none.

vehicle? ​

optional vehicle?: string

Defined in: packages/world/src/level.ts:511

A driver's vehicle class by name; absent for anyone else.

weapon ​

weapon: string

Defined in: packages/world/src/level.ts:501

Its weapon by name (pistol, rifle…), or none.

x ​

x: number

Defined in: packages/world/src/level.ts:493

Where it stands on the ground: its home (m).

y ​

y: number

Defined in: packages/world/src/level.ts:495

The ground under it (m).

yaw ​

yaw: number

Defined in: packages/world/src/level.ts:499

Which way it faces at its post (rad, 0 faces +z).

z ​

z: number

Defined in: packages/world/src/level.ts:497

Where it stands on the ground: its home (m).