tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.ModItem Class Reference

This class serves as a place for you to place all your properties and hooks for each item. Create instances of ModItem (preferably overriding this class) to pass as parameters to Mod.AddItem. More...

Inherits Terraria.ModLoader.ModTexturedType.

Inherited by Terraria.ModLoader.Default.ModLoaderModItem.

Public Member Functions

virtual void AddRecipes ()
 This is essentially the same as Mod.AddRecipes. Do note that this will be called for every instance of the overriding ModItem class that is added to the game. This allows you to avoid clutter in your overriding Mod class by adding recipes for which this item is the result. More...
 
virtual bool AllowPrefix (int pre)
 Force a re-roll of a prefix by returning false. More...
 
virtual bool AltFunctionUse (Player player)
 Allows you to make this item usable by right-clicking. Returns false by default. When this item is used by right-clicking, player.altFunctionUse will be set to 2. More...
 
virtual void AnglerQuestChat (ref string description, ref string catchLocation)
 Allows you to set what the Angler says when he requests for this item. The description parameter is his dialogue, and catchLocation should be set to "\n(Caught at [location])". More...
 
virtual void ArmorArmGlowMask (Player drawPlayer, float shadow, ref int glowMask, ref Color color)
 Allows you to modify which glow mask and in what color is drawn on the player's arms. Note that this is only called for body armor. Also note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void ArmorSetShadows (Player player)
 Allows you to determine special visual effects this vanity set has on the player without having to code them yourself. Note that this hook is only ever called through this item's associated equipment texture. Use the player.armorEffectDraw bools to activate the desired effects. More...
 
virtual void AutoDefaults ()
 Automatically sets certain defaults. Override this if you do not want the properties to be set for you. More...
 
virtual void AutoLightSelect (ref bool dryTorch, ref bool wetTorch, ref bool glowstick)
 Allows you to tell the game whether this item is a torch that cannot be placed in liquid, a torch that can be placed in liquid, or a glowstick. This information is used for when the player is holding down the auto-select keybind. More...
 
virtual void AutoStaticDefaults ()
 Automatically sets certain static defaults. Override this if you do not want the properties to be set for you. More...
 
virtual bool CanBeConsumedAsAmmo (Player player)
 Whether or not ammo will be consumed upon usage. Called by the ammo; if at least one of this and CanConsumeAmmo returns false then the ammo will not be used. By default returns true.
If false is returned, the OnConsumeAmmo and OnConsumedAsAmmo hooks are never called. More...
 
virtual ? bool CanBurnInLava ()
 Returns whether or not this item will burn in lava regardless of any conditions. Returns null by default (follow vanilla behaviour). More...
 
virtual bool CanConsumeAmmo (Player player)
 Whether or not ammo will be consumed upon usage. Called both by the weapon; if at least one of this and CanBeConsumedAsAmmo returns false then the ammo will not be used. By default returns true.
If false is returned, the OnConsumeAmmo and OnConsumedAsAmmo hooks are never called. More...
 
virtual bool CanEquipAccessory (Player player, int slot)
 Allows you to disallow the player from equipping this accessory. Return false to disallow equipping this accessory. Returns true by default. More...
 
virtual ? bool CanHitNPC (Player player, NPC target)
 Allows you to determine whether this melee weapon can hit the given NPC when swung. Return true to allow hitting the target, return false to block this weapon from hitting the target, and return null to use the vanilla code for whether the target can be hit. Returns null by default. More...
 
virtual bool CanHitPvp (Player player, Player target)
 Allows you to determine whether this melee weapon can hit the given opponent player when swung. Return false to block this weapon from hitting the target. Returns true by default. More...
 
virtual bool CanPickup (Player player)
 Allows you to determine whether or not the item can be picked up More...
 
virtual bool CanRightClick ()
 Returns whether or not this item does something when it is right-clicked in the inventory. Returns false by default. More...
 
virtual bool CanShoot (Player player)
 Allows you to prevent this item from shooting a projectile on use. Returns true by default. More...
 
virtual bool CanStackInWorld (Item item2)
 Allows you to decide if this item is allowed to stack with another of its type in the world. This is only called when attempting to stack with an item of the same type. More...
 
virtual bool CanUseItem (Player player)
 Returns whether or not this item can be used. By default returns true. More...
 
virtual void CaughtFishStack (ref int stack)
 Allows you to determine how many of this item a player obtains when the player fishes this item. More...
 
virtual int ChoosePrefix (UnifiedRandom rand)
 Allows you to manually choose what prefix an item will get. More...
 
virtual ModItem Clone (Item item)
 Create a copy of this ModItem. Called when an item is cloned. More...
 
virtual bool ConsumeItem (Player player)
 If this item is consumable and this returns true, then this item will be consumed upon usage. Returns true by default. If false is returned, the OnConsumeItem hook is never called. More...
 
Recipe CreateRecipe (int amount=1)
 
virtual void DrawArmorColor (Player drawPlayer, float shadow, ref Color color, ref int glowMask, ref Color glowMaskColor)
 Allows you to modify the colors in which this armor and surrounding accessories are drawn, in addition to which glow mask and in what color is drawn. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual bool DrawBody ()
 Return false to hide the player's body when this body armor is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void DrawHair (ref bool drawHair, ref bool drawAltHair)
 Allows you to determine whether the player's hair or alt (hat) hair draws when this head armor is worn. By default both flags will be false. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void DrawHands (ref bool drawHands, ref bool drawArms)
 Allows you to determine whether the skin/shirt on the player's arms and hands are drawn when this body armor is worn. By default both flags will be false. Note that if drawHands is false, the arms will not be drawn either. Also note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual bool DrawHead ()
 Return false to hide the player's head when this head armor is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual bool DrawLegs ()
 Return false to hide the player's legs when this leg armor or shoe accessory is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void EquipFrameEffects (Player player, EquipType type)
 Allows you to create special effects (such as dust) when this item's equipment texture of the given equipment type is displayed on the player. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void ExtractinatorUse (ref int resultType, ref int resultStack)
 Allows you to modify what item, and in what quantity, is obtained when this item is fed into the Extractinator. By default the parameters will be set to the output of feeding Silt/Slush into the Extractinator. More...
 
virtual ? Color GetAlpha (Color lightColor)
 Allows you to determine the color and transparency in which this item is drawn. Return null to use the default color (normally light color). Returns null by default. More...
 
virtual void GetHealLife (Player player, bool quickHeal, ref int healValue)
 Allows you to temporarily modify the amount of life a life healing item will heal for, based on player buffs, accessories, etc. This is only called for items with a healLife value. More...
 
virtual void GetHealMana (Player player, bool quickHeal, ref int healValue)
 Allows you to temporarily modify the amount of mana a mana healing item will heal for, based on player buffs, accessories, etc. This is only called for items with a healMana value. More...
 
virtual void GrabRange (Player player, ref int grabRange)
 Allows you to modify how close this item must be to the player in order to move towards the player. More...
 
virtual bool GrabStyle (Player player)
 Allows you to modify the way this item moves towards the player. Return true if you override this hook; returning false will allow the vanilla grab style to take place. Returns false by default. More...
 
virtual void HoldItem (Player player)
 Allows you to make things happen when the player is holding this item (for example, torches make light and water candles increase spawn rate). More...
 
virtual void HoldItemFrame (Player player)
 Allows you to modify the player's animation when the player is holding this item. More...
 
virtual ? Vector2 HoldoutOffset ()
 Allows you to determine the offset of this item's sprite when used by the player. This is only used for items with a useStyle of 5 that aren't staves. Return null to use the vanilla holdout offset; returns null by default. More...
 
virtual ? Vector2 HoldoutOrigin ()
 Allows you to determine the point on this item's sprite that the player holds onto when using this item. The origin is from the bottom left corner of the sprite. This is only used for staves with a useStyle of 5. Return null to use the vanilla holdout origin (zero); returns null by default. More...
 
virtual void HoldStyle (Player player, Rectangle heldItemFrame)
 Allows you to modify the location and rotation of this item when the player is holding it. More...
 
