Terraria ModLoader  0.10.1.5
A framework for 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...

+ Collaboration diagram for Terraria.ModLoader.ModItem:

Public Member Functions

 ModItem ()
 
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 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 hotkey. More...
 
virtual bool Autoload (ref string name)
 Allows you to automatically load an item instead of using Mod.AddItem. Return true to allow autoloading; by default returns the mod's autoload property. Use this method to force or stop an autoload or change the internal name. 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 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 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 ()
 Returns a clone of this ModItem. Allows you to decide which fields of your ModItem class are copied over when an item stack is split or something similar happens. By default this will return a memberwise clone; you will want to override this if your GlobalItem contains object references. Only called if CloneNewInstances is set to true. Since several ModItem class fields are also set by the default implementation of this method, you'll most likely want to call base.Clone() as the first statement of your override. More...
 
virtual ModItem Clone (Item item)
 Create a copy of this instanced GlobalItem. Called when an item is cloned. Defaults to NewInstance(item) More...
 
virtual bool ConsumeAmmo (Player player)
 Whether or not ammo will be consumed upon usage. Called both by the gun and by the ammo; if at least one returns false then the ammo will not be used. By default returns true. If false is returned, the OnConsumeAmmo hook is never called. 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...
 
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 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 GetWeaponCrit (Player player, ref int crit)
 Allows you to temporarily modify this weapon's crit chance based on player buffs, etc. Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. If you use a custom damage class, the crit value will equal item.crit Vanilla checks classes in this order: melee, ranged, magic, thrown, and summon cannot crit. So if you set both melee class and another class to true, only the melee crit will actually be used. More...
 
virtual void GetWeaponDamage (Player player, ref int damage)
 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). Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. Vanilla checks classes in this order: melee, ranged, magic, thrown, summon So if you set both melee class and another class to true, only the melee damage will actually be used. More...
 
