ModItem.cs

Go to the documentation of this file.

using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.IO;
using System.Text.RegularExpressions;
using Terraria.ModLoader.IO;
using Terraria.Utilities;

namespace Terraria.ModLoader
{
    public class ModItem
    {
        //add modItem property to Terraria.Item (internal set)
        //set modItem to null at beginning of Terraria.Item.ResetStats      
        public Item item {
            get;
            internal set;
        }

        public Mod mod {
            get;
            internal set;
        }

        public string Name {
            get;
            internal set;
        }

        public ModTranslation DisplayName {
            get;
            internal set;
        }

        public ModTranslation Tooltip {
            get;
            internal set;
        }

        public virtual string Texture => (GetType().Namespace + "." + Name).Replace('.', '/');

        [Obsolete("override ModItem.OnlyShootOnSwing property", true)]
        public bool projOnSwing;

        [Obsolete("override ModItem.BossBagNPC property", true)]
        public int bossBagNPC;

        [Obsolete]
        private bool ProjOnSwing_Obsolete {
            get => projOnSwing;
            set => projOnSwing = value;
        }

        [Obsolete]
        private int BossBagNPC_Obsolete {
            get => bossBagNPC;
            set => bossBagNPC = value;
        }

        public ModItem() {
            item = new Item { modItem = this };
        }

        public virtual bool Autoload(ref string name) {
            return mod.Properties.Autoload;
        }

        public virtual bool CloneNewInstances => false;

        public virtual ModItem Clone() => (ModItem)MemberwiseClone();

        public virtual ModItem Clone(Item item) => NewInstance(item);

        public virtual ModItem NewInstance(Item itemClone) {
            if (CloneNewInstances) {
                var clone = Clone();
                clone.item = itemClone;
                return clone;
            }

            var copy = (ModItem)Activator.CreateInstance(GetType());
            copy.item = itemClone;
            copy.mod = mod;
            copy.Name = Name;
            copy.ProjOnSwing_Obsolete = ProjOnSwing_Obsolete;
            copy.BossBagNPC_Obsolete = BossBagNPC_Obsolete;
            return copy;
        }

        public virtual void SetDefaults() {
        }

        public virtual void AutoDefaults() {
            EquipLoader.SetSlot(item);
        }

        public virtual void SetStaticDefaults() {
        }

        public virtual void AutoStaticDefaults() {
            Main.itemTexture[item.type] = ModContent.GetTexture(Texture);

            var flameTexture = Texture + "_Flame";
            if (ModContent.TextureExists(flameTexture)) {
                Main.itemFlameTexture[item.type] = ModContent.GetTexture(flameTexture);
                Main.itemFlameLoaded[item.type] = true;
            }

            if (DisplayName.IsDefault())
                DisplayName.SetDefault(Regex.Replace(Name, "([A-Z])", " $1").Trim());
        }

        public virtual int ChoosePrefix(UnifiedRandom rand) => -1;

        public virtual bool? PrefixChance(int pre, UnifiedRandom rand) => null;

        public virtual bool AllowPrefix(int pre) => true;

        public virtual bool CanUseItem(Player player) {
            return true;
        }

        public virtual void UseStyle(Player player) {
        }

        public virtual void HoldStyle(Player player) {
        }

        public virtual void HoldItem(Player player) {
        }

        public virtual float UseTimeMultiplier(Player player) {
            return 1f;
        }

        public virtual float MeleeSpeedMultiplier(Player player) {
            return 1f;
        }

        public virtual void GetHealLife(Player player, bool quickHeal, ref int healValue) {
        }

        public virtual void GetHealMana(Player player, bool quickHeal, ref int healValue) {
        }

        public virtual void ModifyManaCost(Player player, ref float reduce, ref float mult) {
        }

        public virtual void OnMissingMana(Player player, int neededMana) {
        }

        public virtual void OnConsumeMana(Player player, int manaConsumed) {
        }

        [Obsolete("Use ModifyWeaponDamage", true)]
        public virtual void GetWeaponDamage(Player player, ref int damage) {
        }

        [Obsolete("Use ModifyWeaponDamage overload with the additional flat parameter")]
        public virtual void ModifyWeaponDamage(Player player, ref float add, ref float mult) {
        }

