ModConfig.cs

Go to the documentation of this file.

using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using Terraria.ModLoader.Config.UI;

namespace Terraria.ModLoader.Config
{
    // TODO: Enforce no statics allowed.

    public abstract class ModConfig
    {
        [JsonIgnore]
        public Mod mod { get; internal set; }

        [JsonIgnore]
        public string Name { get; internal set; }

        [JsonIgnore]
        public abstract ConfigScope Mode { get; }

        // TODO: Does non-autoloaded ModConfigs have a use-case?
        public virtual bool Autoload(ref string name) => mod.Properties.Autoload;

        public virtual void OnLoaded()
        {
        }

        public virtual void OnChanged()
        {
        }

        public virtual bool AcceptClientChanges(ModConfig pendingConfig, int whoAmI, ref string message)
        {
            return true;
        }

        // TODO: Can we get rid of Clone and just load from disk? Don't think so yet.
        public virtual ModConfig Clone() => (ModConfig)MemberwiseClone();

        public virtual bool NeedsReload(ModConfig pendingConfig)
        {
            foreach (PropertyFieldWrapper variable in ConfigManager.GetFieldsAndProperties(this))
            {
                ReloadRequiredAttribute reloadRequired = ConfigManager.GetCustomAttribute<ReloadRequiredAttribute>(variable, this, null);
                if (reloadRequired != null)
                {
                    // Do we need to implement nested ReloadRequired? Right now only top level fields will trigger it.
                    if (!ConfigManager.ObjectEquals(variable.GetValue(this), variable.GetValue(pendingConfig))) {
                        return true;
                    }
                }
            }
            return false;
        }
    }

    public enum ConfigScope
    {
        ServerSide,
        ClientSide,
        // PlayerSpecific,
        // WorldSpecific
    }
}