virtual void GetWeaponKnockback (Player player, ref float knockback)
 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. Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. Vanilla checks classes in this order: melee, ranged, magic, thrown, summon So if you set both melee class and another class to true, only the melee knockback will actually be used. 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 bool HoldItemFrame (Player player)
 Allows you to modify the player's animation when the player is holding this item. Return true if you modify the player's animation. Returns false by default. 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)
 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 LoadLegacy (BinaryReader reader)
 Allows you to load pre-v0.9 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 float MeleeSpeedMultiplier (Player player)
 Allows you to change the effective useAnimation of this item. 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 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 NetRecieve (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 ModItem NewInstance (Item itemClone)
 Create a new instance of this GlobalItem for an Item instance. Called at the end of Item.SetDefaults. If CloneNewInstances is true, just calls Clone() Otherwise calls the default constructor and copies fields More...
 
virtual bool NewPreReforge ()
 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. </summary More...
 
virtual void OnConsumeAmmo (Player player)
 Allows you to makes things happen when ammo is consumed. Called both by the gun and 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 OnCraft (Recipe recipe)
 Allows you to make anything happen when the player crafts this item using the given recipe. More...
 
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 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 (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 void PreReforge ()
 
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...
 
virtual void SetStaticDefaults ()
 This is where you set all your item's static properties, such as names/translations and the arrays in ItemID.Sets. This is called after SetDefaults on the initial ModItem More...
 
virtual bool Shoot (Player player, ref Vector2 position, ref float speedX, ref float speedY, ref int type, ref int damage, ref float knockBack)
 This is called before the weapon creates a projectile. You can use it to create special effects, such as changing the speed, changing the initial position, and/or firing multiple projectiles. Return false to stop the game from shooting the default projectile (do this if you manually spawn your own projectile). 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, 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 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 bool UseItem (Player player)
 Allows you to make things happen when this item is used. Return true if using this item actually does stuff. Returns false by default. Runs on all clients and server. Use More...
 
virtual bool UseItemFrame (Player player)
 Allows you to modify the player's animation when this item is being used. Return true if you modify the player's animation. Returns false by default. 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 void UseStyle (Player player)
 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 this item. 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 Attributes

int bossBagNPC
 
virtual int BossBagNPC => BossBagNPC_Obsolete
 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...
 
virtual bool CloneNewInstances => false
 Whether instances of this GlobalItem are created through Clone or constructor (by default implementations of NewInstance and Clone(Item, Item)). Defaults to false (using default constructor). More...
 
virtual bool OnlyShootOnSwing => ProjOnSwing_Obsolete
 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...
 
bool projOnSwing
 
virtual string Texture => (GetType().Namespace + "." + Name).Replace('.', '/')
 The file name of this item's texture file in the mod loader's file space. More...
 

Properties

int BossBagNPC_Obsolete [get, set]
 
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...
 
Mod mod [get, set]
 Gets the mod. More...
 
string Name [get, set]
 The internal name of this ModItem. More...
 
bool ProjOnSwing_Obsolete [get, set]
 
ModTranslation Tooltip [get, set]
 The translations for the display name of this tooltip. 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.

Definition at line 16 of file ModItem.cs.

Constructor & Destructor Documentation

Terraria.ModLoader.ModItem.ModItem ( )

Definition at line 89 of file ModItem.cs.

References Terraria.ModLoader.Item.

89  {
90  item = new Item { modItem = this };
91  }
Item item
The item object that this ModItem controls.
Definition: ModItem.cs:26

Member Function Documentation

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.

Definition at line 967 of file ModItem.cs.

967  {
968  }
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

Definition at line 474 of file ModItem.cs.

474  {
475  return false;
476  }
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.

Definition at line 915 of file ModItem.cs.

915  {
916  }
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.

Definition at line 690 of file ModItem.cs.

690  {
691  }
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.

Definition at line 566 of file ModItem.cs.

566  {
567  }
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.

Definition at line 161 of file ModItem.cs.

161  {
162  EquipLoader.SetSlot(item);
163  }
Item item
The item object that this ModItem controls.
Definition: ModItem.cs:26
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 hotkey.

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

Definition at line 886 of file ModItem.cs.

886  {
887  }
virtual bool Terraria.ModLoader.ModItem.Autoload ( ref string  name)
virtual

Allows you to automatically load an item instead of using Mod.AddItem. Return true to allow autoloading; by default returns the mod's autoload property. Use this method to force or stop an autoload or change the internal name.

Parameters
nameThe name, initialized to the name of this type.

Definition at line 99 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AutoloadItem().

99  {
100  return mod.Properties.Autoload;
101  }
Mod mod
Gets the mod.
Definition: ModItem.cs:37
ModProperties Properties
Definition: Mod.cs:49
bool Autoload
Whether or not this mod will autoload content by default. Autoloading content means you do not need t...

+ Here is the caller graph for this function:

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.

Definition at line 175 of file ModItem.cs.

References Terraria.ModLoader.ModContent.GetTexture(), and Terraria.ModLoader.ModContent.TextureExists().

Referenced by Terraria.ModLoader.Mod.LoadEffect().

175  {
176  Main.itemTexture[item.type] = ModContent.GetTexture(Texture);
177 
178  var flameTexture = Texture + "_Flame";
179  if (ModContent.TextureExists(flameTexture)) {
180  Main.itemFlameTexture[item.type] = ModContent.GetTexture(flameTexture);
181  Main.itemFlameLoaded[item.type] = true;
182  }
183 
184  if (DisplayName.IsDefault())
185  DisplayName.SetDefault(Regex.Replace(Name, "([A-Z])", " $1").Trim());
186  }
Item item
The item object that this ModItem controls.
Definition: ModItem.cs:26
ModTranslation DisplayName
The translations for the display name of this item.
Definition: ModItem.cs:53
virtual string Texture
The file name of this item&#39;s texture file in the mod loader&#39;s file space.
Definition: ModItem.cs:69
string Name
The internal name of this ModItem.
Definition: ModItem.cs:45

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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.

Definition at line 868 of file ModItem.cs.

868  {
869  return true;
870  }
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

Definition at line 365 of file ModItem.cs.

365  {
366  return null;
367  }
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.

Definition at line 399 of file ModItem.cs.

399  {
400  return true;
401  }
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.

Definition at line 760 of file ModItem.cs.

760  {
761  return true;
762  }
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.

Definition at line 583 of file ModItem.cs.

583  {
584  return false;
585  }
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.

Definition at line 200 of file ModItem.cs.

200  {
201  return true;
202  }
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.

Definition at line 893 of file ModItem.cs.

893  {
894  }
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

Definition at line 192 of file ModItem.cs.

192  {
193  return -1;
194  }
virtual ModItem Terraria.ModLoader.ModItem.Clone ( )
virtual

Returns a clone of this ModItem. Allows you to decide which fields of your ModItem class are copied over when an item stack is split or something similar happens. By default this will return a memberwise clone; you will want to override this if your GlobalItem contains object references. Only called if CloneNewInstances is set to true. Since several ModItem class fields are also set by the default implementation of this method, you'll most likely want to call base.Clone() as the first statement of your override.

var clone = (ExampleHookItem)base.Clone();
clone.targets = (int[])this.targets.Clone(); // Or whatever deep copy operations are relevant.
return clone;
virtual ModItem Terraria.ModLoader.ModItem.Clone ( Item  item)
virtual

Create a copy of this instanced GlobalItem. Called when an item is cloned. Defaults to NewInstance(item)

Parameters
itemThe item being cloned
itemCloneThe new item
virtual bool Terraria.ModLoader.ModItem.ConsumeAmmo ( Player  player)
virtual

Whether or not ammo will be consumed upon usage. Called both by the gun and by the ammo; if at least one returns false then the ammo will not be used. By default returns true. If false is returned, the OnConsumeAmmo hook is never called.

Parameters
playerThe player.
Returns

Definition at line 315 of file ModItem.cs.

315  {
316  return true;
317  }
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

Definition at line 439 of file ModItem.cs.

439  {
440  return true;
441  }
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.

Definition at line 680 of file ModItem.cs.

680  {
681  }
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

Definition at line 660 of file ModItem.cs.

660  {
661  return true;
662  }
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].

Definition at line 645 of file ModItem.cs.

645  {
646  }
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].

