Modifier.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.IO;
using Loot.Api.Content;
using Loot.Api.Graphics.Glowmask;
using Loot.Api.Graphics.Shader;
using Microsoft.Xna.Framework;
using Terraria;
using Terraria.ModLoader;
using Terraria.ModLoader.IO;
using Terraria.Utilities;

namespace Loot.Api.Core
{
    public abstract class Modifier : GlobalItem, ILoadableContent, ILoadableContentSetter, ICloneable
    {
        public Mod Mod { get; internal set; }

        Mod ILoadableContentSetter.Mod
        {
            set => Mod = value;
        }

        public uint Type { get; internal set; }

        uint ILoadableContentSetter.Type
        {
            set => Type = value;
        }

        public new string Name => GetType().Name;
        public virtual string UniqueName => string.Empty;
        public string GetFormattedUniqueName() => !string.IsNullOrEmpty(UniqueName) ? $"\"{UniqueName}\"" : string.Empty;

        public virtual GlowmaskEntity GetGlowmaskEntity(Item item) => null;
        public virtual ShaderEntity GetShaderEntity(Item item) => null;

        public ModifierProperties Properties { get; internal set; }

        public virtual ModifierTooltipLine.ModifierTooltipBuilder GetTooltip()
            => ModifierTooltipLine.Builder;

        public virtual ModifierProperties.ModifierPropertiesBuilder GetModifierProperties(Item item)
            => ModifierProperties.Builder;

        /* Global
            For now:
            We cannot roll on items that can stack (stacking is undefined behavior)
        */
        protected internal bool _CanRoll(ModifierContext ctx)
        {
            // Properties are pre-loaded before CanRoll as they may be needed for checks
            Properties = GetModifierProperties(ctx.Item).Build();
            return ctx.Item.maxStack <= 1 && CanRoll(ctx);
        }

        public virtual bool CanRoll(ModifierContext ctx)
            => true;

        public virtual void Roll(ModifierContext ctx, IEnumerable<Modifier> rolledModifiers)
        {
        }

        public virtual bool PostRoll(ModifierContext ctx, IEnumerable<Modifier> rolledModifiers)
            => true;

        public virtual void Apply(Item item)
        {
        }

        public virtual void Clone(ref Modifier clone)
        {
        }

        public new object Clone()
        {
            Modifier clone = (Modifier)MemberwiseClone();
            clone.Mod = Mod;
            clone.Type = Type;
            clone.Properties = Properties;
            Clone(ref clone);
            return clone;
        }

        public new virtual void Load(Item item, TagCompound tag)
        {
        }

        public virtual void Save(Item item, TagCompound tag)
        {
        }

        // Never autoload us
        public sealed override bool Autoload(ref string name) => false;
        public sealed override bool InstancePerEntity => true;
        public sealed override bool CloneNewInstances => true;

        public sealed override void SetDefaults(Item item)
        {
            base.SetDefaults(item);
            Apply(item);
        }

        public sealed override int ChoosePrefix(Item item, UnifiedRandom rand)
        {
            return base.ChoosePrefix(item, rand);
        }

        // The following hooks aren't applicable in instanced context, so we seal them here so they can't be used   
        public sealed override GlobalItem Clone(Item item, Item itemClone) => base.Clone(item, itemClone);

        public sealed override void ExtractinatorUse(int extractType, ref int resultType, ref int resultStack)
        {
        }

        public sealed override void CaughtFishStack(int type, ref int stack)
        {
        }

        public sealed override void AnglerChat(int type, ref string chat, ref string catchLocation)
        {
        }

        public sealed override void OnCraft(Item item, Recipe recipe)
        {
        }

        public sealed override void ArmorSetShadows(Player player, string set)
        {
        }

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

        public sealed override void DrawArmorColor(EquipType type, int slot, Player drawPlayer, float shadow, ref Color color, ref int glowMask, ref Color glowMaskColor)
        {
        }

        public sealed override bool DrawBody(int body) => base.DrawBody(body);

        public sealed override void DrawHair(int head, ref bool drawHair, ref bool drawAltHair)
        {
        }

        public sealed override void DrawHands(int body, ref bool drawHands, ref bool drawArms)
        {
        }

        public sealed override bool DrawHead(int head) => base.DrawHead(head);
        public sealed override bool DrawLegs(int legs, int shoes) => base.DrawLegs(legs, shoes);
        public sealed override Vector2? HoldoutOffset(int type) => base.HoldoutOffset(type);
        public sealed override Vector2? HoldoutOrigin(int type) => base.HoldoutOrigin(type);
        public sealed override bool IsAnglerQuestAvailable(int type) => base.IsAnglerQuestAvailable(type);
        public sealed override string IsArmorSet(Item head, Item body, Item legs) => base.IsArmorSet(head, body, legs);

        public sealed override string IsVanitySet(int head, int body, int legs) => base.IsVanitySet(head, body, legs);

        // If modders wish to save/load data, they should use our custom save and load hooks
        public sealed override void LoadLegacy(Item item, BinaryReader reader)
        {
        }

        public sealed override bool NeedsSaving(Item item) => base.NeedsSaving(item);
        public sealed override GlobalItem NewInstance(Item item) => base.NewInstance(item);

        public sealed override void OpenVanillaBag(string context, Player player, int arg)
        {
        }

        public sealed override bool PreOpenVanillaBag(string context, Player player, int arg) => base.PreOpenVanillaBag(context, player, arg);

        public sealed override void PreUpdateVanitySet(Player player, string set)
        {
        }

        // If modders wish to save/load data, they should use our custom save and load hooks
        public sealed override TagCompound Save(Item item) => base.Save(item);

        public sealed override void SetMatch(int armorSlot, int type, bool male, ref int equipSlot, ref bool robes)
        {
        }

        public sealed override void UpdateArmorSet(Player player, string set)
        {
        }

        public sealed override void UpdateVanitySet(Player player, string set)
        {
        }

        public sealed override bool WingUpdate(int wings, Player player, bool inUse) => base.WingUpdate(wings, player, inUse);
    }
}