Npc

Defined in: server/api.d.ts:1057

Replicated non-player character. Server-driven and AI-less: it holds the pose the server gives it.

Extends

• Entity

Constructors

Constructor

new Npc(id): Npc

Defined in: server/api.d.ts:1062

Creates a script wrapper for an existing NPC with this ID; use Npc.create() to create an NPC.

Parameters

id

number

Network entity identifier.

Returns

Npc

Methods

destroy()

destroy(): void

Defined in: server/api.d.ts:1108

Destroys this replicated NPC and removes it from connected clients.

Returns

void

---

getNametagColor()

getNametagColor(): number

Defined in: server/api.d.ts:1166

Returns this NPC’s nametag colour.

Returns

number

Packed 0xAARRGGBB colour.

---

getNametagText()

getNametagText(): string

Defined in: server/api.d.ts:1154

Returns this NPC’s nametag text override.

Returns

string

The override, or an empty string when the name is used.

---

isNametagHealthVisible()

isNametagHealthVisible(): boolean

Defined in: server/api.d.ts:1142

Returns whether this NPC’s nametag health bar is enabled.

Returns

boolean

True when the health component is enabled.

---

isNametagVisible()

isNametagVisible(): boolean

Defined in: server/api.d.ts:1130

Returns whether this NPC’s nametag is enabled.

Returns

boolean

True when the name component is enabled.

---

kill()

kill(): void

Defined in: server/api.d.ts:1113

Kills this NPC outright, playing a generic death on every client. Does nothing if it is already dead.

Returns

void

---

respawn()

respawn(): void

Defined in: server/api.d.ts:1118

Brings a dead NPC back to full health. Clients rebuild the ped, since a corpse cannot be revived in place.

Returns

void

---

setNametagColor()

setNametagColor(color): void

Defined in: server/api.d.ts:1160

Sets the colour of this NPC’s nametag text.

Parameters

color

number

Packed 0xAARRGGBB colour.

Returns

void

---

setNametagHealthVisible()

setNametagHealthVisible(visible): void

Defined in: server/api.d.ts:1136

Shows or hides the health bar on this NPC’s nametag.

Parameters

visible

boolean

Whether the health bar is drawn under the name.

Returns

void

---

setNametagText()

setNametagText(text): void

Defined in: server/api.d.ts:1148

Overrides the text drawn on this NPC’s nametag.

Parameters

text

string

Replacement label; pass an empty string to fall back to the NPC’s name.

Returns

void

---

setNametagVisible()

setNametagVisible(visible): void

Defined in: server/api.d.ts:1124

Shows or hides this NPC’s nametag. Hidden by default; a viewer’s own nametag switches still apply.

Parameters

visible

boolean

Whether the name is drawn above this NPC.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: shared.d.ts:83

Parameters

world

number

Returns

void

---

setVisibleTo()

setVisibleTo(player): void

Defined in: shared.d.ts:84

Parameters

player

Entity | null

Returns

void

---

toString()

toString(): string

Defined in: server/api.d.ts:1103

Returns a readable representation of this NPC.

Returns

string

The NPC ID formatted for logging or debugging.

---

create()

static create(x, y, z, model, name?, rotation?, invincible?, virtualWorld?): Npc

Defined in: server/api.d.ts:1180

Creates and replicates a server-driven NPC.

Parameters

x

number

Initial world-space X coordinate.

y

number

Initial world-space Y coordinate.

z

number

Initial world-space Z coordinate.

model

number

Character model identifier to instantiate.

name?

string

Optional name, shown by the nametag once it is enabled.

rotation?

Vector3 | Quaternion

Optional orientation: a Quaternion, or a Vector3 of Euler angles in radians.

invincible?

boolean

Optional damage immunity; pass false to spawn a killable NPC. Defaults to true.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

Returns

Npc

The newly created NPC handle.

Properties

dead

readonly dead: boolean

Defined in: server/api.d.ts:1092

Whether the NPC is dead.

---

direction

direction: Vector3

Defined in: server/api.d.ts:1097

Facing as a unit forward vector; assignment rewrites the rotation so the NPC faces that way.

---

health

health: number

Defined in: server/api.d.ts:1087

Server-authoritative health, on the same scale as a player (200 = full). Assigning 0 or less kills the NPC; assigning above 0 to a dead one revives it.

---

id

readonly id: number

Defined in: shared.d.ts:79

---

invincible

invincible: boolean

Defined in: server/api.d.ts:1072

Whether the NPC rejects all damage. Set false to make it killable. Defaults to true.

---

maxHealth

maxHealth: number

Defined in: server/api.d.ts:1082

Health ceiling, and the denominator of the nametag health bar. Defaults to 200.

---

model

readonly model: number

Defined in: server/api.d.ts:1067

Character model identifier this NPC was spawned with.

---

name

name: string

Defined in: server/api.d.ts:1077

This NPC’s name, shown by its nametag unless a nametag text override is set.

---

position

position: Vector3

Defined in: shared.d.ts:81

---

rotation

rotation: Vector3 | Quaternion

Defined in: shared.d.ts:82

---

virtualWorld

readonly virtualWorld: number

Defined in: shared.d.ts:80