Definition at line 637 of file ModItem.cs.

637  {
638  }
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

Definition at line 652 of file ModItem.cs.

652  {
653  return true;
654  }
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

Definition at line 668 of file ModItem.cs.

668  {
669  return true;
670  }
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.

Definition at line 877 of file ModItem.cs.

877  {
878  }
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

Definition at line 787 of file ModItem.cs.

787  {
788  return null;
789  }
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.

Definition at line 249 of file ModItem.cs.

249  {
250  }
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.

Definition at line 258 of file ModItem.cs.

258  {
259  }
virtual void Terraria.ModLoader.ModItem.GetWeaponCrit ( Player  player,
ref int  crit 
)
virtual

Allows you to temporarily modify this weapon's crit chance based on player buffs, etc. Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. If you use a custom damage class, the crit value will equal item.crit Vanilla checks classes in this order: melee, ranged, magic, thrown, and summon cannot crit. So if you set both melee class and another class to true, only the melee crit will actually be used.

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

Definition at line 295 of file ModItem.cs.

295  {
296  }
virtual void Terraria.ModLoader.ModItem.GetWeaponDamage ( Player  player,
ref int  damage 
)
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). Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. Vanilla checks classes in this order: melee, ranged, magic, thrown, summon So if you set both melee class and another class to true, only the melee damage will actually be used.

Parameters
playerThe player using the item
damageThe damage.

Definition at line 270 of file ModItem.cs.

270  {
271  }
virtual void Terraria.ModLoader.ModItem.GetWeaponKnockback ( Player  player,
ref float  knockback 
)
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. Note that tModLoader follows vanilla principle of only allowing one effective damage class at a time. This means that if you want your own custom damage class, all vanilla damage classes must be set to false. Vanilla checks classes in this order: melee, ranged, magic, thrown, summon So if you set both melee class and another class to true, only the melee knockback will actually be used.

Parameters
playerThe player using the item
knockbackThe knockback

Definition at line 282 of file ModItem.cs.

282  {
283  }
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.

Definition at line 744 of file ModItem.cs.

744  {
745  }
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

Definition at line 752 of file ModItem.cs.

752  {
753  return false;
754  }
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.

Definition at line 222 of file ModItem.cs.

222  {
223  }
virtual bool Terraria.ModLoader.ModItem.HoldItemFrame ( Player  player)
virtual

Allows you to modify the player's animation when the player is holding this item. Return true if you modify the player's animation. Returns false by default.

Parameters
playerThe player.
Returns

Definition at line 465 of file ModItem.cs.

465  {
466  return false;
467  }
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