virtual void HorizontalWingSpeeds (Player player, ref float speed, ref float acceleration)
 Allows you to modify these wing's horizontal flight speed and acceleration. More...
 
virtual bool IsAnglerQuestAvailable ()
 Whether or not specific conditions have been satisfied for the Angler to be able to request this item. (For example, Hardmode.) Returns true by default. More...
 
virtual bool IsArmorSet (Item head, Item body, Item legs)
 Returns whether or not the head armor, body armor, and leg armor make up a set. If this returns true, then this item's UpdateArmorSet method will be called. Returns false by default. More...
 
virtual bool IsQuestFish ()
 Whether or not the Angler can ever randomly request this type of item for his daily quest. Returns false by default. More...
 
virtual bool IsVanitySet (int head, int body, int legs)
 Returns whether or not the head armor, body armor, and leg armor textures make up a set. This hook is used for the PreUpdateVanitySet, UpdateVanitySet, and ArmorSetShadow hooks. By default, this will return the same value as the IsArmorSet hook (passing the equipment textures' associated items as parameters), so you will not have to use this hook unless you want vanity effects to be entirely separate from armor sets. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual bool ItemSpace (Player player)
 Return true to specify that the item can be picked up despite not having enough room in inventory. Useful for something like hearts or experience items. Use in conjunction with OnPickup to actually consume the item and handle it. More...
 
virtual void Load (TagCompound tag)
 Allows you to load custom data that you have saved for this item. More...
 
virtual void MeleeEffects (Player player, Rectangle hitbox)
 Allows you to give this melee weapon special effects, such as creating light or dust. More...
 
virtual void ModifyHitNPC (Player player, NPC target, ref int damage, ref float knockBack, ref bool crit)
 Allows you to modify the damage, knockback, etc., that this melee weapon does to an NPC. More...
 
virtual void ModifyHitPvp (Player player, Player target, ref int damage, ref bool crit)
 Allows you to modify the damage, etc., that this melee weapon does to a player. More...
 
virtual void ModifyManaCost (Player player, ref float reduce, ref float mult)
 Allows you to temporarily modify the amount of mana this item will consume on use, based on player buffs, accessories, etc. This is only called for items with a mana value. More...
 
virtual void ModifyResearchSorting (ref ContentSamples.CreativeHelper.ItemGroup itemGroup)
 Allows you to set an item's sorting group in Journey Mode's duplication menu. This is useful for setting custom item types that group well together, or whenever the default vanilla sorting doesn't sort the way you want it. More...
 
virtual void ModifyShootStats (Player player, ref Vector2 position, ref Vector2 velocity, ref int type, ref int damage, ref float knockback)
 Allows you to modify the position, velocity, type, damage and/or knockback of a projectile being shot by this item. More...
 
virtual void ModifyTooltips (List< TooltipLine > tooltips)
 Allows you to modify all the tooltips that display for this item. See here for information about TooltipLine. More...
 
virtual void ModifyWeaponCrit (Player player, ref int crit)
 Allows you to temporarily modify this weapon's crit chance based on player buffs, etc. More...
 
virtual void ModifyWeaponDamage (Player player, ref StatModifier damage, ref float flat)
 Allows you to temporarily modify this weapon's damage based on player buffs, etc. This is useful for creating new classes of damage, or for making subclasses of damage (for example, Shroomite armor set boosts). More...
 
virtual void ModifyWeaponKnockback (Player player, ref StatModifier knockback, ref float flat)
 Allows you to temporarily modify this weapon's knockback based on player buffs, etc. This allows you to customize knockback beyond the Player class's limited fields. More...
 
virtual void NetReceive (BinaryReader reader)
 Receives the custom data sent in the NetSend hook. More...
 
virtual void NetSend (BinaryWriter writer)
 Allows you to send custom data for this item between client and server. More...
 
virtual void OnConsumeAmmo (Player player)
 Allows you to make things happen when ammo is consumed. Called by the weapon.
Called before the ammo stack is reduced. More...
 
virtual void OnConsumedAsAmmo (Player player)
 Allows you to make things happen when ammo is consumed. Called by the ammo.
Called before the ammo stack is reduced. More...
 
virtual void OnConsumeItem (Player player)
 Allows you to make things happen when this item is consumed. Called before the item stack is reduced. More...
 
virtual void OnConsumeMana (Player player, int manaConsumed)
 Allows you to make stuff happen when a player consumes mana on use of this item. More...
 
virtual void OnCraft (Recipe recipe)
 Allows you to make anything happen when the player crafts this item using the given recipe. More...
 
virtual void OnCreate (ItemCreationContext context)
 
virtual void OnHitNPC (Player player, NPC target, int damage, float knockBack, bool crit)
 Allows you to create special effects when this melee weapon hits an NPC (for example how the Pumpkin Sword creates pumpkin heads). More...
 
virtual void OnHitPvp (Player player, Player target, int damage, bool crit)
 Allows you to create special effects when this melee weapon hits a player. More...
 
virtual void OnMissingMana (Player player, int neededMana)
 Allows you to make stuff happen when a player doesn't have enough mana for the item they are trying to use. If the player has high enough mana after this hook runs, mana consumption will happen normally. Only runs once per item use. More...
 
virtual bool OnPickup (Player player)
 Allows you to make special things happen when the player picks up this item. Return false to stop the item from being added to the player's inventory; returns true by default. More...
 
virtual void OpenBossBag (Player player)
 Allows you to give items to the given player when this item is right-clicked in the inventory if the bossBagNPC field has been set to a positive number. This ignores the CanRightClick and RightClick hooks. More...
 
virtual void PickAmmo (Item weapon, Player player, ref int type, ref float speed, ref int damage, ref float knockback)
 Allows you to modify the projectile created by a weapon based on the ammo it is using. This hook is called on the ammo. More...
 
virtual void PostDrawInInventory (SpriteBatch spriteBatch, Vector2 position, Rectangle frame, Color drawColor, Color itemColor, Vector2 origin, float scale)
 Allows you to draw things in front of this item in the inventory. This method is called even if PreDrawInInventory returns false. More...
 
virtual void PostDrawInWorld (SpriteBatch spriteBatch, Color lightColor, Color alphaColor, float rotation, float scale, int whoAmI)
 Allows you to draw things in front of this item. This method is called even if PreDrawInWorld returns false. More...
 
virtual void PostDrawTooltip (ReadOnlyCollection< DrawableTooltipLine > lines)
 Allows you to do things after this item's tooltip is drawn. The lines contain draw information as this is ran after drawing the tooltip. More...
 
virtual void PostDrawTooltipLine (DrawableTooltipLine line)
 Allows you to do things after a tooltip line of this item is drawn. The line contains draw info. More...
 
virtual void PostReforge ()
 This hook gets called immediately after an item gets reforged by the Goblin Tinkerer. Useful for modifying modded data based on the reforge result. More...
 
virtual void PostUpdate ()
 Allows you to make things happen when this item is lying in the world. This will always be called, even when it is being grabbed by a player. This hook should be used for adding light, or for increasing the age of less valuable items. More...
 
virtual bool PreDrawInInventory (SpriteBatch spriteBatch, Vector2 position, Rectangle frame, Color drawColor, Color itemColor, Vector2 origin, float scale)
 Allows you to draw things behind this item in the inventory. Return false to stop the game from drawing the item (useful if you're manually drawing the item). Returns true by default. More...
 
virtual bool PreDrawInWorld (SpriteBatch spriteBatch, Color lightColor, Color alphaColor, ref float rotation, ref float scale, int whoAmI)
 Allows you to draw things behind this item, or to modify the way this item is drawn in the world. Return false to stop the game from drawing the item (useful if you're manually drawing the item). Returns true by default. More...
 
virtual bool PreDrawTooltip (ReadOnlyCollection< TooltipLine > lines, ref int x, ref int y)
 Allows you to do things before this item's tooltip is drawn. More...
 
virtual bool PreDrawTooltipLine (DrawableTooltipLine line, ref int yOffset)
 Allows you to do things before a tooltip line of this item is drawn. The line contains draw info. More...
 
virtual ? bool PrefixChance (int pre, UnifiedRandom rand)
 To prevent putting the item in the tinkerer slot, return false when pre is -3. To prevent rolling of a prefix on spawn, return false when pre is -1. To force rolling of a prefix on spawn, return true when pre is -1. More...
 
virtual bool PreReforge ()
 This hook gets called when the player clicks on the reforge button and can afford the reforge. Returns whether the reforge will take place. If false is returned, the PostReforge hook is never called. Reforging preserves modded data on the item. More...
 
virtual void PreUpdateVanitySet (Player player)
 Allows you to create special effects (such as the necro armor's hurt noise) when the player wears this item's vanity set. This hook is called regardless of whether the player is frozen in any way. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual bool ReforgePrice (ref int reforgePrice, ref bool canApplyDiscount)
 Returns if the normal reforge pricing is applied. If true or false is returned and the price is altered, the price will equal the altered price. The passed reforge price equals the item.value. Vanilla pricing will apply 20% discount if applicable and then price the reforge at a third of that value. More...
 
virtual void RightClick (Player player)
 Allows you to make things happen when this item is right-clicked in the inventory. Useful for goodie bags. More...
 
virtual TagCompound Save ()
 Allows you to save custom data for this item. Returns null by default. More...
 
virtual void SetDefaults ()
 This is where you set all your item's properties, such as width, damage, shootSpeed, defense, etc. For those that are familiar with tAPI, this has the same function as .json files. More...
 
virtual void SetMatch (bool male, ref int equipSlot, ref bool robes)
 Allows you to modify the equipment that the player appears to be wearing. This hook will only be called for body armor and leg armor. Note that equipSlot is not the same as the item type of the armor the player will appear to be wearing. Worn equipment has a separate set of IDs. You can find the vanilla equipment IDs by looking at the headSlot, bodySlot, and legSlot fields for items, and modded equipment IDs by looking at EquipLoader. If this hook is called on body armor, equipSlot allows you to modify the leg armor the player appears to be wearing. If you modify it, make sure to set robes to true. If this hook is called on leg armor, equipSlot allows you to modify the leg armor the player appears to be wearing, and the robes parameter is useless. Note that this hook is only ever called through this item's associated equipment texture. More...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
virtual bool Shoot (Player player, ProjectileSource_Item_WithAmmo source, Vector2 position, Vector2 velocity, int type, int damage, float knockback)
 Allows you to modify this item's shooting mechanism. Return false to prevent vanilla's shooting code from running. Returns true by default. More...
 
virtual void Update (ref float gravity, ref float maxFallSpeed)
 Allows you to customize this item's movement when lying in the world. Note that this will not be called if this item is currently being grabbed by a player. More...
 
virtual void UpdateAccessory (Player player, bool hideVisual)
 Allows you to give effects to this accessory. The hideVisual parameter is whether the player has marked the accessory slot to be hidden from being drawn on the player. More...
 
virtual void UpdateArmorSet (Player player)
 Allows you to give set bonuses to the armor set that this armor is in. Set player.setBonus to a string for the bonus description. More...
 
virtual void UpdateEquip (Player player)
 Allows you to give effects to this armor or accessory, such as increased damage. More...
 
virtual void UpdateInventory (Player player)
 Allows you to make things happen when this item is in the player's inventory (for example, how the cell phone makes information display). More...
 
virtual void UpdateVanity (Player player)
 Allows you to give effects to this accessory when equipped in a vanity slot. Vanilla uses this for boot effects, wings and merman/werewolf visual flags More...
 
virtual void UpdateVanitySet (Player player)
 Allows you to create special effects (such as dust) when the player wears this item's vanity set. This hook will only be called if the player is not frozen in any way. Note that this hook is only ever called through this item's associated equipment texture. More...
 
virtual void UseAnimation (Player player)
 Allows you to make things happen when this item's use animation starts. Runs on all clients and server. Use More...
 
virtual float UseAnimationMultiplier (Player player)
 Allows you to change the effective useAnimation of an item.
Note that this hook may cause items' actions to run less or more times than they should per a single use. More...
 
virtual ? bool UseItem (Player player)
 Allows you to make things happen when this item is used. The return value controls whether or not ApplyItemTime will be called for the player.
Return true if the item actually did something, to force itemTime.
Return false to keep itemTime at 0.
Return null for vanilla behavior. Runs on all clients and server. Use More...
 
virtual void UseItemFrame (Player player)
 Allows you to modify the player's animation when this item is being used. More...
 
virtual void UseItemHitbox (Player player, ref Rectangle hitbox, ref bool noHitbox)
 Changes the hitbox of this melee weapon when it is used. More...
 
virtual float UseSpeedMultiplier (Player player)
 Allows you to safely change both useTime and useAnimation while keeping the values relative to each other.
Useful for status effects. More...
 
virtual void UseStyle (Player player, Rectangle heldItemFrame)
 Allows you to modify the location and rotation of this item in its use animation. More...
 
virtual float UseTimeMultiplier (Player player)
 Allows you to change the effective useTime of an item.
Note that this hook may cause items' actions to run less or more times than they should per a single use. More...
 
virtual void VerticalWingSpeeds (Player player, ref float ascentWhenFalling, ref float ascentWhenRising, ref float maxCanAscendMultiplier, ref float maxAscentMultiplier, ref float constantAscend)
 Allows you to modify the speeds at which you rise and fall when these wings are equipped. More...
 
virtual bool WingUpdate (Player player, bool inUse)
 Allows for Wings to do various things while in use. "inUse" is whether or not the jump button is currently pressed. Called when these wings visually appear on the player. Use to animate wings, create dusts, invoke sounds, and create lights. Note that this hook is only ever called through this item's associated equipment texture. False will keep everything the same. True, you need to handle all animations in your own code. More...
 
- Public Member Functions inherited from Terraria.ModLoader.ModType
virtual bool IsLoadingEnabled (Mod mod)
 Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config. More...
 
virtual void Load ()
 Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated. More...
 
virtual void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

sealed override void Register ()
 If you make a new ModType, seal this override. More...
 

Properties

virtual int BossBagNPC [get]
 The type of NPC that drops this boss bag. Used to determine how many coins this boss bag contains. Defaults to 0, which means this isn't a boss bag. More...
 
ModTranslation DisplayName [get, set]
 The translations for the display name of this item. More...
 
Item Item [get, set]
 The item object that this ModItem controls. More...
 
virtual bool OnlyShootOnSwing [get]
 Setting this to true makes it so that this weapon can shoot projectiles only at the beginning of its animation. Set this to true if you want a sword and its projectile creation to be in sync (for example, the Terra Blade). Defaults to false. More...
 
ModTranslation Tooltip [get, set]
 The translations for the display name of this tooltip. More...
 
int Type [get]
 Shorthand for item.type; More...
 
- Properties inherited from Terraria.ModLoader.ModTexturedType
virtual string Texture [get]
 The file name of this type's texture file in the mod loader's file space. More...
 
- Properties inherited from Terraria.ModLoader.ModType
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
Mod Mod [get, set]
 The mod this belongs to. More...
 
virtual string Name [get]
 The internal name of this. More...
 
- Properties inherited from Terraria.ModLoader.IModType
string FullName [get]
 => $"{Mod.Name}/{Name}" More...
 
Mod Mod [get]
 The mod this belongs to. More...
 
string Name [get]
 The internal name of this instance. More...
 

Detailed Description

This class serves as a place for you to place all your properties and hooks for each item. Create instances of ModItem (preferably overriding this class) to pass as parameters to Mod.AddItem.

Member Function Documentation

◆ AddRecipes()

virtual void Terraria.ModLoader.ModItem.AddRecipes ( )
virtual

This is essentially the same as Mod.AddRecipes. Do note that this will be called for every instance of the overriding ModItem class that is added to the game. This allows you to avoid clutter in your overriding Mod class by adding recipes for which this item is the result.

Reimplemented in Terraria.ModLoader.Default.AprilFools.

◆ AllowPrefix()

virtual bool Terraria.ModLoader.ModItem.AllowPrefix ( int  pre)
virtual

Force a re-roll of a prefix by returning false.

◆ AltFunctionUse()

virtual bool Terraria.ModLoader.ModItem.AltFunctionUse ( Player  player)
virtual

Allows you to make this item usable by right-clicking. Returns false by default. When this item is used by right-clicking, player.altFunctionUse will be set to 2.

Parameters
playerThe player.
Returns

◆ AnglerQuestChat()

virtual void Terraria.ModLoader.ModItem.AnglerQuestChat ( ref string  description,
ref string  catchLocation 
)
virtual

Allows you to set what the Angler says when he requests for this item. The description parameter is his dialogue, and catchLocation should be set to "\n(Caught at [location])".

Parameters
descriptionThe description.
catchLocationThe catch location.

◆ ArmorArmGlowMask()

virtual void Terraria.ModLoader.ModItem.ArmorArmGlowMask ( Player  drawPlayer,
float  shadow,
ref int  glowMask,
ref Color  color 
)
virtual

Allows you to modify which glow mask and in what color is drawn on the player's arms. Note that this is only called for body armor. Also note that this hook is only ever called through this item's associated equipment texture.

Parameters
drawPlayerThe draw player.
shadowThe shadow.
glowMaskThe glow mask.
colorThe color.

◆ ArmorSetShadows()

virtual void Terraria.ModLoader.ModItem.ArmorSetShadows ( Player  player)
virtual

Allows you to determine special visual effects this vanity set has on the player without having to code them yourself. Note that this hook is only ever called through this item's associated equipment texture. Use the player.armorEffectDraw bools to activate the desired effects.

player.armorEffectDrawShadow = true;
Parameters
playerThe player.

◆ AutoDefaults()

virtual void Terraria.ModLoader.ModItem.AutoDefaults ( )
virtual

Automatically sets certain defaults. Override this if you do not want the properties to be set for you.

◆ AutoLightSelect()

virtual void Terraria.ModLoader.ModItem.AutoLightSelect ( ref bool  dryTorch,
ref bool  wetTorch,
ref bool  glowstick 
)
virtual

Allows you to tell the game whether this item is a torch that cannot be placed in liquid, a torch that can be placed in liquid, or a glowstick. This information is used for when the player is holding down the auto-select keybind.

Parameters
dryTorchif set to true [dry torch].
wetTorchif set to true [wet torch].
glowstickif set to true [glowstick].

◆ AutoStaticDefaults()

virtual void Terraria.ModLoader.ModItem.AutoStaticDefaults ( )
virtual

Automatically sets certain static defaults. Override this if you do not want the properties to be set for you.

◆ CanBeConsumedAsAmmo()

virtual bool Terraria.ModLoader.ModItem.CanBeConsumedAsAmmo ( Player  player)
virtual

Whether or not ammo will be consumed upon usage. Called by the ammo; if at least one of this and CanConsumeAmmo returns false then the ammo will not be used. By default returns true.
If false is returned, the OnConsumeAmmo and OnConsumedAsAmmo hooks are never called.

Parameters
playerThe player consuming the ammo
Returns

◆ CanBurnInLava()

virtual ? bool Terraria.ModLoader.ModItem.CanBurnInLava ( )
virtual

Returns whether or not this item will burn in lava regardless of any conditions. Returns null by default (follow vanilla behaviour).

◆ CanConsumeAmmo()

virtual bool Terraria.ModLoader.ModItem.CanConsumeAmmo ( Player  player)
virtual

Whether or not ammo will be consumed upon usage. Called both by the weapon; if at least one of this and CanBeConsumedAsAmmo returns false then the ammo will not be used. By default returns true.
If false is returned, the OnConsumeAmmo and OnConsumedAsAmmo hooks are never called.

Parameters
playerThe player using the weapon
Returns

◆ CanEquipAccessory()

virtual bool Terraria.ModLoader.ModItem.CanEquipAccessory ( Player  player,
int  slot 
)
virtual

Allows you to disallow the player from equipping this accessory. Return false to disallow equipping this accessory. Returns true by default.

Parameters
playerThe player.
slotThe inventory slot that the item is attempting to occupy.

◆ CanHitNPC()

virtual ? bool Terraria.ModLoader.ModItem.CanHitNPC ( Player  player,
NPC  target 
)
virtual

Allows you to determine whether this melee weapon can hit the given NPC when swung. Return true to allow hitting the target, return false to block this weapon from hitting the target, and return null to use the vanilla code for whether the target can be hit. Returns null by default.

Parameters
playerThe player.
targetThe target.
Returns

◆ CanHitPvp()

virtual bool Terraria.ModLoader.ModItem.CanHitPvp ( Player  player,
Player  target 
)
virtual

Allows you to determine whether this melee weapon can hit the given opponent player when swung. Return false to block this weapon from hitting the target. Returns true by default.

Parameters
playerThe player.
targetThe target.
Returns
true if this instance [can hit PVP] the specified player; otherwise, false.

◆ CanPickup()

virtual bool Terraria.ModLoader.ModItem.CanPickup ( Player  player)
virtual

Allows you to determine whether or not the item can be picked up

Parameters
playerThe player.

◆ CanRightClick()

virtual bool Terraria.ModLoader.ModItem.CanRightClick ( )
virtual

Returns whether or not this item does something when it is right-clicked in the inventory. Returns false by default.

Reimplemented in Terraria.ModLoader.Default.StartBag.

◆ CanShoot()

virtual bool Terraria.ModLoader.ModItem.CanShoot ( Player  player)
virtual

Allows you to prevent this item from shooting a projectile on use. Returns true by default.

Parameters
playerThe player using the item.
Returns

◆ CanStackInWorld()

virtual bool Terraria.ModLoader.ModItem.CanStackInWorld ( Item  item2)
virtual

Allows you to decide if this item is allowed to stack with another of its type in the world. This is only called when attempting to stack with an item of the same type.

Parameters
item2The item this is trying to stack with
Returns
Whether or not the item is allowed to stack

◆ CanUseItem()

virtual bool Terraria.ModLoader.ModItem.CanUseItem ( Player  player)
virtual

Returns whether or not this item can be used. By default returns true.

Parameters
playerThe player using the item.

◆ CaughtFishStack()

virtual void Terraria.ModLoader.ModItem.CaughtFishStack ( ref int  stack)
virtual

Allows you to determine how many of this item a player obtains when the player fishes this item.

Parameters
stackThe stack.

◆ ChoosePrefix()

virtual int Terraria.ModLoader.ModItem.ChoosePrefix ( UnifiedRandom  rand)
virtual

Allows you to manually choose what prefix an item will get.

Returns
The ID of the prefix to give the item, -1 to use default vanilla behavior

◆ Clone()

virtual ModItem Terraria.ModLoader.ModItem.Clone ( Item  item)
virtual

Create a copy of this ModItem. Called when an item is cloned.

Parameters
itemThe new item

Reimplemented in Terraria.ModLoader.Default.UnloadedItem.

◆ ConsumeItem()

virtual bool Terraria.ModLoader.ModItem.ConsumeItem ( Player  player)
virtual

If this item is consumable and this returns true, then this item will be consumed upon usage. Returns true by default. If false is returned, the OnConsumeItem hook is never called.

Parameters
playerThe player.
Returns

◆ DrawArmorColor()

virtual void Terraria.ModLoader.ModItem.DrawArmorColor ( Player  drawPlayer,
float  shadow,
ref Color  color,
ref int  glowMask,
ref Color  glowMaskColor 
)
virtual

Allows you to modify the colors in which this armor and surrounding accessories are drawn, in addition to which glow mask and in what color is drawn. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
drawPlayerThe draw player.
shadowThe shadow.
colorThe color.
glowMaskThe glow mask.
glowMaskColorColor of the glow mask.

◆ DrawBody()

virtual bool Terraria.ModLoader.ModItem.DrawBody ( )
virtual

Return false to hide the player's body when this body armor is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture.

Returns

◆ DrawHair()

virtual void Terraria.ModLoader.ModItem.DrawHair ( ref bool  drawHair,
ref bool  drawAltHair 
)
virtual

Allows you to determine whether the player's hair or alt (hat) hair draws when this head armor is worn. By default both flags will be false. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
drawHairif set to true [draw hair].
drawAltHairif set to true [draw alt hair].

◆ DrawHands()

virtual void Terraria.ModLoader.ModItem.DrawHands ( ref bool  drawHands,
ref bool  drawArms 
)
virtual

Allows you to determine whether the skin/shirt on the player's arms and hands are drawn when this body armor is worn. By default both flags will be false. Note that if drawHands is false, the arms will not be drawn either. Also note that this hook is only ever called through this item's associated equipment texture.

Parameters
drawHandsif set to true [draw hands].
drawArmsif set to true [draw arms].

◆ DrawHead()

virtual bool Terraria.ModLoader.ModItem.DrawHead ( )
virtual

Return false to hide the player's head when this head armor is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture.

Returns

◆ DrawLegs()

virtual bool Terraria.ModLoader.ModItem.DrawLegs ( )
virtual

Return false to hide the player's legs when this leg armor or shoe accessory is worn. Returns true by default. Note that this hook is only ever called through this item's associated equipment texture.

Returns

◆ EquipFrameEffects()

virtual void Terraria.ModLoader.ModItem.EquipFrameEffects ( Player  player,
EquipType  type 
)
virtual

Allows you to create special effects (such as dust) when this item's equipment texture of the given equipment type is displayed on the player. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
playerThe player.
typeThe type.

◆ ExtractinatorUse()

virtual void Terraria.ModLoader.ModItem.ExtractinatorUse ( ref int  resultType,
ref int  resultStack 
)
virtual

Allows you to modify what item, and in what quantity, is obtained when this item is fed into the Extractinator. By default the parameters will be set to the output of feeding Silt/Slush into the Extractinator.

Parameters
resultTypeType of the result.
resultStackThe result stack.

◆ GetAlpha()

virtual ? Color Terraria.ModLoader.ModItem.GetAlpha ( Color  lightColor)
virtual

Allows you to determine the color and transparency in which this item is drawn. Return null to use the default color (normally light color). Returns null by default.

Parameters
lightColorColor of the light.
Returns

◆ GetHealLife()

virtual void Terraria.ModLoader.ModItem.GetHealLife ( Player  player,
bool  quickHeal,
ref int  healValue 
)
virtual

Allows you to temporarily modify the amount of life a life healing item will heal for, based on player buffs, accessories, etc. This is only called for items with a healLife value.

Parameters
playerThe player using the item.
quickHealWhether the item is being used through quick heal or not.
healValueThe amount of life being healed.

◆ GetHealMana()

virtual void Terraria.ModLoader.ModItem.GetHealMana ( Player  player,
bool  quickHeal,
ref int  healValue 
)
virtual

Allows you to temporarily modify the amount of mana a mana healing item will heal for, based on player buffs, accessories, etc. This is only called for items with a healMana value.

Parameters
playerThe player using the item.
quickHealWhether the item is being used through quick heal or not.
healValueThe amount of mana being healed.

◆ GrabRange()

virtual void Terraria.ModLoader.ModItem.GrabRange ( Player  player,
ref int  grabRange 
)
virtual

Allows you to modify how close this item must be to the player in order to move towards the player.

Parameters
playerThe player.
grabRangeThe grab range.

◆ GrabStyle()

virtual bool Terraria.ModLoader.ModItem.GrabStyle ( Player  player)
virtual

Allows you to modify the way this item moves towards the player. Return true if you override this hook; returning false will allow the vanilla grab style to take place. Returns false by default.

Parameters
playerThe player.
Returns

◆ HoldItem()

virtual void Terraria.ModLoader.ModItem.HoldItem ( Player  player)
virtual

Allows you to make things happen when the player is holding this item (for example, torches make light and water candles increase spawn rate).

Parameters
playerThe player.

◆ HoldItemFrame()

virtual void Terraria.ModLoader.ModItem.HoldItemFrame ( Player  player)
virtual

Allows you to modify the player's animation when the player is holding this item.

Parameters
playerThe player.

◆ HoldoutOffset()

virtual ? Vector2 Terraria.ModLoader.ModItem.HoldoutOffset ( )
virtual

Allows you to determine the offset of this item's sprite when used by the player. This is only used for items with a useStyle of 5 that aren't staves. Return null to use the vanilla holdout offset; returns null by default.

Returns

◆ HoldoutOrigin()

virtual ? Vector2 Terraria.ModLoader.ModItem.HoldoutOrigin ( )
virtual

Allows you to determine the point on this item's sprite that the player holds onto when using this item. The origin is from the bottom left corner of the sprite. This is only used for staves with a useStyle of 5. Return null to use the vanilla holdout origin (zero); returns null by default.

Returns

◆ HoldStyle()

virtual void Terraria.ModLoader.ModItem.HoldStyle ( Player  player,
Rectangle  heldItemFrame 
)
virtual

Allows you to modify the location and rotation of this item when the player is holding it.

Parameters
playerThe player.
heldItemFrameThe source rectangle for the held item's texture.

◆ HorizontalWingSpeeds()

virtual void Terraria.ModLoader.ModItem.HorizontalWingSpeeds ( Player  player,
ref float  speed,
ref float  acceleration 
)
virtual

Allows you to modify these wing's horizontal flight speed and acceleration.

Parameters
playerThe player.
speedThe speed.
accelerationThe acceleration.

◆ IsAnglerQuestAvailable()

virtual bool Terraria.ModLoader.ModItem.IsAnglerQuestAvailable ( )
virtual

Whether or not specific conditions have been satisfied for the Angler to be able to request this item. (For example, Hardmode.) Returns true by default.

◆ IsArmorSet()

virtual bool Terraria.ModLoader.ModItem.IsArmorSet ( Item  head,
Item  body,
Item  legs 
)
virtual

Returns whether or not the head armor, body armor, and leg armor make up a set. If this returns true, then this item's UpdateArmorSet method will be called. Returns false by default.

Parameters
headThe head.
bodyThe body.
legsThe legs.

◆ IsQuestFish()

virtual bool Terraria.ModLoader.ModItem.IsQuestFish ( )
virtual

Whether or not the Angler can ever randomly request this type of item for his daily quest. Returns false by default.

◆ IsVanitySet()

virtual bool Terraria.ModLoader.ModItem.IsVanitySet ( int  head,
int  body,
int  legs 
)
virtual

Returns whether or not the head armor, body armor, and leg armor textures make up a set. This hook is used for the PreUpdateVanitySet, UpdateVanitySet, and ArmorSetShadow hooks. By default, this will return the same value as the IsArmorSet hook (passing the equipment textures' associated items as parameters), so you will not have to use this hook unless you want vanity effects to be entirely separate from armor sets. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
headThe head.
bodyThe body.
legsThe legs.

◆ ItemSpace()

virtual bool Terraria.ModLoader.ModItem.ItemSpace ( Player  player)
virtual

Return true to specify that the item can be picked up despite not having enough room in inventory. Useful for something like hearts or experience items. Use in conjunction with OnPickup to actually consume the item and handle it.

Parameters
playerThe player.
Returns

◆ Load()

virtual void Terraria.ModLoader.ModItem.Load ( TagCompound  tag)
virtual

Allows you to load custom data that you have saved for this item.

Parameters
tagThe tag.

Reimplemented in Terraria.ModLoader.Default.UnloadedItem, and Terraria.ModLoader.Default.StartBag.

◆ MeleeEffects()

virtual void Terraria.ModLoader.ModItem.MeleeEffects ( Player  player,
Rectangle  hitbox 
)
virtual

Allows you to give this melee weapon special effects, such as creating light or dust.

Parameters
playerThe player.
hitboxThe hitbox.

◆ ModifyHitNPC()

virtual void Terraria.ModLoader.ModItem.ModifyHitNPC ( Player  player,
NPC  target,
ref int  damage,
ref float  knockBack,
ref bool  crit 
)
virtual

Allows you to modify the damage, knockback, etc., that this melee weapon does to an NPC.

Parameters
playerThe player.
targetThe target.
damageThe damage.
knockBackThe knock back.
critif set to true [crit].

◆ ModifyHitPvp()

virtual void Terraria.ModLoader.ModItem.ModifyHitPvp ( Player  player,
Player  target,
ref int  damage,
ref bool  crit 
)
virtual

Allows you to modify the damage, etc., that this melee weapon does to a player.

Parameters
playerThe player.
targetThe target.
damageThe damage.
critif set to true [crit].

◆ ModifyManaCost()

virtual void Terraria.ModLoader.ModItem.ModifyManaCost ( Player  player,
ref float  reduce,
ref float  mult 
)
virtual

Allows you to temporarily modify the amount of mana this item will consume on use, based on player buffs, accessories, etc. This is only called for items with a mana value.

Parameters
playerThe player using the item.
reduceUsed for decreasingly stacking buffs (most common). Only ever use -= on this field.
multUse to directly multiply the item's effective mana cost. Good for debuffs, or things which should stack separately (eg meteor armor set bonus).

◆ ModifyResearchSorting()

virtual void Terraria.ModLoader.ModItem.ModifyResearchSorting ( ref ContentSamples.CreativeHelper.ItemGroup  itemGroup)
virtual

Allows you to set an item's sorting group in Journey Mode's duplication menu. This is useful for setting custom item types that group well together, or whenever the default vanilla sorting doesn't sort the way you want it.

Parameters
itemGroupThe item group this item is being assigned to

◆ ModifyShootStats()

virtual void Terraria.ModLoader.ModItem.ModifyShootStats ( Player  player,
ref Vector2  position,
ref Vector2  velocity,
ref int  type,
ref int  damage,
ref float  knockback 
)
virtual

Allows you to modify the position, velocity, type, damage and/or knockback of a projectile being shot by this item.

Parameters
playerThe player using the item.
positionThe center position of the projectile.
velocityThe velocity of the projectile.
typeThe ID of the projectile.
damageThe damage of the projectile.
knockbackThe knockback of the projectile.

◆ ModifyTooltips()

virtual void Terraria.ModLoader.ModItem.ModifyTooltips ( List< TooltipLine tooltips)
virtual

Allows you to modify all the tooltips that display for this item. See here for information about TooltipLine.

Parameters
tooltipsThe tooltips.

Reimplemented in Terraria.ModLoader.Default.UnloadedItem.

◆ ModifyWeaponCrit()

virtual void Terraria.ModLoader.ModItem.ModifyWeaponCrit ( Player  player,
ref int  crit 
)
virtual

Allows you to temporarily modify this weapon's crit chance based on player buffs, etc.

Parameters
playerThe player using this item
critThe critical strike chance, at 0 it will never trigger a crit and at 100 or above it will always trigger a crit

◆ ModifyWeaponDamage()

virtual void Terraria.ModLoader.ModItem.ModifyWeaponDamage ( Player  player,
ref StatModifier  damage,
ref float  flat 
)
virtual

Allows you to temporarily modify this weapon's damage based on player buffs, etc. This is useful for creating new classes of damage, or for making subclasses of damage (for example, Shroomite armor set boosts).

Parameters
playerThe player using the item
damageUse to directly multiply the player's effective damage.
flatThis is a flat damage bonus that will be added after add and mult are applied. It facilitates effects like "4 more damage from weapons"

◆ ModifyWeaponKnockback()

virtual void Terraria.ModLoader.ModItem.ModifyWeaponKnockback ( Player  player,
ref StatModifier  knockback,
ref float  flat 
)
virtual

Allows you to temporarily modify this weapon's knockback based on player buffs, etc. This allows you to customize knockback beyond the Player class's limited fields.

Parameters
playerThe player using the item
knockbackThe knockback

◆ NetReceive()

virtual void Terraria.ModLoader.ModItem.NetReceive ( BinaryReader  reader)
virtual

Receives the custom data sent in the NetSend hook.

Parameters
readerThe reader.

Reimplemented in Terraria.ModLoader.Default.UnloadedItem.

◆ NetSend()

virtual void Terraria.ModLoader.ModItem.NetSend ( BinaryWriter  writer)
virtual

Allows you to send custom data for this item between client and server.

Parameters
writerThe writer.

Reimplemented in Terraria.ModLoader.Default.UnloadedItem.

◆ OnConsumeAmmo()

virtual void Terraria.ModLoader.ModItem.OnConsumeAmmo ( Player  player)
virtual

Allows you to make things happen when ammo is consumed. Called by the weapon.
Called before the ammo stack is reduced.

Parameters
playerThe player using the weapon

◆ OnConsumedAsAmmo()

virtual void Terraria.ModLoader.ModItem.OnConsumedAsAmmo ( Player  player)
virtual

Allows you to make things happen when ammo is consumed. Called by the ammo.
Called before the ammo stack is reduced.

Parameters
playerThe player consuming the ammo

◆ OnConsumeItem()

virtual void Terraria.ModLoader.ModItem.OnConsumeItem ( Player  player)
virtual

Allows you to make things happen when this item is consumed. Called before the item stack is reduced.

Parameters
playerThe player.

◆ OnConsumeMana()

virtual void Terraria.ModLoader.ModItem.OnConsumeMana ( Player  player,
int  manaConsumed 
)
virtual

Allows you to make stuff happen when a player consumes mana on use of this item.

Parameters
playerThe player using the item.
manaConsumedThe mana consumed from the player.

◆ OnCraft()

virtual void Terraria.ModLoader.ModItem.OnCraft ( Recipe  recipe)
virtual

Allows you to make anything happen when the player crafts this item using the given recipe.

Parameters
recipeThe recipe that was used to craft this item.

◆ OnHitNPC()

virtual void Terraria.ModLoader.ModItem.OnHitNPC ( Player  player,
NPC  target,
int  damage,
float  knockBack,
bool  crit 
)
virtual

Allows you to create special effects when this melee weapon hits an NPC (for example how the Pumpkin Sword creates pumpkin heads).

Parameters
playerThe player.
targetThe target.
damageThe damage.
knockBackThe knock back.
critif set to true [crit].

◆ OnHitPvp()

virtual void Terraria.ModLoader.ModItem.OnHitPvp ( Player  player,
Player  target,
int  damage,
bool  crit 
)
virtual

Allows you to create special effects when this melee weapon hits a player.

Parameters
playerThe player.
targetThe target.
damageThe damage.
critif set to true [crit].

◆ OnMissingMana()

virtual void Terraria.ModLoader.ModItem.OnMissingMana ( Player  player,
int  neededMana 
)
virtual

Allows you to make stuff happen when a player doesn't have enough mana for the item they are trying to use. If the player has high enough mana after this hook runs, mana consumption will happen normally. Only runs once per item use.

Parameters
playerThe player using the item.
neededManaThe mana needed to use the item.

◆ OnPickup()

virtual bool Terraria.ModLoader.ModItem.OnPickup ( Player  player)
virtual

Allows you to make special things happen when the player picks up this item. Return false to stop the item from being added to the player's inventory; returns true by default.

Parameters
playerThe player.
Returns

◆ OpenBossBag()

virtual void Terraria.ModLoader.ModItem.OpenBossBag ( Player  player)
virtual

Allows you to give items to the given player when this item is right-clicked in the inventory if the bossBagNPC field has been set to a positive number. This ignores the CanRightClick and RightClick hooks.

Parameters
playerThe player.

◆ PickAmmo()

virtual void Terraria.ModLoader.ModItem.PickAmmo ( Item  weapon,
Player  player,
ref int  type,
ref float  speed,
ref int  damage,
ref float  knockback 
)
virtual

Allows you to modify the projectile created by a weapon based on the ammo it is using. This hook is called on the ammo.

Parameters
weaponThe item that is using this ammo
playerThe player using the item
typeThe ID of the projectile shot
speedThe speed of the projectile shot
damageThe damage of the projectile shot
knockbackThe speed of the projectile shot

◆ PostDrawInInventory()

virtual void Terraria.ModLoader.ModItem.PostDrawInInventory ( SpriteBatch  spriteBatch,
Vector2  position,
Rectangle  frame,
Color  drawColor,
Color  itemColor,
Vector2  origin,
float  scale 
)
virtual

Allows you to draw things in front of this item in the inventory. This method is called even if PreDrawInInventory returns false.

Parameters
spriteBatchThe sprite batch.
positionThe position.
frameThe frame.
drawColorColor of the draw.
itemColorColor of the item.
originThe origin.
scaleThe scale.

◆ PostDrawInWorld()

virtual void Terraria.ModLoader.ModItem.PostDrawInWorld ( SpriteBatch  spriteBatch,
Color  lightColor,
Color  alphaColor,
float  rotation,
float  scale,
int  whoAmI 
)
virtual

Allows you to draw things in front of this item. This method is called even if PreDrawInWorld returns false.

Parameters
spriteBatchThe sprite batch.
lightColorColor of the light.
alphaColorColor of the alpha.
rotationThe rotation.
scaleThe scale.
whoAmIThe who am i.

◆ PostDrawTooltip()

virtual void Terraria.ModLoader.ModItem.PostDrawTooltip ( ReadOnlyCollection< DrawableTooltipLine lines)
virtual

Allows you to do things after this item's tooltip is drawn. The lines contain draw information as this is ran after drawing the tooltip.

Parameters
linesThe tooltip lines for this item

◆ PostDrawTooltipLine()

virtual void Terraria.ModLoader.ModItem.PostDrawTooltipLine ( DrawableTooltipLine  line)
virtual

Allows you to do things after a tooltip line of this item is drawn. The line contains draw info.

Parameters
lineThe line that was drawn

◆ PostReforge()

virtual void Terraria.ModLoader.ModItem.PostReforge ( )
virtual

This hook gets called immediately after an item gets reforged by the Goblin Tinkerer. Useful for modifying modded data based on the reforge result.

◆ PostUpdate()

virtual void Terraria.ModLoader.ModItem.PostUpdate ( )
virtual

Allows you to make things happen when this item is lying in the world. This will always be called, even when it is being grabbed by a player. This hook should be used for adding light, or for increasing the age of less valuable items.

◆ PreDrawInInventory()

virtual bool Terraria.ModLoader.ModItem.PreDrawInInventory ( SpriteBatch  spriteBatch,
Vector2  position,
Rectangle  frame,
Color  drawColor,
Color  itemColor,
Vector2  origin,
float  scale 
)
virtual

Allows you to draw things behind this item in the inventory. Return false to stop the game from drawing the item (useful if you're manually drawing the item). Returns true by default.

Parameters
spriteBatchThe sprite batch.
positionThe position.
frameThe frame.
drawColorColor of the draw.
itemColorColor of the item.
originThe origin.
scaleThe scale.
Returns

◆ PreDrawInWorld()

virtual bool Terraria.ModLoader.ModItem.PreDrawInWorld ( SpriteBatch  spriteBatch,
Color  lightColor,
Color  alphaColor,
ref float  rotation,
ref float  scale,
int  whoAmI 
)
virtual

Allows you to draw things behind this item, or to modify the way this item is drawn in the world. Return false to stop the game from drawing the item (useful if you're manually drawing the item). Returns true by default.

Parameters
spriteBatchThe sprite batch.
lightColorColor of the light.
alphaColorColor of the alpha.
rotationThe rotation.
scaleThe scale.
whoAmIThe who am i.
Returns

◆ PreDrawTooltip()

virtual bool Terraria.ModLoader.ModItem.PreDrawTooltip ( ReadOnlyCollection< TooltipLine lines,
ref int  x,
ref int  y 
)
virtual

Allows you to do things before this item's tooltip is drawn.

Parameters
linesThe tooltip lines for this item
xThe top X position for this tooltip. It is where the first line starts drawing
yThe top Y position for this tooltip. It is where the first line starts drawing
Returns
Whether or not to draw this tooltip

◆ PreDrawTooltipLine()

virtual bool Terraria.ModLoader.ModItem.PreDrawTooltipLine ( DrawableTooltipLine  line,
ref int  yOffset 
)
virtual

Allows you to do things before a tooltip line of this item is drawn. The line contains draw info.

Parameters
lineThe line that would be drawn
yOffsetThe Y offset added for next tooltip lines
Returns
Whether or not to draw this tooltip line

◆ PrefixChance()

virtual ? bool Terraria.ModLoader.ModItem.PrefixChance ( int  pre,
UnifiedRandom  rand 
)
virtual

To prevent putting the item in the tinkerer slot, return false when pre is -3. To prevent rolling of a prefix on spawn, return false when pre is -1. To force rolling of a prefix on spawn, return true when pre is -1.

To reduce the probability of a prefix on spawn (pre == -1) to X%, return false 100-4X % of the time. To increase the probability of a prefix on spawn (pre == -1) to X%, return true (4X-100)/3 % of the time.

To delete a prefix from an item when the item is loaded, return false when pre is the prefix you want to delete. Use AllowPrefix to prevent rolling of a certain prefix.

Parameters
preThe prefix being applied to the item, or the roll mode. -1 is when the item is naturally generated in a chest, crafted, purchased from an NPC, looted from a grab bag (excluding presents), or dropped by a slain enemy (if it's spawned with prefixGiven: -1). -2 is when the item is rolled in the tinkerer. -3 determines if the item can be placed in the tinkerer slot.
Returns

◆ PreReforge()

virtual bool Terraria.ModLoader.ModItem.PreReforge ( )
virtual

This hook gets called when the player clicks on the reforge button and can afford the reforge. Returns whether the reforge will take place. If false is returned, the PostReforge hook is never called. Reforging preserves modded data on the item.

◆ PreUpdateVanitySet()

virtual void Terraria.ModLoader.ModItem.PreUpdateVanitySet ( Player  player)
virtual

Allows you to create special effects (such as the necro armor's hurt noise) when the player wears this item's vanity set. This hook is called regardless of whether the player is frozen in any way. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
playerThe player.

◆ ReforgePrice()

virtual bool Terraria.ModLoader.ModItem.ReforgePrice ( ref int  reforgePrice,
ref bool  canApplyDiscount 
)
virtual

Returns if the normal reforge pricing is applied. If true or false is returned and the price is altered, the price will equal the altered price. The passed reforge price equals the item.value. Vanilla pricing will apply 20% discount if applicable and then price the reforge at a third of that value.

◆ Register()

sealed override void Terraria.ModLoader.ModItem.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ RightClick()

virtual void Terraria.ModLoader.ModItem.RightClick ( Player  player)
virtual

Allows you to make things happen when this item is right-clicked in the inventory. Useful for goodie bags.

Parameters
playerThe player.

Reimplemented in Terraria.ModLoader.Default.StartBag.

◆ Save()

virtual TagCompound Terraria.ModLoader.ModItem.Save ( )
virtual

Allows you to save custom data for this item. Returns null by default.

Returns

Reimplemented in Terraria.ModLoader.Default.UnloadedItem, and Terraria.ModLoader.Default.StartBag.

◆ SetDefaults()

virtual void Terraria.ModLoader.ModItem.SetDefaults ( )
virtual

This is where you set all your item's properties, such as width, damage, shootSpeed, defense, etc. For those that are familiar with tAPI, this has the same function as .json files.

Reimplemented in Terraria.ModLoader.Default.UnloadedItem, Terraria.ModLoader.Default.StartBag, and Terraria.ModLoader.Default.AprilFools.

◆ SetMatch()

virtual void Terraria.ModLoader.ModItem.SetMatch ( bool  male,
ref int  equipSlot,
ref bool  robes 
)
virtual

Allows you to modify the equipment that the player appears to be wearing. This hook will only be called for body armor and leg armor. Note that equipSlot is not the same as the item type of the armor the player will appear to be wearing. Worn equipment has a separate set of IDs. You can find the vanilla equipment IDs by looking at the headSlot, bodySlot, and legSlot fields for items, and modded equipment IDs by looking at EquipLoader. If this hook is called on body armor, equipSlot allows you to modify the leg armor the player appears to be wearing. If you modify it, make sure to set robes to true. If this hook is called on leg armor, equipSlot allows you to modify the leg armor the player appears to be wearing, and the robes parameter is useless. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
maleif set to true [male].
equipSlotThe equip slot.
robesif set to true [robes].

◆ SetupContent()

sealed override void Terraria.ModLoader.ModItem.SetupContent ( )
virtual

If you make a new ModType, seal this override, and call SetStaticDefaults in it.

Reimplemented from Terraria.ModLoader.ModType.

◆ Shoot()

virtual bool Terraria.ModLoader.ModItem.Shoot ( Player  player,
ProjectileSource_Item_WithAmmo  source,
Vector2  position,
Vector2  velocity,
int  type,
int  damage,
float  knockback 
)
virtual

Allows you to modify this item's shooting mechanism. Return false to prevent vanilla's shooting code from running. Returns true by default.

Parameters
playerThe player using the item.
sourceThe projectile source's information.
positionThe center position of the projectile.
velocityThe velocity of the projectile.
typeThe ID of the projectile.
damageThe damage of the projectile.
knockbackThe knockback of the projectile.
Returns

◆ Update()

virtual void Terraria.ModLoader.ModItem.Update ( ref float  gravity,
ref float  maxFallSpeed 
)
virtual

Allows you to customize this item's movement when lying in the world. Note that this will not be called if this item is currently being grabbed by a player.

Parameters
gravityThe gravity.
maxFallSpeedThe maximum fall speed.

◆ UpdateAccessory()

virtual void Terraria.ModLoader.ModItem.UpdateAccessory ( Player  player,
bool  hideVisual 
)
virtual

Allows you to give effects to this accessory. The hideVisual parameter is whether the player has marked the accessory slot to be hidden from being drawn on the player.

Parameters
playerThe player.
hideVisualif set to true the accessory is hidden.

◆ UpdateArmorSet()

virtual void Terraria.ModLoader.ModItem.UpdateArmorSet ( Player  player)
virtual

Allows you to give set bonuses to the armor set that this armor is in. Set player.setBonus to a string for the bonus description.

Parameters
playerThe player.

◆ UpdateEquip()

virtual void Terraria.ModLoader.ModItem.UpdateEquip ( Player  player)
virtual

Allows you to give effects to this armor or accessory, such as increased damage.

Parameters
playerThe player.

◆ UpdateInventory()

virtual void Terraria.ModLoader.ModItem.UpdateInventory ( Player  player)
virtual

Allows you to make things happen when this item is in the player's inventory (for example, how the cell phone makes information display).

Parameters
playerThe player.

◆ UpdateVanity()

virtual void Terraria.ModLoader.ModItem.UpdateVanity ( Player  player)
virtual

Allows you to give effects to this accessory when equipped in a vanity slot. Vanilla uses this for boot effects, wings and merman/werewolf visual flags

Parameters
playerThe player.

◆ UpdateVanitySet()

virtual void Terraria.ModLoader.ModItem.UpdateVanitySet ( Player  player)
virtual

Allows you to create special effects (such as dust) when the player wears this item's vanity set. This hook will only be called if the player is not frozen in any way. Note that this hook is only ever called through this item's associated equipment texture.

Parameters
playerThe player.

◆ UseAnimation()

virtual void Terraria.ModLoader.ModItem.UseAnimation ( Player  player)
virtual

Allows you to make things happen when this item's use animation starts. Runs on all clients and server. Use

if (player.whoAmI == Main.myPlayer) and if (Main.netMode == NetmodeID.??) if appropriate.

Parameters
playerThe player.

◆ UseAnimationMultiplier()

virtual float Terraria.ModLoader.ModItem.UseAnimationMultiplier ( Player  player)
virtual

Allows you to change the effective useAnimation of an item.
Note that this hook may cause items' actions to run less or more times than they should per a single use.

Returns
The multiplier on the animation time. 1f by default. Values greater than 1 increase the item animation's length.

◆ UseItem()

virtual ? bool Terraria.ModLoader.ModItem.UseItem ( Player  player)
virtual

Allows you to make things happen when this item is used. The return value controls whether or not ApplyItemTime will be called for the player.
Return true if the item actually did something, to force itemTime.
Return false to keep itemTime at 0.
Return null for vanilla behavior. Runs on all clients and server. Use

if (player.whoAmI == Main.myPlayer) and if (Main.netMode == NetmodeID.??) if appropriate.

Parameters
playerThe player.
Returns

Reimplemented in Terraria.ModLoader.Default.AprilFools.

◆ UseItemFrame()

virtual void Terraria.ModLoader.ModItem.UseItemFrame ( Player  player)
virtual

Allows you to modify the player's animation when this item is being used.

Parameters
playerThe player.

◆ UseItemHitbox()

virtual void Terraria.ModLoader.ModItem.UseItemHitbox ( Player  player,
ref Rectangle  hitbox,
ref bool  noHitbox 
)
virtual

Changes the hitbox of this melee weapon when it is used.

Parameters
playerThe player.
hitboxThe hitbox.
noHitboxif set to true [no hitbox].

◆ UseSpeedMultiplier()

virtual float Terraria.ModLoader.ModItem.UseSpeedMultiplier ( Player  player)
virtual

Allows you to safely change both useTime and useAnimation while keeping the values relative to each other.
Useful for status effects.

Returns
The multiplier on the use speed. 1f by default. Values greater than 1 increase the overall item speed.

◆ UseStyle()

virtual void Terraria.ModLoader.ModItem.UseStyle ( Player  player,
Rectangle  heldItemFrame 
)
virtual

Allows you to modify the location and rotation of this item in its use animation.

Parameters
playerThe player.
heldItemFrameThe source rectangle for the held item's texture.

◆ UseTimeMultiplier()

virtual float Terraria.ModLoader.ModItem.UseTimeMultiplier ( Player  player)
virtual

Allows you to change the effective useTime of an item.
Note that this hook may cause items' actions to run less or more times than they should per a single use.

Returns
The multiplier on the usage time. 1f by default. Values greater than 1 increase the item use's length.

◆ VerticalWingSpeeds()

virtual void Terraria.ModLoader.ModItem.VerticalWingSpeeds ( Player  player,
ref float  ascentWhenFalling,
ref float  ascentWhenRising,
ref float  maxCanAscendMultiplier,
ref float  maxAscentMultiplier,
ref float  constantAscend 
)
virtual

Allows you to modify the speeds at which you rise and fall when these wings are equipped.

Parameters
playerThe player.
ascentWhenFallingThe ascent when falling.
ascentWhenRisingThe ascent when rising.
maxCanAscendMultiplierThe maximum can ascend multiplier.
maxAscentMultiplierThe maximum ascent multiplier.
constantAscendThe constant ascend.

◆ WingUpdate()

virtual bool Terraria.ModLoader.ModItem.WingUpdate ( Player  player,
bool  inUse 
)
virtual

Allows for Wings to do various things while in use. "inUse" is whether or not the jump button is currently pressed. Called when these wings visually appear on the player. Use to animate wings, create dusts, invoke sounds, and create lights. Note that this hook is only ever called through this item's associated equipment texture. False will keep everything the same. True, you need to handle all animations in your own code.

Parameters
playerThe player.
inUseif set to true [in use].
Returns

Property Documentation

◆ BossBagNPC

virtual int Terraria.ModLoader.ModItem.BossBagNPC
get

The type of NPC that drops this boss bag. Used to determine how many coins this boss bag contains. Defaults to 0, which means this isn't a boss bag.

◆ DisplayName

ModTranslation Terraria.ModLoader.ModItem.DisplayName
getset

The translations for the display name of this item.

◆ Item

Item Terraria.ModLoader.ModItem.Item
getset

The item object that this ModItem controls.

◆ OnlyShootOnSwing

virtual bool Terraria.ModLoader.ModItem.OnlyShootOnSwing
get

Setting this to true makes it so that this weapon can shoot projectiles only at the beginning of its animation. Set this to true if you want a sword and its projectile creation to be in sync (for example, the Terra Blade). Defaults to false.

◆ Tooltip

ModTranslation Terraria.ModLoader.ModItem.Tooltip
getset

The translations for the display name of this tooltip.

◆ Type

int Terraria.ModLoader.ModItem.Type
get

Shorthand for item.type;