ConfigAttributes.cs

Go to the documentation of this file.

using Microsoft.Xna.Framework;
using System;
using System.ComponentModel;

namespace Terraria.ModLoader.Config
{
    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class)]
    public class BackgroundColorAttribute : Attribute
    {
        public Color color;
        public BackgroundColorAttribute(int r, int g, int b, int a = 255) {
            this.color = new Color(r, g, b, a);
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class)]
    public class SliderColorAttribute : Attribute
    {
        public Color color;
        public SliderColorAttribute(int r, int g, int b, int a = 255) {
            this.color = new Color(r, g, b, a);
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class ReloadRequiredAttribute : Attribute
    {
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class)]
    public class LabelAttribute : Attribute
    {
        readonly string label;
        public LabelAttribute(string label) {
            this.label = label;
        }
        public string Label => label.StartsWith("$") ? Localization.Language.GetTextValue(label.Substring(1)) : label;
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class TooltipAttribute : Attribute
    {
        readonly string tooltip;
        public TooltipAttribute(string tooltip) {
            this.tooltip = tooltip;
        }
        public string Tooltip => tooltip.StartsWith("$") ? Localization.Language.GetTextValue(tooltip.Substring(1)) : tooltip;
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class HeaderAttribute : Attribute
    {
        readonly string header;
        public HeaderAttribute(string header) {
            this.header = header;
        }
        public string Header => header.StartsWith("$") ? Localization.Language.GetTextValue(header.Substring(1)) : header;
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class | AttributeTargets.Enum)]
    public class CustomModConfigItemAttribute : Attribute
    {
        public Type t;
        public CustomModConfigItemAttribute(Type t) {
            this.t = t;
        }
    }

    public class JsonDefaultValueAttribute : Attribute
    {
        public string json;
        public JsonDefaultValueAttribute(string json) {
            this.json = json;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class DefaultListValueAttribute : Attribute
    {
        private object value;
        public DefaultListValueAttribute(Type type, string value) {
            try {
                this.value = TypeDescriptor.GetConverter(type).ConvertFromInvariantString(value);
            }
            catch {
                Logging.tML.Error("Default value attribute of type " + type.FullName + " threw converting from the string '" + value + "'.");
            }
        }

        public DefaultListValueAttribute(char value) => this.value = value;
        public DefaultListValueAttribute(byte value) => this.value = value;
        public DefaultListValueAttribute(short value) => this.value = value;
        public DefaultListValueAttribute(int value) => this.value = value;
        public DefaultListValueAttribute(long value) => this.value = value;
        public DefaultListValueAttribute(float value) => this.value = value;
        public DefaultListValueAttribute(double value) => this.value = value;
        public DefaultListValueAttribute(bool value) => this.value = value;
        public DefaultListValueAttribute(string value) => this.value = value;
        public DefaultListValueAttribute(object value) => this.value = value;

        public virtual object Value => value;

        public override bool Equals(object obj) {
            if (obj == this) {
                return true;
            }
            var other = obj as DefaultListValueAttribute;
            if (other != null) {
                if (Value != null) {
                    return Value.Equals(other.Value);
                }
                else {
                    return (other.Value == null);
                }
            }
            return false;
        }

        public override int GetHashCode() => base.GetHashCode();

        protected void SetValue(object value) {
            this.value = value;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class DefaultDictionaryKeyValueAttribute : Attribute
    {
        private object value;
        public DefaultDictionaryKeyValueAttribute(Type type, string value) {
            try {
                this.value = TypeDescriptor.GetConverter(type).ConvertFromInvariantString(value);
            }
            catch {
                Logging.tML.Error("Default value attribute of type " + type.FullName + " threw converting from the string '" + value + "'.");
            }
        }

        public DefaultDictionaryKeyValueAttribute(char value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(byte value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(short value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(int value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(long value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(float value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(double value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(bool value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(string value) => this.value = value;
        public DefaultDictionaryKeyValueAttribute(object value) => this.value = value;

        public virtual object Value => value;

        public override bool Equals(object obj) {
            if (obj == this) {
                return true;
            }
            var other = obj as DefaultDictionaryKeyValueAttribute;
            if (other != null) {
                if (Value != null) {
                    return Value.Equals(other.Value);
                }
                else {
                    return (other.Value == null);
                }
            }
            return false;
        }

        public override int GetHashCode() => base.GetHashCode();

        protected void SetValue(object value) {
            this.value = value;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class JsonDefaultListValueAttribute : Attribute
    {
        public string json;
        public JsonDefaultListValueAttribute(string json) {
            this.json = json;
        }
    }

    /* TODO: Implement this
    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class CustomAddMethodAttribute : Attribute
    {
        public string methodName;
        public CustomAddMethodAttribute(string methodName) {
            this.methodName = methodName;
        }
    }
    */

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class JsonDefaultDictionaryKeyValueAttribute : Attribute
    {
        public string json;
        public JsonDefaultDictionaryKeyValueAttribute(string json) {
            this.json = json;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class OptionStringsAttribute : Attribute
    {
        public string[] optionLabels { get; set; }
        public OptionStringsAttribute(string[] optionLabels) {
            this.optionLabels = optionLabels;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class IncrementAttribute : Attribute
    {
        public object increment;
        public IncrementAttribute(int increment) {
            this.increment = increment;
        }
        public IncrementAttribute(float increment) {
            this.increment = increment;
        }
        public IncrementAttribute(uint increment) {
            this.increment = increment;
        }
        public IncrementAttribute(byte increment) {
            this.increment = increment;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class RangeAttribute : Attribute
    {
        public object min;
        public object max;

        public RangeAttribute(int min, int max) {
            this.min = min;
            this.max = max;
        }

        public RangeAttribute(float min, float max) {
            this.min = min;
            this.max = max;
        }
        public RangeAttribute(uint min, uint max) {
            this.min = min;
            this.max = max;
        }
        public RangeAttribute(byte min, byte max) {
            this.min = min;
            this.max = max;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class SliderAttribute : Attribute
    {
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class DrawTicksAttribute : Attribute
    {
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class ColorNoAlphaAttribute : Attribute
    {
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class ColorHSLSliderAttribute : Attribute
    {
        public bool showSaturationAndLightness;
        public ColorHSLSliderAttribute(bool showSaturationAndLightness = true) {
            this.showSaturationAndLightness = showSaturationAndLightness;
        }
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class)]
    public class SeparatePageAttribute : Attribute
    {
    }

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Class)]
    public class NullAllowedAttribute : Attribute
    {
    }

    // Unimplemented ideas below:

    // Hide or Disable this item while in game.
    //[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    //public class HideInGameAttribute : Attribute { }

    // Hide or Disable this item while a client?
    //[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    //public class HideForClientAttribute : Attribute { }

    //[AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface, AllowMultiple = false, Inherited = true)]
    //public class StringRepresentationAttribute : Attribute
    //{
    //  public Func<string> StringRepresentation { get; set; }

    //  public StringRepresentationAttribute(Type delegateType, string delegateName)
    //  {
    //      StringRepresentation = (Func<string>)Delegate.CreateDelegate(delegateType, delegateType.GetMethod(delegateName));
    //  }
    //}

    //[StringRepresentation(typeof(TestDelegate), "GetConnection")]
    //public class Test
    //{
    //}

    //[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    //public class StringRepresentationAttribute : Attribute
    //{
    //  public Func<string> SomeProperty { get; set; }
    //}
}