GlobalItem.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 Terraria.ModLoader.IO;
using Terraria.Utilities;
 
namespace Terraria.ModLoader
{
    public class GlobalItem
    {
        public Mod mod {
            get;
            internal set;
        }
 
        public string Name {
            get;
            internal set;
        }
 
        internal int index;
        internal int instanceIndex;
 
        public virtual bool Autoload(ref string name) {
            return mod.Properties.Autoload;
        }
 
        public virtual bool InstancePerEntity => false;
 
        public GlobalItem Instance(Item item) => InstancePerEntity ? item.globalItems[instanceIndex] : this;
 
        public virtual bool CloneNewInstances => false;
 
        public virtual GlobalItem Clone() => (GlobalItem)MemberwiseClone();
 
        public virtual GlobalItem Clone(Item item, Item itemClone) => NewInstance(item);
 
        public virtual GlobalItem NewInstance(Item item) {
            if (CloneNewInstances)
                return Clone();
 
            var copy = (GlobalItem)Activator.CreateInstance(GetType());
            copy.mod = mod;
            copy.Name = Name;
            copy.index = index; //not necessary, but consistency
            copy.instanceIndex = instanceIndex;//shouldn't be used, but someone might
            return copy;
        }
 
        public virtual void SetDefaults(Item item) {
        }
 
        public virtual int ChoosePrefix(Item item, UnifiedRandom rand) => -1;
 
        public virtual bool? PrefixChance(Item item, int pre, UnifiedRandom rand) => null;
 
        public virtual bool AllowPrefix(Item item, int pre) => true;
 
        public virtual bool CanUseItem(Item item, Player player) {
            return true;
        }
 
        public virtual void UseStyle(Item item, Player player) {
        }
 
        public virtual void HoldStyle(Item item, Player player) {
        }
 
        public virtual void HoldItem(Item item, Player player) {
        }
 
        public virtual float UseTimeMultiplier(Item item, Player player) {
            return 1f;
        }
 
        public virtual float MeleeSpeedMultiplier(Item item, Player player) {
            return 1f;
        }
 
        public virtual void GetHealLife(Item item, Player player, bool quickHeal, ref int healValue) {
        }
 
        public virtual void GetHealMana(Item item, Player player, bool quickHeal, ref int healValue) {
        }
 
        public virtual void ModifyManaCost(Item item, Player player, ref float reduce, ref float mult) {
        }
 
        public virtual void OnMissingMana(Item item, Player player, int neededMana) {
        }
 
        public virtual void OnConsumeMana(Item item, Player player, int manaConsumed) {
        }
 
        [Obsolete("Use ModifyWeaponDamage", true)]
        public virtual void GetWeaponDamage(Item item, Player player, ref int damage) {
        }
 
        [Obsolete("Use ModifyWeaponDamage overload with the additional flat parameter")]
        public virtual void ModifyWeaponDamage(Item item, Player player, ref float add, ref float mult) {
        }
 
        public virtual void ModifyWeaponDamage(Item item, Player player, ref float add, ref float mult, ref float flat) {
        }
 
        public virtual void GetWeaponKnockback(Item item, Player player, ref float knockback) {
        }
 
        public virtual void GetWeaponCrit(Item item, Player player, ref int crit) {
        }
 
