Want a special badge and 30 bux? Make some PolyWorld! Content and post it in the Creations forum!
Dark mode is incomplete! Please report any issues to the Discord.

NPCs

Scripts Not creatable

NPCs creates NPC characters in the place.
Available as the global NPCs.

Overview

Properties

Methods

  • :Create(name: string, shirtId: int, pantsId: int, headId: int, skinOrAccs: string|List of int, ...) : NPC?
  • .create(name: string, shirtId: int, pantsId: int, headId: int, skinOrAccs: string|List of int, ...) : NPC? deprecated
  • :Destroy(slot: int) deprecated
  • .destroy(slot: int) deprecated
  • :Chat(slot: int, message: string) deprecated
  • .chat(slot: int, message: string) deprecated
  • :MoveTo(slot: int, x: number, y: number, z: number) deprecated
  • .moveTo(slot: int, x: number, y: number, z: number) deprecated
  • :TpTo(slot: int, x: number, y: number, z: number) deprecated
  • .tpTo(slot: int, x: number, y: number, z: number) deprecated
  • :SetYaw(slot: int, degrees: number) deprecated
  • .setYaw(slot: int, degrees: number) deprecated
  • :SetAnim(slot: int, anim: int) deprecated
  • .setAnim(slot: int, anim: int) deprecated
  • :GetX(slot: int) : number? deprecated
  • .getX(slot: int) : number? deprecated
  • :GetY(slot: int) : number? deprecated
  • .getY(slot: int) : number? deprecated
  • :GetZ(slot: int) : number? deprecated
  • .getZ(slot: int) : number? deprecated
  • :GetYaw(slot: int) : number? deprecated
  • .getYaw(slot: int) : number? deprecated

API

Properties

Animations

Animations readonly : NpcAnimation
Table of named animation ids for `NPC:SetAnim`.

Methods

Create

Create(name: string, shirtId: int, pantsId: int, headId: int, skinOrAccs: string|List of int, ...) : NPC?
Spawns an NPC and returns it, or nil on failure.
The display name gets " [NPC]" appended.

Without accessories, the 5th argument is skin hex, then optional x, y, z:

local npc = NPCs:Create("Guide", 31, 32, 19, "#eaeaea", 0, 5, 0)
npc:SetAnim(NPCs.Animations.Idle)
npc:Chat("Welcome!")

With accessories (max 3 catalog ids), the 5th argument is a list, the 6th is skin hex, then optional x, y, z:

local npc = NPCs:Create("Guide", 31, 32, 19, { 42, 17 }, "#eaeaea", 0, 5, 0)

Default position is (0, 4, 0) when omitted.

create

create(name: string, shirtId: int, pantsId: int, headId: int, skinOrAccs: string|List of int, ...) : NPC? deprecated
Identical to Create.
No longer recommended for use.

Destroy

Destroy(slot: int) : void deprecated
Removes the NPC in the given slot.
Prefer `NPC:Destroy` on the object from Create.
No longer recommended for use.

destroy

destroy(slot: int) : void deprecated
Identical to Destroy.
No longer recommended for use.

Chat

Chat(slot: int, message: string) : void deprecated
Prefer `NPC:Chat`.
No longer recommended for use.

chat

chat(slot: int, message: string) : void deprecated
Identical to Chat.
No longer recommended for use.

MoveTo

MoveTo(slot: int, x: number, y: number, z: number) : void deprecated
Prefer `NPC:MoveTo`.
No longer recommended for use.

moveTo

moveTo(slot: int, x: number, y: number, z: number) : void deprecated
Identical to MoveTo.
No longer recommended for use.

TpTo

TpTo(slot: int, x: number, y: number, z: number) : void deprecated
Prefer `NPC:TpTo`.
No longer recommended for use.

tpTo

tpTo(slot: int, x: number, y: number, z: number) : void deprecated
Identical to TpTo.
No longer recommended for use.

SetYaw

SetYaw(slot: int, degrees: number) : void deprecated
Prefer `NPC:SetYaw`.
No longer recommended for use.

setYaw

setYaw(slot: int, degrees: number) : void deprecated
Identical to SetYaw.
No longer recommended for use.

SetAnim

SetAnim(slot: int, anim: int) : void deprecated
Prefer `NPC:SetAnim`.
No longer recommended for use.

setAnim

setAnim(slot: int, anim: int) : void deprecated
Identical to SetAnim.
No longer recommended for use.

GetX

GetX(slot: int) : number? deprecated
Prefer `NPC.Position`.
No longer recommended for use.

getX

getX(slot: int) : number? deprecated
Identical to GetX.
No longer recommended for use.

GetY

GetY(slot: int) : number? deprecated
Prefer `NPC.Position`.
No longer recommended for use.

getY

getY(slot: int) : number? deprecated
Identical to GetY.
No longer recommended for use.

GetZ

GetZ(slot: int) : number? deprecated
Prefer `NPC.Position`.
No longer recommended for use.

getZ

getZ(slot: int) : number? deprecated
Identical to GetZ.
No longer recommended for use.

GetYaw

GetYaw(slot: int) : number? deprecated
Prefer `NPC.Yaw`.
No longer recommended for use.

getYaw

getYaw(slot: int) : number? deprecated
Identical to GetYaw.
No longer recommended for use.