DCLPlayerPrefs.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Unity.Multiplayer.PlayMode;
#if UNITY_EDITOR
using UnityEditor;
#endif
using UnityEngine;

namespace DCL.Prefs
{
    /// <summary>
    /// A wrapper based on UnityEngine.PlayerPrefs for storing preferences / settings.
    /// </summary>
    public static class DCLPlayerPrefs
    {
        private const string VECTOR2_KEY_FORMAT = "{0}_{1}";

        private static IDCLPrefs dclPrefs;

        [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
        public static void Initialize()
        {
            IReadOnlyList<string> playmodeTags = CurrentPlayer.Tags;
            Initialize(playmodeTags.Contains("PrefsInMemory"));
        }

        public static void SetString(string key, string value, bool save = false)
        {
            dclPrefs.SetString(key, value);

            if (save)
                Save();
        }

        public static void SetInt(string key, int value, bool save = false)
        {
            dclPrefs.SetInt(key, value);

            if (save)
                Save();
        }

        public static void SetVector2Int(string key, Vector2Int value, bool save = false)
        {
            dclPrefs.SetInt(string.Format(VECTOR2_KEY_FORMAT, "X", key), value.x);
            dclPrefs.SetInt(string.Format(VECTOR2_KEY_FORMAT, "Y", key), value.y);

            if(save)
                Save();
        }

        public static void SetFloat(string key, float value, bool save = false)
        {
            dclPrefs.SetFloat(key, value);

            if (save)
                Save();
        }

        public static string GetString(string key, string defaultValue = "") =>
            dclPrefs.GetString(key, defaultValue);

        public static int GetInt(string key, int defaultValue = 0) =>
            dclPrefs.GetInt(key, defaultValue);

        public static float GetFloat(string key, float defaultValue = 0f) =>
            dclPrefs.GetFloat(key, defaultValue);

        public static Vector2Int GetVector2Int(string key, Vector2Int defaultValue)
        {
            int x = dclPrefs.GetInt(string.Format(VECTOR2_KEY_FORMAT, "X", key), defaultValue.x);
            int y = dclPrefs.GetInt(string.Format(VECTOR2_KEY_FORMAT, "Y", key), defaultValue.y);
            return new Vector2Int(x, y);
        }

        public static bool HasKey(string key) =>
            dclPrefs.HasKey(key);

        public static bool HasVectorKey(string key) =>
            dclPrefs.HasKey(string.Format(VECTOR2_KEY_FORMAT, "X", key));

        public static void DeleteKey(string key, bool save = false)
        {
            dclPrefs.DeleteKey(key);

            if (save)
                Save();
        }

        public static void DeleteVector2Key(string key)
        {
            dclPrefs.DeleteKey(string.Format(VECTOR2_KEY_FORMAT, "X", key));
            dclPrefs.DeleteKey(string.Format(VECTOR2_KEY_FORMAT, "Y", key));
        }

        public static void SetBool(string key, bool value, bool save = false)
        {
            dclPrefs.SetBool(key, value);

            if (save)
                Save();
        }

        public static bool GetBool(string key, bool defaultValue = false) =>
            dclPrefs.GetBool(key, defaultValue);

        public static void DeleteAll() =>
            dclPrefs.DeleteAll();

        public static void Save() =>
            dclPrefs.Save();

        /// <summary>
        /// Synchronous save that blocks until data is written to disk.
        /// Use in OnApplicationQuit or other shutdown paths where async save may not complete.
        /// </summary>
        public static void SaveSync() =>
            dclPrefs.SaveSync();

        private static void Initialize(bool inMemory)
        {
            if (dclPrefs != null)
                throw new InvalidOperationException("DCLPrefs already initialized.");

            dclPrefs = inMemory ? new InMemoryDCLPlayerPrefs() : new FileDCLPlayerPrefs();
            // ExitUtils lives in Utility which already depends on DCL.Prefs (via PersistentSetting), so subscribe directly here
            Application.quitting += OnQuitting;
        }

        private static void OnQuitting()
        {
            Application.quitting -= OnQuitting;

            System.Diagnostics.Stopwatch stopwatch = System.Diagnostics.Stopwatch.StartNew();
            (dclPrefs as IDisposable)?.Dispose();
            dclPrefs = null;
            Debug.Log($"[ExitUtils] [DCLPlayerPrefs] cleanup took {stopwatch.ElapsedMilliseconds}ms");
        }

#if UNITY_EDITOR
        [MenuItem("Edit/Clear All DCLPlayerPrefs", priority = 280)]
        private static void ClearDCLPlayerPrefs()
        {
            string[] files = Directory.GetFiles(Application.persistentDataPath, "userdata_*");

            foreach (string file in files)
                File.Delete(file);
        }

        [MenuItem("Edit/Clear All DCLPlayerPrefs", validate = true)]
        private static bool ValidateClearDCLPlayerPrefs() =>
            !Application.isPlaying;

        [MenuItem("Decentraland/PlayerPrefs/Reset Nearby Voice Intro Tip")]
        private static void ResetNearbyVoiceIntroTip()
        {
            DeleteKey(DCLPrefKeys.NEARBY_VOICE_TIP_DISMISSED, save: true);
            Debug.Log("Nearby Voice Intro Tip has been reset.");
        }
#endif
    }
}