NPC (TeaScript)

From PGE Wiki
Revision as of 23:02, 4 February 2020 by Void-the-Bat (talk | contribs) (Added hidden script features. Further testing needed for langle and stimer.)
Jump to navigation Jump to search

NPC is a class in TeaScript.vbs that allows you to read/write values of NPCs.

To read the value of NPC use:

NPC(index).name

To change the value of NPC use:

NPC(index).name = value
Name Description
X The X coordinate of the NPC.
Y The Y coordinate of the NPC.
prX The X coordinate of the original position's NPC.
prY The Y coordinate of the original position's NPC.
Xsp The X speed of the NPC.
Ysp The Y speed of the NPC.
ExtX The X placement of the GFX expansion.
ExtY The Y placement of the GFX expansion.
Facing The direction of the NPC.
ForeColor The color of the NPC.
ivala

ivalb

ivalc

Determines the behavior of an NPC. More info on how it works here.
haswing Determines if the NPC has the wing special type and what type of wing movement it has.

0 = None

1 = Jump

2 = Hover Left/Right

3 = Hover Up/Down

4 = Chase

5 = Hover Forward

6 = Lakitu's AI

7 = Controlled by NPC-308

8 = SMW Lines

id The ID of the NPC.
addvx The x-axis platform speed of the NPC.
addvy The y-axis platform speed of the NPC.
friendly Determines if the NPC is marked as friendly or not.
nomove Determines if the NPC's "Don't Move" flag is enabled.
curframe The current frame of the NPC.
health The current health of the NPC.
advSet Determines the advanced value of the NPC.
permID The permanaent ID of the NPC.
alive Checks for if the NPC is alive or active.
bkupx The backup X position of the NPC.
bkupy The backup Y position of the NPC.
stand Determines if the NPC is affected by gravity. (1: off, 0: on)
curtime The individual frame timer of the NPC. Counts from 1 to 8 and then resets.
scount This value will be set to 1 if another NPC is colliding with the current.
dtcplayer Determines if the NPC is able to detect players. (1: off, 0: on)
dtcliquid Determines if the NPC is able to detect liquids or not.
dtcself Determines if the NPC is able to detect other NPCs or not.
zpos The z-position of the NPC.
inwater Determines if the NPC is using water physics or not.
extx The horizontal GFX expansion offset of the NPC.
exty The Vertical GFX expansion offset of the NPC.
extset External settings for the NPC. For bubbles and SMW Lakitus, the NPC ID they contain will depend on what this value is set to.
target Determines which player is closest. Primarily used for chasing NPCs.
hide Hides the NPC if set to 1.
langle Unknown effect.
stimer Unknown effect.