ModPrefix.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using Terraria.ID;
using Terraria.Utilities;
 
namespace Terraria.ModLoader
{
    public abstract class ModPrefix
    {
        private static byte nextPrefix = PrefixID.Count;
 
        // TODO storing twice? could see a better implementation
        internal static readonly IList<ModPrefix> prefixes = new List<ModPrefix>();
        internal static readonly IDictionary<PrefixCategory, IList<ModPrefix>> categoryPrefixes;
 
        static ModPrefix() {
            categoryPrefixes = new Dictionary<PrefixCategory, IList<ModPrefix>>();
            foreach (PrefixCategory category in Enum.GetValues(typeof(PrefixCategory))) {
                categoryPrefixes[category] = new List<ModPrefix>();
            }
        }
 
        internal static byte ReservePrefixID() {
            if (ModNet.AllowVanillaClients) throw new Exception("Adding items breaks vanilla client compatibility");
            if (nextPrefix == 0) throw new Exception("Prefix ID limit has been broken");
 
            byte reserveID = nextPrefix;
            nextPrefix++;
            return reserveID;
        }
 
        public static ModPrefix GetPrefix(byte type) {
            return type >= PrefixID.Count && type < PrefixCount ? prefixes[type - PrefixID.Count] : null;
        }
 
        public static List<ModPrefix> GetPrefixesInCategory(PrefixCategory category) {
            return new List<ModPrefix>(categoryPrefixes[category]);
        }
 
        public static byte PrefixCount => nextPrefix;
 
        internal static void ResizeArrays() {
            Array.Resize(ref Lang.prefix, nextPrefix);
        }
 
        internal static void Unload() {
            prefixes.Clear();
            nextPrefix = PrefixID.Count;
            foreach (PrefixCategory category in Enum.GetValues(typeof(PrefixCategory))) {
                categoryPrefixes[category].Clear();
            }
        }
 
        internal static void Roll(Item item, ref int prefix, int vanillaWeight, params PrefixCategory[] categories) {
            WeightedRandom<byte> wr = new WeightedRandom<byte>();
            foreach (PrefixCategory category in categories)
                foreach (ModPrefix modPrefix in categoryPrefixes[category].Where(x => x.CanRoll(item)))
                    wr.Add(modPrefix.Type, modPrefix.RollChance(item));
 
            if (vanillaWeight > 0)
                wr.Add((byte)prefix, vanillaWeight);
 
            prefix = wr.Get();
        }
 
        public Mod mod {
            get;
            internal set;
        }
 
        public string Name {
            get;
            internal set;
        }
 
        public byte Type {
            get;
            internal set;
        }
 
        public ModTranslation DisplayName {
            get;
            internal set;
        }
 
        public virtual float RollChance(Item item) {
            return 1f;
        }
 
        public virtual bool CanRoll(Item item) {
            return RollChance(item) > 0;
        }
 
        public virtual PrefixCategory Category => PrefixCategory.Custom;
 
        public virtual bool Autoload(ref string name) {
            return mod.Properties.Autoload;
        }
 
        public virtual void AutoDefaults() {
            if (DisplayName.IsDefault())
                DisplayName.SetDefault(Regex.Replace(Name, "([A-Z])", " $1").Trim());
        }
 
        public virtual void SetDefaults() {
        }
 
        public virtual void SetStats(ref float damageMult, ref float knockbackMult, ref float useTimeMult,
            ref float scaleMult, ref float shootSpeedMult, ref float manaMult, ref int critBonus) {
        }
 
        public virtual void ValidateItem(Item item, ref bool invalid) {
        }
 
        public virtual void Apply(Item item) {
        }
 
        public virtual void ModifyValue(ref float valueMult) {
        }
    }
 
    public enum PrefixCategory
    {
        Melee,
        Ranged,
        Magic,
        AnyWeapon,
        Accessory,
        Custom
    }
}