Definition at line 851 of file ModItem.cs.

Referenced by Terraria.ModLoader.ItemLoader.HoldoutOffset().

851  {
852  return null;
853  }

+ Here is the caller graph for this function:

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

Definition at line 859 of file ModItem.cs.

859  {
860  return null;
861  }
virtual void Terraria.ModLoader.ModItem.HoldStyle ( Player  player)
virtual

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

Parameters
playerThe player.

Definition at line 215 of file ModItem.cs.

215  {
216  }
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.

Definition at line 712 of file ModItem.cs.

712  {
713  }
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.

Definition at line 906 of file ModItem.cs.

Referenced by Terraria.ModLoader.ItemLoader.IsAnglerQuestAvailable().

906  {
907  return true;
908  }

+ Here is the caller graph for this function:

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.

Definition at line 514 of file ModItem.cs.

514  {
515  return false;
516  }
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.

Definition at line 899 of file ModItem.cs.

899  {
900  return false;
901  }
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.

Definition at line 531 of file ModItem.cs.

References Terraria.ModLoader.Item.

531  {
532  Item headItem = new Item();
533  if (head >= 0) {
534  headItem.SetDefaults(Item.headType[head], true);
535  }
536  Item bodyItem = new Item();
537  if (body >= 0) {
538  bodyItem.SetDefaults(Item.bodyType[body], true);
539  }
540  Item legItem = new Item();
541  if (legs >= 0) {
542  legItem.SetDefaults(Item.legType[legs], true);
543  }
544  return IsArmorSet(headItem, bodyItem, legItem);
545  }
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...
Definition: ModItem.cs:514
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

Definition at line 778 of file ModItem.cs.

778  {
779  return false;
780  }
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.

Definition at line 940 of file ModItem.cs.

940  {
941  }
virtual void Terraria.ModLoader.ModItem.LoadLegacy ( BinaryReader  reader)
virtual

Allows you to load pre-v0.9 custom data that you have saved for this item.

Parameters
readerThe reader.

Definition at line 947 of file ModItem.cs.

947  {
948  }
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.

Definition at line 356 of file ModItem.cs.

356  {
357  }
virtual float Terraria.ModLoader.ModItem.MeleeSpeedMultiplier ( Player  player)
virtual

Allows you to change the effective useAnimation of this item.

Parameters
player
Returns
The multiplier on the animation speed. 1f by default.

Definition at line 239 of file ModItem.cs.

239  {
240  return 1f;
241  }
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].

Definition at line 377 of file ModItem.cs.

377  {
378  }
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].

Definition at line 410 of file ModItem.cs.

410  {
411  }
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.

Definition at line 1016 of file ModItem.cs.

1016  {
1017  }
virtual void Terraria.ModLoader.ModItem.NetRecieve ( BinaryReader  reader)
virtual

Receives the custom data sent in the NetSend hook.

Parameters
readerThe reader.

Definition at line 961 of file ModItem.cs.

961  {
962  }
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.

Definition at line 954 of file ModItem.cs.

954  {
955  }
virtual ModItem Terraria.ModLoader.ModItem.NewInstance ( Item  itemClone)
virtual

Create a new instance of this GlobalItem for an Item instance. Called at the end of Item.SetDefaults. If CloneNewInstances is true, just calls Clone() Otherwise calls the default constructor and copies fields

Definition at line 135 of file ModItem.cs.

135  {
136  if (CloneNewInstances) {
137  var clone = Clone();
138  clone.item = itemClone;
139  return clone;
140  }
141 
142  var copy = (ModItem)Activator.CreateInstance(GetType());
143  copy.item = itemClone;
144  copy.mod = mod;
145  copy.Name = Name;
146  copy.ProjOnSwing_Obsolete = ProjOnSwing_Obsolete;
147  copy.BossBagNPC_Obsolete = BossBagNPC_Obsolete;
148  return copy;
149  }
virtual ModItem Clone()
Returns a clone of this ModItem. Allows you to decide which fields of your ModItem class are copied o...
Mod mod
Gets the mod.
Definition: ModItem.cs:37
virtual bool CloneNewInstances
Whether instances of this GlobalItem are created through Clone or constructor (by default implementat...
Definition: ModItem.cs:107
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:39
string Name
The internal name of this ModItem.
Definition: ModItem.cs:45
virtual bool Terraria.ModLoader.ModItem.NewPreReforge ( )
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. </summary

Definition at line 615 of file ModItem.cs.

615  {
616  return true;
617  }
virtual void Terraria.ModLoader.ModItem.OnConsumeAmmo ( Player  player)
virtual

Allows you to makes things happen when ammo is consumed. Called both by the gun and by the ammo. Called before the ammo stack is reduced.

Parameters
playerThe player.

Definition at line 324 of file ModItem.cs.

324  {
325  }
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.

Definition at line 448 of file ModItem.cs.

448  {
449  }
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.

Definition at line 974 of file ModItem.cs.

974  {
975  }
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].

