SettingsSystem.cs

Go to the documentation of this file.

using UnityEngine;
using UnityEngine.Audio;
using System.IO;
using System.Xml;
using System.Collections.Generic;
using HKI.Core.Loc;
using HKI.Core.Init;
using HKI.Core.Variables;

namespace HKI.Core.Settings
{
    [System.Serializable]
    public class SettingsSystem : Container, IInit
    {
        // Private variables
        bool isEditor = false;
        bool changeFunctionCallbacksLinked = false;

        string configFilePath = "";

        [SerializeField] string ConfigFilename = "config.config";
        [SerializeField] string EditorPath = "";
        string runtimePath = "";

        [SerializeField] bool WarningsEnabled = true;

        [SerializeField] bool UseTargetFrameRate = true;

        [SerializeField] IntegerWidthHeight Resolution = null;
        [SerializeField] Boolean Fullscreen = null;
        [SerializeField] Integer RefreshRate = null;
        [SerializeField] String Quality = null;
        [SerializeField] FrameRateAndVSyncMode FRAVSM = null;
        [SerializeField] AntiAliasingMode AAM = null;
        [SerializeField] Language TextLanguage = null;
        [SerializeField] Language AudioLanguage = null;
        [SerializeField] FloatMinMax MasterVolume = null;
        [SerializeField] FloatMinMax MusicVolume = null;
        [SerializeField] FloatMinMax AmbientVolume = null;
        [SerializeField] FloatMinMax FxVolume = null;
        [SerializeField] FloatMinMax UiFxVolume = null;
        [SerializeField] FloatMinMax VoicesVolume = null;

        [SerializeField] AudioMixer AudioMixer = null;

        // Init function
        public void Init()
        {
            isEditor = Application.isEditor;

            runtimePath = Application.persistentDataPath + "/";

            if (isEditor)
                configFilePath = EditorPath + ConfigFilename;
            else
                configFilePath = runtimePath + ConfigFilename;

            if(isEditor && !Application.isPlaying)
                return;

            LinkStandardSettingsToOnChangeFunctions();

            if(isEditor)
                ActivateAllSettings();
            else
            {
                if(!Load())
                    CreateConfigFile();
            }
        }

        // OnDisable function
        void OnDisable()
        {
            if(changeFunctionCallbacksLinked)
                UnLinkStandardSettingsFromOnChangeFunctions();
        }

        // Interface functions
        public void Save()
        {
            XmlDocument document = new XmlDocument();

            XmlNode rootNode = document.CreateElement("Config");
            document.AppendChild(rootNode);
            Save(rootNode);
            document.Save(configFilePath);
        }

        // Helper functions
        void GetReferences()
        {
            Resolution = GetVar<IntegerWidthHeight>("Resolution");
            Fullscreen = GetVar<Boolean>("Fullscreen");
            RefreshRate = GetVar<Integer>("Refresh Rate");
            Quality = GetVar<String>("Quality");
            FRAVSM = GetVar<FrameRateAndVSyncMode>("FRAVSM");
            AAM = GetVar<AntiAliasingMode>("AAM");
            TextLanguage = GetVar<Language>("Text Language");
            AudioLanguage = GetVar<Language>("Audio Language");
            MasterVolume = GetVar<FloatMinMax>("Master Volume");
            MusicVolume = GetVar<FloatMinMax>("Music Volume");
            AmbientVolume = GetVar<FloatMinMax>("Ambient Volume");
            FxVolume = GetVar<FloatMinMax>("Fx Volume");
            UiFxVolume = GetVar<FloatMinMax>("Ui Fx Volume");
            VoicesVolume = GetVar<FloatMinMax>("Voices Volume");
        }

        T GetVar<T>(string variableName) where T : HKIVar
        {
            HKIVar variable = GetHKIVarByName(variableName);

            if(variable == null)
            {
                Debug.LogError("Couldn't find a >" + variableName + "< of type >" + typeof(T).Name + "< variable as child of the settings system!");
                return null;
            }

            return (T)variable;
        }

        bool Load()
        {
            if(isEditor)
                return false;

            if(!File.Exists(configFilePath))
                return false;


            XmlDocument document = new XmlDocument();

            document.Load(configFilePath);
            XmlNode configNode = document.SelectSingleNode("//Config/" + name.Replace(" ", ""));
            if(configNode == null)
            {
                Debug.LogError("Config file is corupted!");
                return false;
            }

            Load(configNode);

            ActivateAllSettings();

            return true;
        }

