Skip to content

npc: members

87 implemented, 29 reserved. Entries are sorted by name.

npc.actionplayer: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

The id of the player whose action this NPC last answered, or -1.

echo(this.actionplayer);

Specification: world-and-objects.md§20.8.

npc.ani: string

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The gani the NPC is playing.

echo(this.ani);

Specification: world-and-objects.md§4.2.

npc.blockagain() -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Makes this NPC block movement again.

this.blockagain();

Specification: world-and-objects.md§11.

npc.blockagainlocal()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Makes this NPC block again on this client only.

this.blockagainlocal();

Specification: world-and-objects.md§20.8.

npc.body: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The body image of a character NPC; the same as bodyimg.

showcharacter(); this.body = "body0.png";

Specification: world-and-objects.md§4.2.

npc.bodyimg: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The body image of a character NPC; the same as body.

showcharacter(); this.bodyimg = "body0.png";

Specification: world-and-objects.md§4.2.

npc.canbecarried()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Marks this NPC as one a player can carry on this client.

this.canbecarried();

Specification: world-and-objects.md§20.8.

npc.canbepulled()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Marks this NPC as one a player can pull on this client.

this.canbepulled();

Specification: world-and-objects.md§20.8.

npc.canbepushed()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Marks this NPC as one a player can push on this client.

this.canbepushed();

Specification: world-and-objects.md§20.8.

npc.cancelevents(event: string) -> number

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

Cancels the scheduled events of that name on this NPC.

this.cancelevents("onLater");

Specification: world-and-objects.md§9.3.

npc.cannotbecarried()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Clears the carry mark of this NPC on this client.

this.cannotbecarried();

Specification: world-and-objects.md§20.8.

npc.cannotbepulled()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Clears the pull mark of this NPC on this client.

this.cannotbepulled();

Specification: world-and-objects.md§20.8.

npc.cannotbepushed()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Clears the push mark of this NPC on this client.

this.cannotbepushed();

Specification: world-and-objects.md§20.8.

