NPC

An NPC is a non-player character returned by `NPCs:Create`.
NPCs are not Instances.

Overview

Properties

• .Slot readonly : int
• .Name readonly : string
• .Position : Vector3
• .Yaw : number
• .Animation : int

Methods

• :Destroy()
• :Chat(message: string)
• :MoveTo(x: number, y: number, z: number)
• :TpTo(x: number, y: number, z: number)
• :SetYaw(degrees: number)
• :SetAnim(anim: int)
• :GetX() : number deprecated
• :GetY() : number deprecated
• :GetZ() : number deprecated
• :GetYaw() : number deprecated

API

Properties

Slot

Slot readonly : int
Internal slot id for this NPC.

Name

Name readonly : string
Display name of the NPC, including the " [NPC]" suffix.

Position

Position : Vector3
World position of the NPC.
Writing this teleports them.

Yaw

Yaw : number
Facing direction in degrees.

Animation

Animation : int
Current animation state id.
Prefer values from `NPCs.Animations`.

Methods

Destroy

Destroy() : void
Removes this NPC from the place.

Chat

Chat(message: string) : void
Makes the NPC say a chat message.

MoveTo

MoveTo(x: number, y: number, z: number) : void
Starts walking the NPC toward a world position.

TpTo

TpTo(x: number, y: number, z: number) : void
Teleports the NPC to a world position.

SetYaw

SetYaw(degrees: number) : void
Sets the NPC facing direction in degrees.

SetAnim

SetAnim(anim: int) : void
Sets the NPC animation state.

GetX

GetX() : number deprecated
Returns the X position.
Prefer Position.
No longer recommended for use.

GetY

GetY() : number deprecated
Returns the Y position.
Prefer Position.
No longer recommended for use.

GetZ

GetZ() : number deprecated
Returns the Z position.
Prefer Position.
No longer recommended for use.

GetYaw

GetYaw() : number deprecated
Returns the yaw in degrees.
Prefer Yaw.
No longer recommended for use.