        public virtual void ModifyWeaponDamage(Player player, ref float add, ref float mult, ref float flat) {
        }

        public virtual void GetWeaponKnockback(Player player, ref float knockback) {
        }

        public virtual void GetWeaponCrit(Player player, ref int crit) {
        }

        public virtual void PickAmmo(Item weapon, Player player, ref int type, ref float speed, ref int damage, ref float knockback) {
        }
        
        [Obsolete("PickAmmo now has a weapon parameter that represents the item using the ammo.")]
        public virtual void PickAmmo(Player player, ref int type, ref float speed, ref int damage, ref float knockback) {
        }

        public virtual bool ConsumeAmmo(Player player) {
            return true;
        }

        public virtual void OnConsumeAmmo(Player player) {
        }

        public virtual bool Shoot(Player player, ref Vector2 position, ref float speedX, ref float speedY, ref int type, ref int damage, ref float knockBack) {
            return true;
        }

        public virtual void UseItemHitbox(Player player, ref Rectangle hitbox, ref bool noHitbox) {
        }

        public virtual void MeleeEffects(Player player, Rectangle hitbox) {
        }

        public virtual bool? CanHitNPC(Player player, NPC target) {
            return null;
        }

        public virtual void ModifyHitNPC(Player player, NPC target, ref int damage, ref float knockBack, ref bool crit) {
        }

        public virtual void OnHitNPC(Player player, NPC target, int damage, float knockBack, bool crit) {
        }

        public virtual bool CanHitPvp(Player player, Player target) {
            return true;
        }

        public virtual void ModifyHitPvp(Player player, Player target, ref int damage, ref bool crit) {
        }

        public virtual void OnHitPvp(Player player, Player target, int damage, bool crit) {
        }

        public virtual bool UseItem(Player player) {
            return false;
        }

        public virtual bool ConsumeItem(Player player) {
            return true;
        }

        public virtual void OnConsumeItem(Player player) {
        }

        public virtual bool UseItemFrame(Player player) {
            return false;
        }

        public virtual bool HoldItemFrame(Player player) {
            return false;
        }

        public virtual bool AltFunctionUse(Player player) {
            return false;
        }

        public virtual void UpdateInventory(Player player) {
        }

        public virtual void UpdateEquip(Player player) {
        }

        public virtual void UpdateAccessory(Player player, bool hideVisual) {
        }

        public virtual void UpdateVanity(Player player, EquipType type) {
        }

        public virtual bool IsArmorSet(Item head, Item body, Item legs) {
            return false;
        }

        public virtual void UpdateArmorSet(Player player) {
        }

        public virtual bool IsVanitySet(int head, int body, int legs) {
            Item headItem = new Item();
            if (head >= 0) {
                headItem.SetDefaults(Item.headType[head], true);
            }
            Item bodyItem = new Item();
            if (body >= 0) {
                bodyItem.SetDefaults(Item.bodyType[body], true);
            }
            Item legItem = new Item();
            if (legs >= 0) {
                legItem.SetDefaults(Item.legType[legs], true);
            }
            return IsArmorSet(headItem, bodyItem, legItem);
        }

        public virtual void PreUpdateVanitySet(Player player) {
        }

        public virtual void UpdateVanitySet(Player player) {
        }

        public virtual void ArmorSetShadows(Player player) {
        }

        public virtual void SetMatch(bool male, ref int equipSlot, ref bool robes) {
        }

        public virtual bool CanRightClick() {
            return false;
        }

        public virtual void RightClick(Player player) {
        }

        public virtual void OpenBossBag(Player player) {
        }

        public virtual bool ReforgePrice(ref int reforgePrice, ref bool canApplyDiscount) {
            return true;
        }

        public virtual bool NewPreReforge() {
            return true;
        }

        // @todo: PreReforge marked obsolete until v0.11
        [method: Obsolete("PreReforge now returns a bool to control whether the reforge takes place. For now, use NewPreReforge")]
        public virtual void PreReforge() {
            item.modItem?.NewPreReforge();
        }

        public virtual void PostReforge() {
        }

        public virtual void DrawHands(ref bool drawHands, ref bool drawArms) {
        }

        public virtual void DrawHair(ref bool drawHair, ref bool drawAltHair) {
        }