Definition at line 388 of file ModItem.cs.

388  {
389  }
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].

Definition at line 420 of file ModItem.cs.

420  {
421  }
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

Definition at line 769 of file ModItem.cs.

769  {
770  return true;
771  }
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.

Definition at line 598 of file ModItem.cs.

Referenced by Terraria.ModLoader.ItemLoader.OpenBossBag().

598  {
599  }

+ Here is the caller graph for this function:

virtual void Terraria.ModLoader.ModItem.PickAmmo ( 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
player
type
speed
damage
knockback

Definition at line 306 of file ModItem.cs.

306  {
307  }
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.

Definition at line 843 of file ModItem.cs.

844  {
845  }
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.

Definition at line 814 of file ModItem.cs.

814  {
815  }
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

Definition at line 992 of file ModItem.cs.

992  {
993  }
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

Definition at line 1009 of file ModItem.cs.

1009  {
1010  }
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.

Definition at line 629 of file ModItem.cs.

629  {
630  }
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.

Definition at line 736 of file ModItem.cs.

736  {
737  }
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

Definition at line 828 of file ModItem.cs.

829  {
830  return true;
831  }
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

Definition at line 801 of file ModItem.cs.

801  {
802  return true;
803  }
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

Definition at line 984 of file ModItem.cs.

984  {
985  return true;
986  }
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

Definition at line 1001 of file ModItem.cs.

1001  {
1002  return true;
1003  }
virtual void Terraria.ModLoader.ModItem.PreReforge ( )
virtual

Definition at line 621 of file ModItem.cs.

621  {
622  item.modItem?.NewPreReforge();
623  }
Item item
The item object that this ModItem controls.
Definition: ModItem.cs:26
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.

Definition at line 551 of file ModItem.cs.

551  {
552  }
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.

Definition at line 606 of file ModItem.cs.

606  {
607  return true;
608  }
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.

Definition at line 591 of file ModItem.cs.

591  {
592  }
virtual TagCompound Terraria.ModLoader.ModItem.Save ( )
virtual

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

Returns

Definition at line 932 of file ModItem.cs.

932  {
933  return null;
934  }
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.

Definition at line 155 of file ModItem.cs.

155  {
156  }
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].

Definition at line 577 of file ModItem.cs.

577  {
578  }
virtual void Terraria.ModLoader.ModItem.SetStaticDefaults ( )
virtual

This is where you set all your item's static properties, such as names/translations and the arrays in ItemID.Sets. This is called after SetDefaults on the initial ModItem

Definition at line 169 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.LoadEffect().

169  {
170  }

+ Here is the caller graph for this function:

virtual bool Terraria.ModLoader.ModItem.Shoot ( Player  player,
ref Vector2  position,
ref float  speedX,
ref float  speedY,
ref int  type,
ref int  damage,
ref float  knockBack 
)
virtual

This is called before the weapon creates a projectile. You can use it to create special effects, such as changing the speed, changing the initial position, and/or firing multiple projectiles. Return false to stop the game from shooting the default projectile (do this if you manually spawn your own projectile). Returns true by default.

Parameters
playerThe player.
positionThe shoot spawn position.
speedXThe speed x calculated from shootSpeed and mouse position.
speedYThe speed y calculated from shootSpeed and mouse position.
typeThe projectile type choosen by ammo and weapon.
damageThe projectile damage.
knockBackThe projectile knock back.
Returns

Definition at line 338 of file ModItem.cs.

338  {
339  return true;
340  }
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.

Definition at line 730 of file ModItem.cs.

730  {
731  }
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.

Definition at line 497 of file ModItem.cs.