npc.changeimgcolors(index: number, red: number, green: number, blue: number, alpha: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Sets the color and opacity of a show image; each value is from 0 to 1. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.changeimgcolors(300, 1, 0.5, 0.5, 1);

Specification: client-rendering.md§8.1.

npc.changeimgmode(index: number, mode: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Sets the effect mode of a show image: 0 add, 1 alpha, 2 subtract, 3 multiply. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.changeimgmode(300, 0);

Specification: client-rendering.md§8.1.

npc.changeimgpart(index: number, x: number, y: number, width: number, height: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Shows only a pixel rectangle of the image of a show image. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.changeimgpart(300, 0, 0, 16, 16);

Specification: client-rendering.md§8.1.

npc.changeimgvis(index: number, layer: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Sets the layer of a show image. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.changeimgvis(300, 2);

Specification: client-rendering.md§8.1.

npc.changeimgzoom(index: number, zoom: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Sets the zoom of a show image. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.changeimgzoom(300, 2);

Specification: client-rendering.md§8.1.

npc.chat: string

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The text shown over the NPC.

echo(this.chat);

Specification: world-and-objects.md§4.2.

npc.colors: array

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The five character colors of an NPC (skin, coat, sleeves, shoes, belt) as names or indexes; showcharacter creates the array.

showcharacter(); this.colors[0] = "orange";

Specification: world-and-objects.md§4.2.

npc.destroy() -> number

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Destroys this NPC: onDestroy runs, then the object goes away.

this.destroy();

Specification: world-and-objects.md§11.

npc.dir: number

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

The direction: 0 up, 1 left, 2 down, 3 right.

echo(this.dir);

Specification: world-and-objects.md§4.2.

npc.dontblock() -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Lets players walk through this NPC.

this.dontblock();

Specification: world-and-objects.md§11.

npc.dontblocklocal()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Makes this NPC stop blocking on this client only.

this.dontblocklocal();

Specification: world-and-objects.md§20.8.

npc.drawaslight() -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Draws this NPC additively, as light.

this.drawaslight();

Specification: world-and-objects.md§11.

npc.drawoverplayer()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Draws this NPC above the characters on this client.

this.drawoverplayer();

Specification: world-and-objects.md§20.8.

npc.drawunderplayer() -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Draws this NPC below the players.

this.drawunderplayer();

Specification: world-and-objects.md§11.

npc.findimg(index: number) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Returns the show image of the calling object with the index, creating an empty one when there is none. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

with (this.findimg(300)) { alpha = 0.5; }

Specification: client-rendering.md§8.1.

npc.head: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The head image of a character NPC; the same as headimg.

showcharacter(); this.head = "head0.png";

Specification: world-and-objects.md§4.2.

npc.headimg: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The head image of a character NPC; the same as head.

showcharacter(); this.headimg = "head0.png";

Specification: world-and-objects.md§4.2.

npc.height: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

The height of the NPC in tiles: its image part, else its image, else the 3 tiles of a character.

echo(this.height);

Specification: world-and-objects.md§20.8.

npc.hide()

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

Hides this NPC. On the server the change replicates to every client; on the client it stays local and the next change from the server wins.

this.hide();

Specification: world-and-objects.md§20.8.

npc.hideimg(index: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Removes the show image with the index. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.hideimg(300);

Specification: client-rendering.md§8.1.

npc.hideimgs(first: number, last: number)

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Removes the show images from the first index to the last, both included. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.hideimgs(300, 310);

Specification: client-rendering.md§8.1.

npc.hidelocal()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Stops drawing this NPC on this client, whatever its visible field says.

this.hidelocal();

Specification: world-and-objects.md§20.8.

npc.horseimg: string

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The image of the horse this NPC rides.

this.horseimg = "horse.png";

Specification: world-and-objects.md§20.8.

npc.id: number

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The id of the NPC. Read-only.

echo(this.id);

Specification: world-and-objects.md§4.2.

npc.image: string

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The image of the NPC.

echo(this.image);

Specification: world-and-objects.md§4.2.

npc.isblocking: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Whether the NPC blocks on this client; setting it overrides what the server sent.

this.isblocking = false;

Specification: world-and-objects.md§20.8.

npc.isblockingprojectiles: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Whether projectiles stop at this NPC on this client. True by default.

this.isblockingprojectiles = false;

Specification: world-and-objects.md§20.8.

npc.isinclass(className: string) -> boolean

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

1 when this NPC joined the class.

if (this.isinclass("shop")) echo(1);

Specification: world-and-objects.md§6.

npc.join(className: string) -> number

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

Adds the functions of the class to this NPC; on a player the join lasts until logout.

this.join("shop");

Specification: world-and-objects.md§6.

npc.layer: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The drawing layer of the NPC on this client: 0 under the characters, 2 among them, 3 and up above.

this.layer = 3;

Specification: world-and-objects.md§20.8.

npc.leave(className: string) -> number

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

Takes the functions of a joined class away from this NPC.

this.leave("shop");

Specification: world-and-objects.md§6.

npc.level: string

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

The name of the level the NPC is in. Read-only.

echo(this.level);

Specification: world-and-objects.md§4.2.

npc.message(text: string) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Shows the text above this NPC.

this.message("Hello");

Specification: world-and-objects.md§11.

npc.move(dx: number, dy: number, time: number, options: number) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Moves this NPC by the offset over the time; option 8 raises onMovementFinished at the end.

this.move(2, 0, 1, 8);

Specification: world-and-objects.md§11.

npc.name: string

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The name of a DB NPC. Read-only.

echo(this.name);

Specification: world-and-objects.md§4.2.

npc.nick: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The nickname drawn below the NPC while it shows a character (showcharacter), like a player’s nickname.

showcharacter(); this.nick = "Guard";

Specification: world-and-objects.md§4.2.

npc.npcsindex: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

The index of the NPC in the NPCs of its level, or -1.

echo(this.npcsindex);

Specification: world-and-objects.md§20.8.

npc.peltwithblackstone: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithblackstone);

Specification: world-and-objects.md§20.8.

npc.peltwithbush: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithbush);

Specification: world-and-objects.md§20.8.

npc.peltwithnpc: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithnpc);

Specification: world-and-objects.md§20.8.

npc.peltwithsign: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithsign);

Specification: world-and-objects.md§20.8.

npc.peltwithstone: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithstone);

Specification: world-and-objects.md§20.8.

npc.peltwithvase: boolean

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Always false: thrown things are not tracked.

echo(this.peltwithvase);

Specification: world-and-objects.md§20.8.

npc.save: array

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

Ten slots for the script, all 0 at first.

echo(this.save[0]);

Specification: world-and-objects.md§20.8.

npc.scheduleevent(delay: number, event: string, ...args?: any)

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

Raises the event on this NPC after the delay in seconds.

this.scheduleevent(2, "onLater", 1);

Specification: world-and-objects.md§9.3.

npc.setani(ani: string, params: string)

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Plays the animation on this NPC, with its comma-separated parameters.

this.setani("idle", "");

Specification: world-and-objects.md§11.

npc.setbow(image: string)

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Sets the bow image this NPC shows when it is drawn as a character on this client.

this.setbow("bow.png");

Specification: world-and-objects.md§20.8.

npc.setcharani(ani: string, param: string) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Like setani, for the character look of this NPC.

this.setcharani("walk", "");

Specification: world-and-objects.md§11.

npc.setimg(file: string) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Sets the image of this NPC.

this.setimg("sign.png");

Specification: world-and-objects.md§11.

npc.setimgpart(file: string, x: number, y: number, width: number, height: number) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Shows a part of an image for this NPC.

this.setimgpart("tiles.png", 0, 0, 32, 32);

Specification: world-and-objects.md§11.

npc.setshape(type: number, width: number, height: number) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Sets the blocking box of this NPC in pixels.

this.setshape(1, 32, 32);

Specification: world-and-objects.md§11.

npc.settimer(seconds: number)

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Starts the timer of this NPC; onTimeout runs when it runs out.

this.settimer(1);

Specification: world-and-objects.md§11.

npc.shield: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The shield image of a character NPC; the same as shieldimg.

showcharacter(); this.shield = "shield0.png";

Specification: world-and-objects.md§4.2.

npc.shieldimg: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The shield image of a character NPC; the same as shield.

showcharacter(); this.shieldimg = "shield0.png";

Specification: world-and-objects.md§4.2.

npc.show()

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

Shows this NPC again after hide.

this.show();

Specification: world-and-objects.md§20.8.

npc.showani(index: number, x: number, y: number, dir: number, ani: string) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Creates a show image that plays a gani in a direction. An optional last argument is a comma separated list of parameters for the gani. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showani(302, 10, 10, 2, "idle");

Specification: client-rendering.md§8.1.

npc.showani2(index: number, x: number, y: number, dir: number, ani: string, layer: number) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Like showani with the layer as the last argument; parameters, when given, come before the layer. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showani2(302, 10, 10, 2, "idle", 1);

Specification: client-rendering.md§8.1.

npc.showcharacter() -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Draws this NPC as a character (head, body, sword, shield) instead of an image.

this.showcharacter();

Specification: world-and-objects.md§11.

npc.showimg(index: number, file: string, x: number, y: number) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Creates or replaces the show image with the index, showing the file at the position. Indexes from 200 up stay on this client; lower ones are shared with nearby players. The position is in tiles on layers 0 to 3. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showimg(300, "block.png", 10, 12);

Specification: client-rendering.md§8.1.

npc.showimg2(index: number, file: string, x: number, y: number, layer: number) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Like showimg with the layer as the last argument. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showimg2(300, "block.png", 10, 12, 1);

Specification: client-rendering.md§8.1.

npc.showlocal()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Draws this NPC again on this client after hidelocal.

this.showlocal();

Specification: world-and-objects.md§20.8.

npc.showtext(index: number, x: number, y: number, font: string, style: string, text: string) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Creates a show image that draws text. The style is a string of letters: b bold, i italic, u underline, s strikethrough, c centered, r right. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showtext(301, 4, 4, "", "b", "Hello");

Specification: client-rendering.md§8.1.

npc.showtext2(index: number, x: number, y: number, font: string, style: string, text: string, layer: number) -> showimg

Runs on: server and client. Origin: compatibility. Since: M5. Playground: no.

Like showtext with the layer as the last argument. On the server it runs on an NPC and the change is sent to every client that knows the NPC.

this.showtext2(301, 4, 4, "", "b", "Hello", 4);

Specification: client-rendering.md§8.1.

npc.sprite: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

The sprite index of the NPC, from 0 to 40.

this.sprite = 3;

Specification: world-and-objects.md§20.8.

npc.sword: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The sword image of a character NPC; the same as swordimg.

showcharacter(); this.sword = "sword0.png";

Specification: world-and-objects.md§4.2.

npc.swordimg: string

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

The sword image of a character NPC; the same as sword.

showcharacter(); this.swordimg = "sword0.png";

Specification: world-and-objects.md§4.2.

npc.timereverywhere()

Runs on: client only. Origin: compatibility. Since: M8. Playground: no.

Marks this NPC as one whose timeouts run wherever the player is. Client NPC timeouts always run in the loaded levels, so this only records the request.

this.timereverywhere();

Specification: world-and-objects.md§20.8.

npc.trigger(event: string, ...args?: any)

Runs on: server and client. Origin: compatibility. Since: M1. Playground: no.

Raises the event on this NPC at once and returns what the handler returned.

this.trigger("onHello", 1);

Specification: world-and-objects.md§9.3.

npc.visible: number

Runs on: server and client. Origin: compatibility. Since: M8. Playground: no.

Whether the NPC is drawn. A server script’s change replicates to the clients; a client script’s change stays local and the next change from the server wins.

for (temp.n: npcs) temp.n.visible = false;

Specification: world-and-objects.md§4.2.

npc.warpto(level: string, x: number, y: number) -> any

Runs on: server and client. Origin: compatibility. Since: M4. Playground: no.

Moves this NPC to another level and position.

this.warpto("inn.nw", 30, 30);

Specification: world-and-objects.md§11.

npc.width: number

Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.

The width of the NPC in tiles, found like its height.

echo(this.width);

Specification: world-and-objects.md§20.8.

npc.x: number

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The x position in tiles.

echo(this.x);

Specification: world-and-objects.md§4.2.

npc.y: number

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The y position in tiles.

echo(this.y);

Specification: world-and-objects.md§4.2.

npc.z: number

Runs on: server and client. Origin: engine extension. Since: M4. Playground: no.

The height in tiles.

echo(this.z);

Specification: world-and-objects.md§4.2.

These names exist so that older scripts compile. Calling one reports R-NOT-IMPLEMENTED and does nothing else.

Name Signature Runs on
bombs npc.bombs() -> any client only (not yet verified)
cannotwarp npc.cannotwarp() -> any client only (not yet verified)
carryobject npc.carryobject(arg1: string) -> any client only (not yet verified)
darts npc.darts() -> any client only (not yet verified)
glovepower npc.glovepower() -> any client only (not yet verified)
gralats npc.gralats() -> any client only (not yet verified)
hearts npc.hearts() -> any client only (not yet verified)
hurt npc.hurt(arg1: number) -> any server and client (not yet verified)
hurtdx npc.hurtdx() -> any client only (not yet verified)
hurtdy npc.hurtdy() -> any client only (not yet verified)
hurtpower npc.hurtpower() -> any client only (not yet verified)
playeronwall npc.playeronwall() -> any client only (not yet verified)
requesttext npc.requesttext(arg1: string, arg2: string) -> any client only (not yet verified)
rupees npc.rupees() -> any client only (not yet verified)
scriptdone npc.scriptdone() -> any client only (not yet verified)
sendtext npc.sendtext(arg1: string, arg2: string, ...params?: any) -> any client only (not yet verified)
setchargender npc.setchargender(arg1: string) -> any client only (not yet verified)
shieldpower npc.shieldpower() -> any client only (not yet verified)
shootarrow npc.shootarrow(arg1: number) -> any client only (not yet verified)
shootball npc.shootball() -> any client only (not yet verified)
shootfireball npc.shootfireball(arg1: number) -> any client only (not yet verified)
shootfireblast npc.shootfireblast(arg1: number) -> any client only (not yet verified)
shootnuke npc.shootnuke(arg1: number) -> any client only (not yet verified)
showstats npc.showstats(statsflag: any) -> any client only (not yet verified)
swordpower npc.swordpower() -> any client only (not yet verified)
take npc.take(arg1: string) -> any server and client (not yet verified)
take2 npc.take2(arg1: number) -> any client only (not yet verified)
takehorse npc.takehorse(arg1: number) -> any client only (not yet verified)
throwcarry npc.throwcarry() -> any client only (not yet verified)

Engine version 0.1.0. Built 2026-11-18.