Merge pull request #9 from rithik-b/dev/save

Saving last leaderboard
rithik-b · Sep 28, 2022 · df1da21 · df1da21
2 parents b9ba3be + 499dcaa
commit df1da21
Show file tree

Hide file tree

Showing 10 changed files with 111 additions and 37 deletions.
diff --git a/LeaderboardCore/Configuration/PluginConfig.cs b/LeaderboardCore/Configuration/PluginConfig.cs
@@ -0,0 +1,20 @@
+#nullable enable
+using System;
+using System.Runtime.CompilerServices;
+using IPA.Config.Stores;
+
+[assembly: InternalsVisibleTo(GeneratedStore.AssemblyVisibilityTarget)]
+namespace LeaderboardCore.Configuration
+{
+    internal class PluginConfig : IDisposable
+    {
+        public string? LastLeaderboard { get; set; } = null;
+
+        public virtual void Changed() { }
+
+        public void Dispose()
+        {
+            Changed();
+        }
+    }
+}
diff --git a/LeaderboardCore/Installers/LeaderboardCoreMenuInstaller.cs b/LeaderboardCore/Installers/LeaderboardCoreMenuInstaller.cs
@@ -1,5 +1,6 @@
 using IPA.Loader;
 using LeaderboardCore.AffinityPatches;
+using LeaderboardCore.Configuration;
 using LeaderboardCore.UI.ViewControllers;
 using Zenject;
 using LeaderboardCore.Managers;