        public virtual void PickAmmo(Item weapon, Item ammo, 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(Item item, Player player, ref int type, ref float speed, ref int damage, ref float knockback) {
        }
 
        public virtual bool ConsumeAmmo(Item item, Player player) {
            return true;
        }
 
        public virtual void OnConsumeAmmo(Item item, Player player) {
        }
 
        public virtual bool Shoot(Item item, 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(Item item, Player player, ref Rectangle hitbox, ref bool noHitbox) {
        }
 
        public virtual void MeleeEffects(Item item, Player player, Rectangle hitbox) {
        }
 
        public virtual bool? CanHitNPC(Item item, Player player, NPC target) {
            return null;
        }
 
        public virtual void ModifyHitNPC(Item item, Player player, NPC target, ref int damage, ref float knockBack, ref bool crit) {
        }
 
        public virtual void OnHitNPC(Item item, Player player, NPC target, int damage, float knockBack, bool crit) {
        }
 
        public virtual bool CanHitPvp(Item item, Player player, Player target) {
            return true;
        }
 
        public virtual void ModifyHitPvp(Item item, Player player, Player target, ref int damage, ref bool crit) {
        }
 
        public virtual void OnHitPvp(Item item, Player player, Player target, int damage, bool crit) {
        }
 
        public virtual bool UseItem(Item item, Player player) {
            return false;
        }
 
        public virtual bool ConsumeItem(Item item, Player player) {
            return true;
        }
 
        public virtual void OnConsumeItem(Item item, Player player) {
        }
 
        public virtual bool UseItemFrame(Item item, Player player) {
            return false;
        }
 
        public virtual bool HoldItemFrame(Item item, Player player) {
            return false;
        }
 
        public virtual bool AltFunctionUse(Item item, Player player) {
            return false;
        }
 
        public virtual void UpdateInventory(Item item, Player player) {
        }
 
        public virtual void UpdateEquip(Item item, Player player) {
        }
 
        public virtual void UpdateAccessory(Item item, Player player, bool hideVisual) {
        }
 
        public virtual string IsArmorSet(Item head, Item body, Item legs) {
            return "";
        }
 
        public virtual void UpdateArmorSet(Player player, string set) {
        }
 
        public virtual string 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, string set) {
        }
 
        public virtual void UpdateVanitySet(Player player, string set) {
        }
 
        public virtual void ArmorSetShadows(Player player, string set) {
        }
 
        public virtual void SetMatch(int armorSlot, int type, bool male, ref int equipSlot, ref bool robes) {
        }
 
        public virtual bool CanRightClick(Item item) {
            return false;
        }
 
        public virtual void RightClick(Item item, Player player) {
        }
 
        public virtual bool PreOpenVanillaBag(string context, Player player, int arg) {
            return true;
        }
 
        public virtual void OpenVanillaBag(string context, Player player, int arg) {
        }
 
        public virtual bool ReforgePrice(Item item, ref int reforgePrice, ref bool canApplyDiscount) {
            return true;
        }
 
        public virtual bool NewPreReforge(Item item) {
            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 item) {
            NewPreReforge(item);
        }
 
        public virtual void PostReforge(Item item) {
        }
 
        public virtual void DrawHands(int body, ref bool drawHands, ref bool drawArms) {
        }
 
        public virtual void DrawHair(int head, ref bool drawHair, ref bool drawAltHair) {
        }
 
        public virtual bool DrawHead(int head) {
            return true;
        }
 
        public virtual bool DrawBody(int body) {
            return true;
        }
 
        public virtual bool DrawLegs(int legs, int shoes) {
            return true;
        }
 
        public virtual void DrawArmorColor(EquipType type, int slot, Player drawPlayer, float shadow, ref Color color,
            ref int glowMask, ref Color glowMaskColor) {
        }
 
        public virtual void ArmorArmGlowMask(int slot, Player drawPlayer, float shadow, ref int glowMask, ref Color color) {
        }
 
        public virtual void VerticalWingSpeeds(Item item, Player player, ref float ascentWhenFalling, ref float ascentWhenRising,
    ref float maxCanAscendMultiplier, ref float maxAscentMultiplier, ref float constantAscend) {
        }
 
        public virtual void HorizontalWingSpeeds(Item item, Player player, ref float speed, ref float acceleration) {
        }
 
        public virtual bool WingUpdate(int wings, Player player, bool inUse) {
            return false;
        }
 
        public virtual void Update(Item item, ref float gravity, ref float maxFallSpeed) {
        }
 
        public virtual bool CanBurnInLava(Item item) {
            return false;
        }
 
        public virtual void PostUpdate(Item item) {
        }
 
        public virtual void GrabRange(Item item, Player player, ref int grabRange) {
        }
 
        public virtual bool GrabStyle(Item item, Player player) {
            return false;
        }
 
        public virtual bool CanPickup(Item item, Player player) {
            return true;
        }
 
        public virtual bool OnPickup(Item item, Player player) {
            return true;
        }
 
        public virtual bool ItemSpace(Item item, Player player) {
            return false;
        }
 
        public virtual Color? GetAlpha(Item item, Color lightColor) {
            return null;
        }
 
        public virtual bool PreDrawInWorld(Item item, SpriteBatch spriteBatch, Color lightColor, Color alphaColor, ref float rotation, ref float scale, int whoAmI) {
            return true;
        }
 
        public virtual void PostDrawInWorld(Item item, SpriteBatch spriteBatch, Color lightColor, Color alphaColor, float rotation, float scale, int whoAmI) {
        }
 
        public virtual bool PreDrawInInventory(Item item, SpriteBatch spriteBatch, Vector2 position, Rectangle frame,
            Color drawColor, Color itemColor, Vector2 origin, float scale) {
            return true;
        }
 
        public virtual void PostDrawInInventory(Item item, SpriteBatch spriteBatch, Vector2 position, Rectangle frame,
            Color drawColor, Color itemColor, Vector2 origin, float scale) {
        }
 
        public virtual Vector2? HoldoutOffset(int type) {
            return null;
        }
 
        public virtual Vector2? HoldoutOrigin(int type) {
            return null;
        }
 
        public virtual bool CanEquipAccessory(Item item, Player player, int slot) {
            return true;
        }
 
        public virtual void ExtractinatorUse(int extractType, ref int resultType, ref int resultStack) {
        }
 
        public virtual void CaughtFishStack(int type, ref int stack) {
        }
 
        public virtual bool IsAnglerQuestAvailable(int type) {
            return true;
        }
 
        public virtual void AnglerChat(int type, ref string chat, ref string catchLocation) {
        }
 
        public virtual void AddRecipes() {
        }
 
        public virtual void OnCraft(Item item, Recipe recipe) {
        }
 
        public virtual bool PreDrawTooltip(Item item, ReadOnlyCollection<TooltipLine> lines, ref int x, ref int y) {
            return true;
        }
 
        public virtual void PostDrawTooltip(Item item, ReadOnlyCollection<DrawableTooltipLine> lines) {
        }
 
        public virtual bool PreDrawTooltipLine(Item item, DrawableTooltipLine line, ref int yOffset) {
            return true;
        }
 
        public virtual void PostDrawTooltipLine(Item item, DrawableTooltipLine line) {
        }
 
        public virtual void ModifyTooltips(Item item, List<TooltipLine> tooltips) {
        }
 
        public virtual bool NeedsSaving(Item item) {
            return false;
        }
 
        public virtual TagCompound Save(Item item) {
            return null;
        }
 
        public virtual void Load(Item item, TagCompound tag) {
        }
 
        public virtual void LoadLegacy(Item item, BinaryReader reader) {
        }
 
        public virtual void NetSend(Item item, BinaryWriter writer) {
        }
 
        public virtual void NetReceive(Item item, BinaryReader reader) {
        }
    }
}