        void CreateConfigFile()
        {
            Save();
            ActivateAllSettings();
        }

        void ActivateAllSettings()
        {
            ChangeResolution();
            ChangeQuality();
            ChangeFrameRateAndVSyncMode();
            ChangeAudio();
        }

        void LinkStandardSettingsToOnChangeFunctions()
        {
            // Resolution
            if(Resolution != null)
            {
                if (isEditor)
                    Resolution.OnValueChanged += () => { LogInfoForNotSetableInEditor(Resolution); };
                else
                    Resolution.OnValueChanged += ChangeResolution;
            }
            else if(WarningsEnabled)
                Debug.LogWarning("There is no linked >Resolution< variable of type >IntegerWidthHeight< in this settings system!");

            // Fullscreen
            if(Fullscreen != null)
            {
                if (isEditor)
                    Fullscreen.OnValueChanged += () => { LogInfoForNotSetableInEditor(Fullscreen); };
                else
                    Fullscreen.OnValueChanged += ChangeResolution;
            }
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >Fullscreen< variable of type >Boolean< in this settings system!");

            // Refresh rate
            if(UseTargetFrameRate && RefreshRate != null)
            {
                if (isEditor)
                    RefreshRate.OnValueChanged += () => { LogInfoForNotSetableInEditor(RefreshRate); };
                else
                    RefreshRate.OnValueChanged += ChangeResolution;
            }
            else if(UseTargetFrameRate && WarningsEnabled)
                Debug.LogError("There is no linked >RefreshRate< variable of type >Integer< in this settings system!");

            // Quality
            if(Quality != null)
                Quality.OnValueChanged += ChangeQuality;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >Quality< variable of type >String< in this settings system!");

            // FRAVSM
            if(FRAVSM != null)
                FRAVSM.OnValueChanged += ChangeFrameRateAndVSyncMode;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >FRAVSM< variable of type >FrameRateAndVSyncMode< in this settings system!");
            
            // AAM
            // Done by camera script

            // Master Volume
            if (MasterVolume != null)
                MasterVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >MasterVolume< variable of type >FloatMinMax< in this settings system!");

            // Music Volume
            if(MusicVolume != null)
                MusicVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >MusicVolume< variable of type >FloatMinMax< in this settings system!");

            // Ambient Volume
            if(AmbientVolume != null)
                AmbientVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >AmbientVolume< variable of type >FloatMinMax< in this settings system!");

            // Fx Volume
            if(FxVolume != null)
                FxVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >FxVolume< variable of type >FloatMinMax< in this settings system!");

            // Ui Fx Volume
            if(UiFxVolume != null)
                UiFxVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >UiFxVolume< variable of type >FloatMinMax< in this settings system!");

            // Voices Volume
            if(VoicesVolume != null)
                VoicesVolume.OnValueChanged += ChangeAudio;
            else if(WarningsEnabled)
                Debug.LogError("There is no linked >VoicesVolume< variable of type >FloatMinMax< in this settings system!");
            
            changeFunctionCallbacksLinked = true;
        }

        void UnLinkStandardSettingsFromOnChangeFunctions()
        {
            // Resolution
            if(Resolution != null)
            {
                if (isEditor)
                    Resolution.OnValueChanged -= () => { LogInfoForNotSetableInEditor(Resolution); };
                else
                    Resolution.OnValueChanged -= ChangeResolution;
            }

            // Fullscreen
            if(Fullscreen != null)
            {
                if (isEditor)
                    Fullscreen.OnValueChanged -= () => { LogInfoForNotSetableInEditor(Fullscreen); };
                else
                    Fullscreen.OnValueChanged -= ChangeResolution;
            }

            // Refresh rate
            if(UseTargetFrameRate && RefreshRate != null)
            {
                if (isEditor)
                    RefreshRate.OnValueChanged -= () => { LogInfoForNotSetableInEditor(RefreshRate); };
                else
                    RefreshRate.OnValueChanged -= ChangeResolution;
            }

            // Quality
            if(Quality != null)
                Quality.OnValueChanged -= ChangeQuality;

            // FRAVSM
            if(FRAVSM != null)
                FRAVSM.OnValueChanged -= ChangeFrameRateAndVSyncMode;

            // AAM
            // Done by camera script

            // Master Volume
            if (MasterVolume != null)
                MasterVolume.OnValueChanged -= ChangeAudio;

            // Music Volume
            if(MusicVolume != null)
                MusicVolume.OnValueChanged -= ChangeAudio;

            // Ambient Volume
            if (AmbientVolume != null)
                AmbientVolume.OnValueChanged -= ChangeAudio;

            // Fx Volume
            if(FxVolume != null)
                FxVolume.OnValueChanged -= ChangeAudio;

            // Ui Fx Volume
            if(UiFxVolume != null)
                UiFxVolume.OnValueChanged -= ChangeAudio;

            // Voices Volume
            if(VoicesVolume != null)
                VoicesVolume.OnValueChanged -= ChangeAudio;

            changeFunctionCallbacksLinked = false;
        }