@@ -9,8 +10,16 @@ namespace LeaderboardCore.Installers
 {
     internal class LeaderboardCoreMenuInstaller : Installer
     {
+        private readonly PluginConfig pluginConfig;
+
+        public LeaderboardCoreMenuInstaller(PluginConfig pluginConfig)
+        {
+            this.pluginConfig = pluginConfig;
+        }
+
         public override void InstallBindings()
         {
+            Container.BindInterfacesAndSelfTo<PluginConfig>().FromInstance(pluginConfig);
             Container.BindInterfacesAndSelfTo<LeaderboardNavigationButtonsController>().FromNewComponentAsViewController().AsSingle();
             Container.BindInterfacesTo<LeaderboardCoreManager>().AsSingle();
             Container.BindInterfacesAndSelfTo<CustomLeaderboardManager>().AsSingle();

diff --git a/LeaderboardCore/Interfaces/INotifyCustomLeaderboardsChange.cs b/LeaderboardCore/Interfaces/INotifyCustomLeaderboardsChange.cs
@@ -5,7 +5,7 @@ namespace LeaderboardCore.Interfaces
 {
     internal interface INotifyCustomLeaderboardsChange
     {
-        public void OnLeaderboardsChanged(List<CustomLeaderboard> customLeaderboards);
+        public void OnLeaderboardsChanged(IEnumerable<CustomLeaderboard> orderedCustomLeaderboards, Dictionary<string, CustomLeaderboard> customLeaderboardsById);
 
     }
 }
diff --git a/LeaderboardCore/LeaderboardCore.xml b/LeaderboardCore/LeaderboardCore.xml
diff --git a/LeaderboardCore/Managers/CustomLeaderboardManager.cs b/LeaderboardCore/Managers/CustomLeaderboardManager.cs
@@ -1,6 +1,9 @@
 using LeaderboardCore.Interfaces;
 using LeaderboardCore.Models;
 using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Linq;
+using System.Reflection;
 
 namespace LeaderboardCore.Managers
 {
@@ -10,12 +13,12 @@ namespace LeaderboardCore.Managers
     public class CustomLeaderboardManager
     {
         private readonly List<INotifyCustomLeaderboardsChange> notifyCustomLeaderboardsChanges;
-        private readonly List<CustomLeaderboard> customLeaderboards;
+        private readonly Dictionary<string, CustomLeaderboard> customLeaderboardsById;
 
         internal CustomLeaderboardManager(List<INotifyCustomLeaderboardsChange> notifyCustomLeaderboardsChanges)
         {
             this.notifyCustomLeaderboardsChanges = notifyCustomLeaderboardsChanges;
-            customLeaderboards = new List<CustomLeaderboard>();
+            customLeaderboardsById = new Dictionary<string, CustomLeaderboard>();
         }
 
         /// <summary>
@@ -24,9 +27,14 @@ internal CustomLeaderboardManager(List<INotifyCustomLeaderboardsChange> notifyCu
         /// </summary>
         public void Register(CustomLeaderboard customLeaderboard)
         {
-            if (!customLeaderboards.Contains(customLeaderboard))
+            if (customLeaderboard.pluginId == null)
             {
-                customLeaderboards.Add(customLeaderboard);
+                customLeaderboard.pluginId = Assembly.GetCallingAssembly().GetName().Name;
+            }
+
+            if (!customLeaderboardsById.ContainsKey(customLeaderboard.LeaderboardId))
+            {
+                customLeaderboardsById[customLeaderboard.LeaderboardId] = customLeaderboard;
                 OnLeaderboardsChanged();
             }
         }
@@ -37,15 +45,15 @@ public void Register(CustomLeaderboard customLeaderboard)
         /// </summary>
         public void Unregister(CustomLeaderboard customLeaderboard)
         {
-            customLeaderboards.Remove(customLeaderboard);
+            customLeaderboardsById.Remove(customLeaderboard.LeaderboardId);
             OnLeaderboardsChanged();
         }
 
         private void OnLeaderboardsChanged()
         {
             foreach (var notifyCustomLeaderboardsChange in notifyCustomLeaderboardsChanges)
             {
-                notifyCustomLeaderboardsChange.OnLeaderboardsChanged(customLeaderboards);
+                notifyCustomLeaderboardsChange.OnLeaderboardsChanged(customLeaderboardsById.Values, customLeaderboardsById);
             }
         }
     }

diff --git a/LeaderboardCore/Models/CustomLeaderboard.cs b/LeaderboardCore/Models/CustomLeaderboard.cs
@@ -19,6 +19,16 @@ public abstract class CustomLeaderboard
         /// The ViewController for the leaderboard itself.
         /// </summary>
         protected abstract ViewController leaderboardViewController { get; }
+
+        /// <summary>
+        /// The ID for the leaderboard.
+        /// Must be a unique string if the mod has multiple leaderboards.
+        /// </summary>
+        protected virtual string leaderboardId { get; } = "";
+
+        internal string pluginId;
+
+        internal string LeaderboardId => $"{pluginId}{leaderboardId}";
 
         internal void Show(FloatingScreen panelScreen, Vector3 leaderboardPosition, PlatformLeaderboardViewController platformLeaderboardViewController)
         {

diff --git a/LeaderboardCore/Models/ScoreSaberCustomLeaderboard.cs b/LeaderboardCore/Models/ScoreSaberCustomLeaderboard.cs
@@ -1,4 +1,5 @@
-using LeaderboardCore.Interfaces;
+using System.Reflection;
+using LeaderboardCore.Interfaces;
 using UnityEngine;
 using Zenject;
 

diff --git a/LeaderboardCore/Plugin.cs b/LeaderboardCore/Plugin.cs
@@ -3,8 +3,11 @@
 using SiraUtil.Zenject;
 using System;
 using System.Reflection;
+using IPA.Config.Stores;
 using IPA.Loader;
+using LeaderboardCore.Configuration;
 using IPALogger = IPA.Logging.Logger;
+using IPAConfig = IPA.Config.Config;
 
 namespace LeaderboardCore
 {
@@ -27,11 +30,11 @@ public class Plugin
         /// Only use [Init] with one Constructor.
         /// </summary>
         [Init]
-        public Plugin(IPALogger logger, Zenjector zenjector)
+        public Plugin(IPALogger logger, Zenjector zenjector, IPAConfig config)
         {
             Instance = this;
             Log = logger;
-            zenjector.Install<LeaderboardCoreMenuInstaller>(Location.Menu);
+            zenjector.Install<LeaderboardCoreMenuInstaller>(Location.Menu, config.Generated<PluginConfig>());
         }
 
 

diff --git a/LeaderboardCore/UI/ViewControllers/LeaderboardNavigationButtonsController.cs b/LeaderboardCore/UI/ViewControllers/LeaderboardNavigationButtonsController.cs
@@ -6,6 +6,8 @@
 using LeaderboardCore.Models;
 using System;
 using System.Collections.Generic;
+using System.Reflection;
+using LeaderboardCore.Configuration;
 using UnityEngine;
 using Zenject;
 
@@ -17,6 +19,9 @@ internal class LeaderboardNavigationButtonsController : BSMLAutomaticViewControl
     {
         [Inject] 
         private readonly PlatformLeaderboardViewController platformLeaderboardViewController = null!;
+
+        [Inject]
+        private readonly PluginConfig pluginConfig = null!;
 
         [InjectOptional] 
         private readonly ScoreSaberCustomLeaderboard? scoreSaberCustomLeaderboard = null!;
@@ -30,10 +35,10 @@ internal class LeaderboardNavigationButtonsController : BSMLAutomaticViewControl
         private bool leaderboardLoaded;
         private IPreviewBeatmapLevel? selectedLevel;
 
-        private readonly List<CustomLeaderboard> customLeaderboards = new List<CustomLeaderboard>();
+        private readonly List<CustomLeaderboard> orderedCustomLeaderboards = new List<CustomLeaderboard>();
+        private readonly Dictionary<string, CustomLeaderboard> customLeaderboardsById = new Dictionary<string, CustomLeaderboard>();
         private int currentIndex;
-        private CustomLeaderboard? lastLeaderboard;
-
+
         public void Initialize()
         {
             buttonsFloatingScreen = FloatingScreen.CreateFloatingScreen(new Vector2(120f, 25f), false, Vector3.zero, Quaternion.identity);
@@ -102,7 +107,6 @@ public void OnLeaderboardSet(IDifficultyBeatmap difficultyBeatmap)
         public void OnLeaderboardLoaded(bool loaded)
         {
             leaderboardLoaded = loaded;
-            var lastLeaderboardIndex = customLeaderboards.IndexOf(lastLeaderboard!);
 
             if (!(selectedLevel is CustomPreviewBeatmapLevel))
             {
@@ -111,11 +115,11 @@ public void OnLeaderboardLoaded(bool loaded)
             else
             {
                 // If not loaded or leaderboard removed
-                if (!loaded || (lastLeaderboard != null && lastLeaderboardIndex == -1 && currentIndex != 0))
+                if (!loaded || (pluginConfig.LastLeaderboard != null && !customLeaderboardsById.ContainsKey(pluginConfig.LastLeaderboard) && currentIndex != 0))
                 {
                     SwitchToDefault();
                 }
-                else if (lastLeaderboard != null && lastLeaderboardIndex != -1 && currentIndex == 0)
+                else if (customLeaderboardsById.ContainsKey(pluginConfig.LastLeaderboard ?? "") && currentIndex == 0)
                 {
                     SwitchToLastLeaderboard();
                 }
@@ -131,19 +135,22 @@ public void OnLeaderboardLoaded(bool loaded)
 
         private void SwitchToDefault()
         {
-            lastLeaderboard?.Hide(customPanelFloatingScreen);
+            if (customLeaderboardsById.TryGetValue(pluginConfig.LastLeaderboard ?? "", out var lastLeaderboard))
+            {
+                lastLeaderboard.Hide(customPanelFloatingScreen);
+            }
             currentIndex = 0;
             UnYeetDefault();
         }
 
         private void SwitchToLastLeaderboard()
         {
-            if (lastLeaderboard != null)
+            if (customLeaderboardsById.TryGetValue(pluginConfig.LastLeaderboard ?? "", out var lastLeaderboard))
             {
-                var lastLeaderboardIndex = customLeaderboards.IndexOf(lastLeaderboard);
+                var lastLeaderboardIndex = orderedCustomLeaderboards.IndexOf(lastLeaderboard);
                 lastLeaderboard.Show(customPanelFloatingScreen, containerPosition, platformLeaderboardViewController);
                 currentIndex = lastLeaderboardIndex + 1;
-                YeetDefault();   
+                YeetDefault();             
             }
         }
 
@@ -168,22 +175,27 @@ private void UnYeetDefault()
         [UIAction("left-button-click")]
         private void LeftButtonClick()
         {
-            if (lastLeaderboard == null)
+            if (pluginConfig.LastLeaderboard == null)
             {
                 return;
             }
 
-            lastLeaderboard.Hide(customPanelFloatingScreen);
+            if (customLeaderboardsById.TryGetValue(pluginConfig.LastLeaderboard, out var outLastLeaderboard))
+            {
+                outLastLeaderboard.Hide(customPanelFloatingScreen);
+            }
+
             currentIndex--;
 
             if (currentIndex == 0)
             {
                 UnYeetDefault();
-                lastLeaderboard = null;
+                pluginConfig.LastLeaderboard = null;
             }
             else
             {
-                lastLeaderboard = customLeaderboards[currentIndex - 1];
+                var lastLeaderboard = orderedCustomLeaderboards[currentIndex - 1];
+                pluginConfig.LastLeaderboard = lastLeaderboard.LeaderboardId;
                 lastLeaderboard.Show(customPanelFloatingScreen, containerPosition, platformLeaderboardViewController);
             }
 
@@ -198,31 +210,36 @@ private void RightButtonClick()
             {
                 YeetDefault();
             }
-            else
+            else if (customLeaderboardsById.TryGetValue(pluginConfig.LastLeaderboard ?? "", out var outLastLeaderboard))
             {
-                lastLeaderboard?.Hide(customPanelFloatingScreen);
+                outLastLeaderboard?.Hide(customPanelFloatingScreen);
             }
 
             currentIndex++;
-            lastLeaderboard = customLeaderboards[currentIndex - 1];
+            var lastLeaderboard = orderedCustomLeaderboards[currentIndex - 1];
+            pluginConfig.LastLeaderboard = lastLeaderboard.LeaderboardId;
             lastLeaderboard.Show(customPanelFloatingScreen, containerPosition, platformLeaderboardViewController);
 
             NotifyPropertyChanged(nameof(LeftButtonActive));
             NotifyPropertyChanged(nameof(RightButtonActive));
         }
 
-        public void OnLeaderboardsChanged(List<CustomLeaderboard> customLeaderboards)
+        public void OnLeaderboardsChanged(IEnumerable<CustomLeaderboard> orderedCustomLeaderboards, Dictionary<string, CustomLeaderboard> customLeaderboardsById)
         {
-            this.customLeaderboards.Clear(); 
-            this.customLeaderboards.AddRange(customLeaderboards);
+            this.orderedCustomLeaderboards.Clear(); 
+            this.orderedCustomLeaderboards.AddRange(orderedCustomLeaderboards);
 
-            var lastLeaderboardIndex = customLeaderboards.IndexOf(lastLeaderboard!);
+            this.customLeaderboardsById.Clear();
+            foreach (var customLeaderboard in customLeaderboardsById)
+            {
+                this.customLeaderboardsById[customLeaderboard.Key] = customLeaderboard.Value;
+            }
 
-            if (lastLeaderboard != null && lastLeaderboardIndex == -1 && currentIndex != 0)
+            if (pluginConfig.LastLeaderboard != null && !customLeaderboardsById.ContainsKey(pluginConfig.LastLeaderboard) && currentIndex != 0)
             {
                 SwitchToDefault();
             }
-            else if (lastLeaderboard != null && lastLeaderboardIndex != -1 && currentIndex == 0)
+            else if (customLeaderboardsById.ContainsKey(pluginConfig.LastLeaderboard ?? "") && currentIndex == 0)
             {
                 SwitchToLastLeaderboard();
             }
@@ -239,8 +256,8 @@ public void OnLeaderboardsChanged(List<CustomLeaderboard> customLeaderboards)
         private bool LeftButtonActive => (currentIndex > 0 && (ShowDefaultLeaderboard || currentIndex > 1 )) && leaderboardLoaded && selectedLevel is CustomPreviewBeatmapLevel;
 
         [UIValue("right-button-active")]
-        private bool RightButtonActive => currentIndex < customLeaderboards.Count && leaderboardLoaded && selectedLevel is CustomPreviewBeatmapLevel;
+        private bool RightButtonActive => currentIndex < orderedCustomLeaderboards.Count && leaderboardLoaded && selectedLevel is CustomPreviewBeatmapLevel;
 
-        private bool ShowDefaultLeaderboard => scoreSaberCustomLeaderboard != null || !(selectedLevel is CustomPreviewBeatmapLevel) || customLeaderboards.Count == 0;
+        private bool ShowDefaultLeaderboard => scoreSaberCustomLeaderboard != null || !(selectedLevel is CustomPreviewBeatmapLevel) || orderedCustomLeaderboards.Count == 0;
     }
 }
diff --git a/LeaderboardCore/manifest.json b/LeaderboardCore/manifest.json
@@ -3,7 +3,7 @@
     "id": "LeaderboardCore",
     "name": "LeaderboardCore",
     "author": "PixelBoom & PulseLane",
-    "version": "1.2.3",
+    "version": "1.3.0",
     "description": "A utility for custom leaderboards to attach themselves in Beat Saber.",
     "gameVersion": "1.20.0",
     "dependsOn": {