UIVarSlider.cs

Go to the documentation of this file.

using UnityEngine;
using UnityEngine.UI;
using HKI.Core.Variables;

namespace HKI.Core.UI
{
    [AddComponentMenu("HKI/UI/UIVarSlider")]
    [RequireComponent(typeof(Slider))]
    [DisallowMultipleComponent]
    public class UIVarSlider : MonoBehaviour
    {
        // Public variables
        [Header("General Properties")]
        [SerializeField] FloatMinMax FloatVariable = null;
        [SerializeField] IntegerMinMax IntegerVariable = null;

        [SerializeField] bool SetVarOnValueChangedCallback = false;
        [SerializeField] bool SetVarOnDisable = false;

        [SerializeField] GameObject ValueTextGO = null;
        [SerializeField] bool DisplayAsPercentage = false;
        [SerializeField] int DecimalPlacesForFloatVariable = 2;

        // Private variables
        Slider slider = null;

        TMProAndUGUITextAccessor valueText = null;

        string formatString = "N";

        float range = 0.0f;

        // Awake function
        void Awake()
        {
            if(FloatVariable == null && IntegerVariable == null)
            {
                Debug.LogError("(UIVarSlider)" + name + " there is neither a float nor an integer variable attached to this var slider!");
                return;
            }
            
            slider = GetComponent<Slider>();

            if (FloatVariable != null)
            {
                slider.minValue = FloatVariable.GetMinValue;
                slider.maxValue = FloatVariable.GetMaxValue;
                slider.wholeNumbers = false;
            }
            else if (IntegerVariable != null)
            {
                slider.minValue = IntegerVariable.GetMinValue;
                slider.maxValue = IntegerVariable.GetMaxValue;
                slider.wholeNumbers = true;
            }

            range = slider.maxValue - slider.minValue;

            if(FloatVariable != null)
                formatString += DecimalPlacesForFloatVariable.ToString();

            valueText = new TMProAndUGUITextAccessor(ValueTextGO);

            slider.onValueChanged.AddListener((value) => { OnValueChanged(); });
        }

        // OnEnable function
        void OnEnable()
        {
            if(FloatVariable != null)
            {
                slider.value = FloatVariable.Value;

                ChangeText();

                FloatVariable.OnValueChanged += OnExternalChange;
            }
            else if(IntegerVariable != null)
            {
                slider.value = IntegerVariable.Value;

                ChangeText();

                IntegerVariable.OnValueChanged += OnExternalChange;
            }
        }

        // OnDisable
        void OnDisable()
        {
            if(FloatVariable != null)
                FloatVariable.OnValueChanged -= OnExternalChange;
            else if(IntegerVariable != null)
                IntegerVariable.OnValueChanged -= OnExternalChange;

            if (SetVarOnDisable)
                SetVarToSliderValue();
        }

        // Interface function
        public void SetVarToSliderValue()
        {
            if(FloatVariable != null && FloatVariable.Value != slider.value)
                FloatVariable.SetValue = slider.value;
            else if(IntegerVariable != null && IntegerVariable.Value != (int)slider.value)
                IntegerVariable.SetValue = (int)slider.value;
        }

        public void Reset()
        {
            if (FloatVariable != null)
            {
                slider.value = FloatVariable.Value;

                ChangeText();
            }
            else if (IntegerVariable != null)
            {
                slider.value = IntegerVariable.Value;

                ChangeText();
            }
        }

        // Callback function
        void OnValueChanged()
        {
            ChangeText();

            if(SetVarOnValueChangedCallback)
                SetVarToSliderValue();
        }

        void OnExternalChange()
        {
            if(FloatVariable != null && FloatVariable.Value != slider.value)
                    slider.value = FloatVariable.Value;
            else if (IntegerVariable != null && IntegerVariable.Value != (int)slider.value)
                slider.value = (int)IntegerVariable.Value;
        }

        void ChangeText()
        {
            if(DisplayAsPercentage)
                valueText.ChangeText(((slider.value - slider.minValue) * 100.0f / range).ToString(formatString) + "%");
            else
            {
                if (FloatVariable != null)
                    valueText.ChangeText(slider.value.ToString(formatString));
                else if (IntegerVariable != null)
                    valueText.ChangeText(((int)slider.value).ToString());
            }
        }
    }
}