NPC (TeaScript)

From PGE Wiki
Revision as of 08:38, 31 December 2020 by Void-the-Bat (talk | contribs) (Fixed typos.)
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 Type Description
X R&W The X coordinate of the NPC.
Y R&W The Y coordinate of the NPC.
width R&W The width of the NPC. The sprite's width will also be altered if AutoScale is enabled.
height R&W The height of the NPC. The sprite's height will also be altered if AutoScale is enabled.
prX R&W The X coordinate of the original position's NPC.
prY R&W The Y coordinate of the original position's NPC.
Xsp R&W The X speed of the NPC.
Ysp R&W The Y speed of the NPC.
ExtX R&W The X placement of the GFX expansion.
ExtY R&W The Y placement of the GFX expansion.
Facing R&W The direction of the NPC. 1: Left; 0: Right.
ForeColor R&W The color of the NPC.
ivala

ivalb

ivalc

R&W Individual variables of the NPCs.

Some default NPCs uses them and altering their values will define their behavior. (More info here.).

haswing R&W 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 R&W The ID of the NPC.
addvx R The x-axis platform/layer speed where the NPC is, addvx will change prx.
addvy R The y-axis platform/layer speed where the NPC is, addvy will change pry.
friendly R&W Determines if the NPC is marked as friendly or not.
nomove R&W Determines if the NPC's "Don't Move" flag is enabled.
curframe R&W The current frame of the NPC.
health R&W The current health of the NPC.
advSet R&W Determines the advanced setting value of the NPC.
permID R The permanent ID of the NPC.
alive R&W Checks for if the NPC is alive or not. Forcing this value to 0 won't completely kill the NPC, use 'nkill' instead.
bkupx R&W The backup X position of the NPC.
bkupy R&W The backup Y position of the NPC.
stand R&W Determines if the NPC has gravity or not
curtimer R&W The individual frame timer of the NPC. Counts from 1 to 8(framespeed flag) and then resets. If frameStyle flag is "No Animation" then this property is initialized to 1 and is left unused.
scount R This property counts how many npc are colliding with the current one, only if it has the same id type. Deprecated in 1.4.5.
dtcplayer R&W Determines if the NPC is able to detect players. (1: off, 0: on)
dtcliquid R&W Determines if the NPC is able to detect liquids or not.
dtcself R&W Determines if the NPC is able to detect other NPCs or not.
zpos R&W The z-position of the NPC.
inwater R Determines if the NPC is underwater or not.
extset R&W External settings for the NPC. For bubbles, parachutes and Lakitus, this value stands for the NPC ID they contain.
target R&W Determines which player is the closest. Primarily used for chasing NPCs.
hide R&W Hides the NPC if set to 1.
langle R&W Unknown effect.
stimer R&W Unknown effect.
talkevent R&W Determines the event called (as a string) when pressing up in front of a friendly NPC.
deathevent R&W Determines the event called (as a string) when the assigned NPC is destroyed.
activeevent R&W Determines the event called (as a string) when the assigned NPC first appears on screen.
nextframeevent R&W Determines the event called (as a string) every frame the assigned NPC is active.
touchevent R&W Determines the event called (as a string) when a player comes into collision with the assigned NPC.
grabedevent R&W Determines the event called (as a string) when a player grabs the assigned NPC. (NOTE: The name is not a typo.)
layerclearedevent R&W Determines the event called (as a string) when every object within the assigned layer is destroyed/cleared.
forecolor_r R&W The red channel of the NPC's forecolor.
forecolor_g R&W The green channel of the NPC's forecolor.
forecolor_b R&W The blue channel of the NPC's forecolor.
forecolor_a R&W The alpha/transparency channel of the NPC's forecolor.