NPCs

Internal

Name Type Info
codestring
Full type name for the ModNPC-extending class to be used for this NPC.
Default: {internalName}.NPCs.{filename}
netAlwaysbool
Whether this NPC should always be synced in multiplayer.
Default: false

Informative

Name Type Info
displayNamestring
NPC name in-game.
occupationstring
The type of town NPC this NPC is.
Default: current JSON filename
valueint
int[1-4]
NPC's value (also the average amount of copper coins it drops).
"value": 105099 - 10g 50s 99c
"value": [2,20,9,3] - 2p 20g 9s 3c

Stats

Name Type Info
lifeMaxint
The maximum amount of life for this NPC.
damageint
The amount of damage dealt by the NPC.
Default: 0
defenseint
The amount of defense had by the NPC.
Default: 0
knockbackResistfloat
The amount of resistance to knockback the NPC has.
Default: 1
critChanceint
The chance of the NPC performing a critical strike, in percent.
Default: 0
critMultfloat
The damage multiplier when the NPC performs a critical strike.
Default: 2

Appearance

Name Type Info
texturestring
Path to the texture used by this NPC, not including file extension.
Default: current JSON filename
sizeint[2]
NPC size in pixels.
width and height properties can be used instead.
widthint
NPC width in pixels.
size property can be used instead.
heightint
NPC height in pixels.
size property can be used instead.
scalefloat
A scale multiplier to be used by the NPC.
Default: 1
frameCountint
The amount of frames used in this NPC's texture.
Default: 1
animationStyleint
The animation style used by this NPC.
behindTilesbool
Whether or not the NPC is drawn behind tiles.
Default: false
colorint[3]
int[4]
The color to tint the NPC's texture, in RGB or RGBA format.
"color": [255,255,255] - white
"color": [255,0,0,127] - red, half-transparent
Default: [255,255,255]
alphaint
The transparency of the NPC, where 0 is opaque, and 255 is invisible.
Default: 0

Interface

Name Type Info
textureHeadstring
Used only by town NPCs. Path to the head texture used by this NPC, not including file extension.
Default: {texture}._Head
shopbool
Whether this Town NPC has a shop.
Default: false
showHealthBarbool
Whether to show the health bar above the NPC.
Default: true
lifeBarScalefloat
A scale multiplier used by the NPC's life bar.
Default: 1
realLifeHealthBarbool
Whether or not to use the realLife value for the health bar, used for multipart NPCs.
Default: false

Gameplay

Name Type Info
npcSlotsfloat
The amount of spawn slots this NPC takes up, the higher the value, the less other NPCs can spawn.
Default: 1
aiStyleint
The AI used by this NPC.
friendlybool
Whether this NPC is friendly.
Default: false
townNPCbool
Whether this NPC is a town NPC.
Default: false
malebool
Whether this Town NPC is male or female.
bossbool
Whether this NPC is a boss.
Default: false
dontTakeDamagebool
Whether the NPC is immune to damage.
Default: false
lavaImmunebool
Whether the NPC is immune to lava damage.
Default: false
noGravitybool
Whether the NPC is unaffected by gravity.
Default: false
noTileCollidebool
Whether the NPC can pass through tiles.
Default: false
buffImmune<string/int>[?]
An array of buff names and types that this NPC is immune to.
soundHitint
string
The hit sound used by this NPC.
"soundHit": 12 - vanilla sound 12 (Space Gun)
"soundHit": "MySound" - custom sound filename without the extension
soundKilledint
string
The death sound used by this NPC.
"soundKilled": 12 - vanilla sound 12 (Space Gun)
"soundKilled": "MySound" - custom sound filename without the extension
musicstring
The name of the music to play when this NPC is on screen.
dropsobject[?]
An array of items this NPC can drop.
coldDamagebool
Wether or not the damage this npc causes should be considered 'cold' damage. (Used to reduce damage with the warmth potion).
Default: false
collisonFallThroughbool
Wether or not the this npc falls through platforms. (Only used by npcs using zombie AI (aiStyle 3)).
Default: false