osu-framework / osu.Framework / Configuration / Tracking / TrackedSetting.cs

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using osu.Framework.Bindables;

namespace osu.Framework.Configuration.Tracking
{
    /// <summary>
    /// A singular tracked setting.
    /// </summary>
    /// <typeparam name="TValue">The type of the tracked value.</typeparam>
    public abstract class TrackedSetting<TValue> : ITrackedSetting
    {
        public event Action<SettingDescription> SettingChanged;

        private readonly object setting;
        private readonly Func<TValue, SettingDescription> generateDescription;

        private Bindable<TValue> bindable;

        /// <summary>
        /// Constructs a new <see cref="TrackedSetting{TValue}"/>.
        /// </summary>
        /// <param name="setting">The config setting to be tracked.</param>
        /// <param name="generateDescription">A function that generates the description for the setting, invoked every time the value changes.</param>
        protected TrackedSetting(object setting, Func<TValue, SettingDescription> generateDescription)
        {
            this.setting = setting;
            this.generateDescription = generateDescription;
        }

        public void LoadFrom<TLookup>(ConfigManager<TLookup> configManager)
            where TLookup : struct, Enum
        {
            bindable = configManager.GetBindable<TValue>((TLookup)setting);
            bindable.ValueChanged += displaySetting;
        }

        public void Unload()
        {
            bindable.ValueChanged -= displaySetting;
        }

        private void displaySetting(ValueChangedEvent<TValue> args) => SettingChanged?.Invoke(generateDescription(args.NewValue));
    }
}