tAPI · Docs · Items

Internal

Name	Type	Info

Informative

Name	Type	Info

Appearance

Name	Type	Info

Armor

Name	Type	Info

Use

Name	Type	Info

Combat

Name	Type	Info

Potion

Name	Type	Info

Tile

Name	Type	Info

Unsorted

Name Type Info

name

string

The unique item name in the mod

width and height properties can be used instead.

Default: File name without extension

texture

string

Path to the texture used by this item, not including file extension.

Default: current JSON filename

code

string

Full type name for the ModItem-extending class to be used for this item.

Default: {internalName}.Items.{filename}

displayName

string

Item name in-game (in interface).

size

int[2]

Item hitbox when laying in the world.

width and height properties can be used instead.

width

int

Item hitbox width when laying in the world.

size property can be used instead.

height

int

Item hitbox height when laying in the world.

size property can be used instead.

scale

float

Scale multiplier used when drawing the item in the world.

Default: 1

tooltip

string
string[?]

The tooltip of the item, as seen in game.


						"tooltip": "The cabin"

"tooltip": [

"Call in Jan Egeland!",

"I'm in second line!"

]

useStyle

int

Use style to use.

Default: 0

holdStyle

int

Hold style to use.

Default: 0

useAnimation

int

How long the animation of an item lasts in ticks.

Default: 100

useTime

int

How long it takes to use an item in ticks.

Default: 100

channel

bool

Whether the item can be channeled.

Default: false

maxStack

int

The maximum stack size of the item.

Default: 1

pick
axe
hammer

int

The pickaxe/axe/hammer power of the item, as a percentage.

Default: 0

tileBoost

int

The tile placement range increase when equipped.

Default: 0

placeStyle

int

Tile placement style to use.

Default: 0

damage

int

Item damage.

Default: 0

knockback

float

Item knockback strength.

Default: 0

healLife
healMana

int

How much current life/mana the item gives when consumed.

Default: 0

potion

bool

Whether the item is a potion (triggers the Potion Sickness debuff).

Default: false

consumable

bool

Whether the item is consumed on usage.

Default: false

autoReuse

bool

Whether the item can be continuously used by holding down.

Default: false

useTurn

bool

Whether the player will turn to face the mouse.

Default: false

defense

int

The defense the item provides when equipped.

Default: 0

rare

int

The rarity value of the item.

Value	Color	Lava immunity
-1 and less	Gray
0	White
1	Blue
2	Green
3	Orange
4	Red
5	Magenta
6	Purple
7	Light Green
8	Yellow
9	Cyan

Default: 0

shootSpeed

float

How fast projectiles are shot by this item.

Default: 1

notAmmo

bool

Whether the ammo tooltip of the item should be hidden (for example, coins for Coin Gun).

Default: false

lifeRegen

int

How much life regeneration the item provides when equipped.

Default: 0

manaIncrease

int

How much mana the item provides when equipped.

Default: 0

mana

int

How much mana it takes to use the item.

Default: 0

noUseGraphic

bool

Whether or not to hide the item when used.

Default: false

vanity

bool

Whether or not the item is a vanity item.

Default: false

crit

int

The critical chance bonus of the item, in percent.

Default: 0

melee
ranged
magic
summon

bool

Specifies item damage type.

Some items don't have any damage type specified, which effects in them not getting any +X% {type} damage effects (for example, Explosive Bunny).

Default: false

reuseDelay

int

The delay before an item can be used again, in ticks.

Default: 0

color

int[3]
int[4]

The color to tint the item's texture, in RGB or RGBA format.

"color": [255,255,255] - white
"color": [255,0,0,127] - red, half-transparent

Default: [255,255,255]

notMaterial

bool

Whether the material tooltip of the item should be hidden (for example, Phaseblades).

Default: false

mech

bool

Whether wires should display when this item is selected.

Default: false

makeNPC

int
string

The NPC spawned when using this item.

"makeNPC": 355 - vanilla npc 355 (Firefly)
"makeNPC": "My NPC" - a custom NPC from the same mod as the item

value

int
int[1-4]

Item buying value (selling value is 5x smaller).

"value": 105099 - 10g 50s 99c
"value": [2,20,9,3] - 2p 20g 9s 3c

holdoutOffset

float[2]

The offset of the item texture while held, in pixels.

Default: [0,0]

holdoutOrigin

float[2]

The origin of the item texture while held, in decimal percent.

noMelee

bool

Whether or not to prevent melee damage from this item.

Default: false

useSound

int
string

The sound played when using the item.

"useSound": 12 - vanilla sound 12 (Space Gun)
"useSound": "MySound" - custom sound filename without the extension

shoot

int
string

Projectile type used by this weapon.

"shoot": 27 - vanilla projectile 27 (Water Bolt)
"shoot": "MyProjectile" - custom projectile

useAmmo

int
string

The type of the ammo used by this item. If weapon's useAmmo and ammo's ammo properties match, the projectile is fired and ammo consumed.

"useAmmo": 14 - vanilla type 14 (bullets)
"useAmmo": "MyAmmoType" - custom ammo type

ammo

int
string

The type of the ammo of this item. If weapon's useAmmo and ammo's ammo properties match, the projectile is fired and ammo consumed.

"ammo": 14 - vanilla type 14 (bullets)
"ammo": "MyAmmoType" - custom ammo type

accessory

bool

Whether the item is an accessory.

Default: false

buff

int
string

The type of the buff given by this item.

"buff": 26 - vanilla buff 26 (Well Fed)
"buff": "MyBuff" - custom buff

buffTime

int

The duration of the buff given by this item in ticks.

Default: 0

createTile

int
string

The type of the tile created by this item.

"createTile": 62 - vanilla tile 62 (Jungle Vines)
"createTile": "MyTile" - custom tile

tileWand

int
string

The material consumed when placing tiles.

"tileWand": 9 - vanilla item 9 (Wood)
"tileWand": "MyItem" - custom item

createWall

int
string

The type of the wall created by this item.

"createWall": 1 - vanilla wall 1 (Stone Wall)
"createWall": "MyWall" - custom wall

hairType

int{x}

How to handle hair drawing.

Value	Behavior
0	No hair
1	Over hair
2	Over alternate hair (for hats)
3	No head

Default: 0

setName

string

Name of the armor set this item belongs to.

armorHead
armorBody
armorLegs

bool

Whether this can be equipped as head/body/legs armor.

Default: false

hasHands

bool

Whether or not the armor texture includes hands, disabling drawing the naked hands.

Default: false

hasArms

bool

Whether or not the armor texture includes arms, disabling drawing the naked arms.

Default: false

textureHead
textureBody
textureLegs

string

Path to the head/body/legs texture used by this item, not including file extension.

Default: {texture}._Head / {texture}._Body / {texture}._Legs

textureArm

string

Path to the arm texture used by this item, not including file extension.

Default: {texture}._Arm

textureFemale

string

Path to the female body texture used by this item, not including file extension.

Default: {texture}._Body_Female

recipes

object(recipe)[?]

An array of recipes.

noWet

bool

Wether or not this item can be used underwater.

Default: false (can be used underwater)

mountType

int

The type of mount this item spawns.

This currently only supports 1 through 6 (vanilla mounts). Custom ones may be supported in the future.

Default: 0 (None)