        void LogInfoForNotSetableInEditor(HKIVar variable)
        {
            Debug.Log("Can't set this setting (" + variable.name + ") in the editor (only in a runtime build): " + variable.ToString());
        }

        // Set function
        void ChangeResolution()
        {
            if(Resolution == null || Fullscreen == null || isEditor)
                return;

            if(UseTargetFrameRate && RefreshRate != null)
                Screen.SetResolution(Resolution.Value.Width, Resolution.Value.Height, Fullscreen.Value, RefreshRate.Value);
            else
                Screen.SetResolution(Resolution.Value.Width, Resolution.Value.Height, Fullscreen.Value);
        }

        void ChangeQuality()
        {
            int qualityIndex = 0;

            string[] qualityNames = QualitySettings.names;
            for(int i = 0; i < qualityNames.Length; i++)
            {
                if(qualityNames[i] == Quality.Value)
                {
                    qualityIndex = i;
                    break;
                }
            }

            QualitySettings.SetQualityLevel(qualityIndex);
        }

        void ChangeFrameRateAndVSyncMode()
        {
            switch(FRAVSM.Value)
            {
                case FrameRateAndVSyncModes.VSyncOffTFDefault: ChangeFrameRateAndVSyncMode(-1, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF30: ChangeFrameRateAndVSyncMode(30, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF45: ChangeFrameRateAndVSyncMode(45, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF60: ChangeFrameRateAndVSyncMode(60, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF90: ChangeFrameRateAndVSyncMode(90, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF120: ChangeFrameRateAndVSyncMode(120, 0); break;

                case FrameRateAndVSyncModes.VSyncOffTF144: ChangeFrameRateAndVSyncMode(144, 0); break;

                case FrameRateAndVSyncModes.VsyncOnDefault: ChangeFrameRateAndVSyncMode(-1, 1); break;

                case FrameRateAndVSyncModes.VsyncOnHalfMFR: ChangeFrameRateAndVSyncMode(-1, 2); break;

                case FrameRateAndVSyncModes.VsyncOnThirdMFR: ChangeFrameRateAndVSyncMode(-1, 3); break;

                case FrameRateAndVSyncModes.VsyncOnQuaterMFR: ChangeFrameRateAndVSyncMode(-1, 4); break;

                default:
                    ChangeFrameRateAndVSyncMode(-1, 1);
                    break;
            }
        }

        void ChangeFrameRateAndVSyncMode(int fr, int vsync)
        {
            Application.targetFrameRate = fr;
            QualitySettings.vSyncCount = vsync;
        }

        void ChangeAudio()
        {
            if(AudioMixer == null)
                return;
            
            if (MasterVolume != null)
                AudioMixer.SetFloat("SetMasterVolume", MasterVolume.Value);

            if(MusicVolume != null)
                AudioMixer.SetFloat("SetMusicVolume", MusicVolume.Value);

            if (AmbientVolume != null)
                AudioMixer.SetFloat("SetAmbientVolume", AmbientVolume.Value);

            if(FxVolume != null)
                AudioMixer.SetFloat("SetFxVolume", FxVolume.Value);

            if(UiFxVolume != null)
                AudioMixer.SetFloat("SetUiFxVolume", UiFxVolume.Value);
            
            if(VoicesVolume != null)
                AudioMixer.SetFloat("SetVoicesVolume", VoicesVolume.Value);
        }
    }
}