497  {
498  }
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.

Definition at line 522 of file ModItem.cs.

522  {
523  }
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.

Definition at line 489 of file ModItem.cs.

489  {
490  }
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.

Definition at line 482 of file ModItem.cs.

482  {
483  }
virtual void Terraria.ModLoader.ModItem.UpdateVanity ( 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.

Definition at line 505 of file ModItem.cs.

505  {
506  }
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.

Definition at line 558 of file ModItem.cs.

558  {
559  }
virtual bool Terraria.ModLoader.ModItem.UseItem ( Player  player)
virtual

Allows you to make things happen when this item is used. Return true if using this item actually does stuff. Returns false by default. Runs on all clients and server. Use

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

Parameters
playerThe player.
Returns

Definition at line 429 of file ModItem.cs.

429  {
430  return false;
431  }
virtual bool Terraria.ModLoader.ModItem.UseItemFrame ( Player  player)
virtual

Allows you to modify the player's animation when this item is being used. Return true if you modify the player's animation. Returns false by default.

Parameters
playerThe player.
Returns

Definition at line 456 of file ModItem.cs.

456  {
457  return false;
458  }
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].

Definition at line 348 of file ModItem.cs.

348  {
349  }
virtual void Terraria.ModLoader.ModItem.UseStyle ( Player  player)
virtual

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

Parameters
playerThe player.

Definition at line 208 of file ModItem.cs.

208  {
209  }
virtual float Terraria.ModLoader.ModItem.UseTimeMultiplier ( Player  player)
virtual

Allows you to change the effective useTime of this item.

Parameters
player
Returns
The multiplier on the usage speed. 1f by default.

Definition at line 230 of file ModItem.cs.

230  {
231  return 1f;
232  }
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.

Definition at line 702 of file ModItem.cs.

703  {
704  }
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

Definition at line 721 of file ModItem.cs.

721  {
722  return false;
723  }

Member Data Documentation

int Terraria.ModLoader.ModItem.bossBagNPC

Definition at line 75 of file ModItem.cs.

virtual int Terraria.ModLoader.ModItem.BossBagNPC => BossBagNPC_Obsolete

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.

Definition at line 926 of file ModItem.cs.

Referenced by Terraria.ModLoader.ItemLoader.OpenBossBag().

virtual bool Terraria.ModLoader.ModItem.CloneNewInstances => false

Whether instances of this GlobalItem are created through Clone or constructor (by default implementations of NewInstance and Clone(Item, Item)). Defaults to false (using default constructor).

Definition at line 107 of file ModItem.cs.

virtual bool Terraria.ModLoader.ModItem.OnlyShootOnSwing => ProjOnSwing_Obsolete

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.

Definition at line 921 of file ModItem.cs.

bool Terraria.ModLoader.ModItem.projOnSwing

Definition at line 72 of file ModItem.cs.

virtual string Terraria.ModLoader.ModItem.Texture => (GetType().Namespace + "." + Name).Replace('.', '/')

The file name of this item's texture file in the mod loader's file space.

Definition at line 69 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AutoloadItem().

Property Documentation

int Terraria.ModLoader.ModItem.BossBagNPC_Obsolete
getsetprivate

Definition at line 84 of file ModItem.cs.

ModTranslation Terraria.ModLoader.ModItem.DisplayName
getset

The translations for the display name of this item.

Definition at line 53 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AddItem(), and Terraria.ModLoader.ModContent.RefreshModLanguage().

Mod Terraria.ModLoader.ModItem.mod
getset

Gets the mod.

The mod that added this ModItem.

Definition at line 37 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AddItem(), and Terraria.ModLoader.Mod.AutoloadItem().

string Terraria.ModLoader.ModItem.Name
getset

The internal name of this ModItem.

Definition at line 45 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AddItem(), and Terraria.ModLoader.Mod.AutoloadItem().

bool Terraria.ModLoader.ModItem.ProjOnSwing_Obsolete
getsetprivate

Definition at line 78 of file ModItem.cs.

ModTranslation Terraria.ModLoader.ModItem.Tooltip
getset

The translations for the display name of this tooltip.

Definition at line 61 of file ModItem.cs.

Referenced by Terraria.ModLoader.Mod.AddItem(), and Terraria.ModLoader.ModContent.RefreshModLanguage().