        public virtual bool DrawHead() {
            return true;
        }

        public virtual bool DrawBody() {
            return true;
        }

        public virtual bool DrawLegs() {
            return true;
        }

        public virtual void DrawArmorColor(Player drawPlayer, float shadow, ref Color color, ref int glowMask, ref Color glowMaskColor) {
        }

        public virtual void ArmorArmGlowMask(Player drawPlayer, float shadow, ref int glowMask, ref Color color) {
        }

        public virtual void VerticalWingSpeeds(Player player, ref float ascentWhenFalling, ref float ascentWhenRising,
    ref float maxCanAscendMultiplier, ref float maxAscentMultiplier, ref float constantAscend) {
        }

        public virtual void HorizontalWingSpeeds(Player player, ref float speed, ref float acceleration) {
        }

        public virtual bool WingUpdate(Player player, bool inUse) {
            return false;
        }

        public virtual void Update(ref float gravity, ref float maxFallSpeed) {
        }

        public virtual bool CanBurnInLava()
        {
            return false;
        }
        
        public virtual void PostUpdate() {
        }

        public virtual void GrabRange(Player player, ref int grabRange) {
        }

        public virtual bool GrabStyle(Player player) {
            return false;
        }

        public virtual bool CanPickup(Player player) {
            return true;
        }

        public virtual bool OnPickup(Player player) {
            return true;
        }

        public virtual bool ItemSpace(Player player) {
            return false;
        }

        public virtual Color? GetAlpha(Color lightColor) {
            return null;
        }

        public virtual bool PreDrawInWorld(SpriteBatch spriteBatch, Color lightColor, Color alphaColor, ref float rotation, ref float scale, int whoAmI) {
            return true;
        }

        public virtual void PostDrawInWorld(SpriteBatch spriteBatch, Color lightColor, Color alphaColor, float rotation, float scale, int whoAmI) {
        }

        public virtual bool PreDrawInInventory(SpriteBatch spriteBatch, Vector2 position, Rectangle frame, Color drawColor,
            Color itemColor, Vector2 origin, float scale) {
            return true;
        }

        public virtual void PostDrawInInventory(SpriteBatch spriteBatch, Vector2 position, Rectangle frame, Color drawColor,
            Color itemColor, Vector2 origin, float scale) {
        }

        public virtual Vector2? HoldoutOffset() {
            return null;
        }

        public virtual Vector2? HoldoutOrigin() {
            return null;
        }

        public virtual bool CanEquipAccessory(Player player, int slot) {
            return true;
        }

        public virtual void ExtractinatorUse(ref int resultType, ref int resultStack) {
        }

        public virtual void AutoLightSelect(ref bool dryTorch, ref bool wetTorch, ref bool glowstick) {
        }

        public virtual void CaughtFishStack(ref int stack) {
        }

        public virtual bool IsQuestFish() {
            return false;
        }

        public virtual bool IsAnglerQuestAvailable() {
            return true;
        }

        public virtual void AnglerQuestChat(ref string description, ref string catchLocation) {
        }

        public virtual bool OnlyShootOnSwing => ProjOnSwing_Obsolete;

        public virtual int BossBagNPC => BossBagNPC_Obsolete;

        public virtual bool IgnoreDamageModifiers => false;

        public virtual TagCompound Save() {
            return null;
        }

        public virtual void Load(TagCompound tag) {
        }

        public virtual void LoadLegacy(BinaryReader reader) {
        }

        public virtual void NetSend(BinaryWriter writer) {
        }

        public virtual void NetRecieve(BinaryReader reader) {
        }

        public virtual void AddRecipes() {
        }

        public virtual void OnCraft(Recipe recipe) {
        }

        public virtual bool PreDrawTooltip(ReadOnlyCollection<TooltipLine> lines, ref int x, ref int y) {
            return true;
        }

        public virtual void PostDrawTooltip(ReadOnlyCollection<DrawableTooltipLine> lines) {
        }

        public virtual bool PreDrawTooltipLine(DrawableTooltipLine line, ref int yOffset) {
            return true;
        }

        public virtual void PostDrawTooltipLine(DrawableTooltipLine line) {
        }

        public virtual void ModifyTooltips(List<TooltipLine> tooltips) {
        }
    }
}