Replaced playerlist style pref with Enum pref, added fallback to ensure playerlist button will always appear, fixed initial currentPageBTK being set to MainPage instead of CVRMainQM.

Author: ddakebono

BTKUILib.cs

@@ -13,7 +13,7 @@ internal static class BuildInfo
         public const string Name = "BTKUILib";
         public const string Author = "BTK Development Team";
         public const string Company = "BTK Development";
-        public const string Version = "2.2.0";
+        public const string Version = "2.2.1";
     }
 
     internal class BTKUILib : MelonMod
@@ -26,14 +26,14 @@ internal class BTKUILib : MelonMod
         internal UserInterface UI;
         internal Queue<Action> MainThreadQueue = new();
         internal Dictionary<string, Page> MLPrefsPages = new();
-        internal MelonPreferences_Entry<string> PlayerListStyle;
+        internal MelonPreferences_Entry<PlayerListStyleEnum> PlayerListStyle;
 
         private MelonPreferences_Entry<bool> _displayPrefsTab;
 
         private Thread _mainThread;
         private Page _mlPrefsPage;
         private MultiSelection _playerListButtonStyle;
-        private string[] _playerListOptions = { "Tab Bar", "Right Bar", "Replace Events" };
+        private string[] _playerListStyleNames;
 
         public override void OnInitializeMelon()
         {
@@ -51,7 +51,7 @@ public override void OnInitializeMelon()
                     _mlPrefsPage.HideTab = b1;
             });
 
-            PlayerListStyle = MelonPreferences.CreateEntry("BTKUILib", "PlayerListPosition", "Tab Bar", "PlayerList Button Position", "Sets where the playerlist button will appear");
+            PlayerListStyle = MelonPreferences.CreateEntry("BTKUILib", "PlayerListStyleNew", PlayerListStyleEnum.TabBar, "PlayerList Button Style", "Sets where the playerlist button will appear");
 
             Patches.Initialize(HarmonyInstance);
 
@@ -74,6 +74,7 @@ internal void GenerateSettingsPage()
             prefsTabDisplay.OnValueUpdated += b =>
             {
                 _displayPrefsTab.Value = b;
+                MelonPreferences.Save();
             };
 
             var openListStyle = mainCat.AddButton("Playerlist Button Position", "BTKList", "Change the position of the playerlist button");
@@ -82,11 +83,16 @@ internal void GenerateSettingsPage()
                 QuickMenuAPI.OpenMultiSelect(_playerListButtonStyle);
             };
 
-            _playerListButtonStyle = new MultiSelection("PlayerList Button Position", _playerListOptions, Array.FindIndex(_playerListOptions, x => x.Contains(PlayerListStyle.Value)));
+            _playerListStyleNames = Enum.GetNames(typeof(PlayerListStyleEnum));
+
+            _playerListButtonStyle = new MultiSelection("PlayerList Button Position", _playerListStyleNames, (int)PlayerListStyle.Value);
             _playerListButtonStyle.OnOptionUpdated += i =>
             {
+                if(!Enum.IsDefined(typeof(PlayerListStyleEnum), i)) return;
+
                 QuickMenuAPI.ShowAlertToast("You must restart ChilloutVR for this change to apply!");
-                PlayerListStyle.Value = _playerListOptions[i];
+                PlayerListStyle.Value = (PlayerListStyleEnum)Enum.Parse(typeof(PlayerListStyleEnum), Enum.GetNames(typeof(PlayerListStyleEnum))[i]);
+                MelonPreferences.Save();
             };
         }
 
@@ -154,4 +160,23 @@ public override void OnUpdate()
             }
         }
     }
+
+    /// <summary>
+    /// Enum containing the usable styles of playerlist button
+    /// </summary>
+    public enum PlayerListStyleEnum
+    {
+        /// <summary>
+        /// Default style, button appears on the tab bar
+        /// </summary>
+        TabBar,
+        /// <summary>
+        /// Button replaces the existing TTS button on the right sidebar
+        /// </summary>
+        ReplaceTTS,
+        /// <summary>
+        /// Button replaces the unused events button on the QM
+        /// </summary>
+        ReplaceEvents,
+    }
 }

CohtmlUI/mod.js

@@ -56,8 +56,8 @@ cvr.menu.prototype.BTKUI = {
     register: function(menu){
         uiRefBTK = menu;
         breadcrumbsBTK = [];
-        currentPageBTK = "MainPage";
-        currentMod = "BTKUI";
+        currentPageBTK = "CVRMainQM";
+        currentMod = "CVR";
         currentDraggedSliderBTK = {};
         currentSliderBarBTK = {};
         currentSliderKnobBTK = {};
@@ -363,42 +363,20 @@ cvr.menu.prototype.BTKUI = {
         cvr("#btkUI-UserMenu").show();
         cvr("#btkUI-SharedRoot").show();
 
-        if(plButtonStyle !== "Tab Bar"){
-            let tabCont = document.getElementById("btkUI-TabContainer");
-            if(tabCont !== null)
-                tabCont.classList.remove("container-tabs-left")
-            let scrollCont = document.getElementById("btkUI-TabScroll-Container");
-            if(scrollCont !== null)
-                scrollCont.classList.remove("scroll-bg-left");
-            cvr("#btkUI-UserMenu").hide();
-        }
+        let tabBarMode = false;
 
         switch(plButtonStyle){
-            case "Replace TTS":
-            case "Right Bar":
+            case "ReplaceTTS":
                 cvr("#btkUI-UserMenuRightBar").show();
-                /*let ttsElement = document.getElementsByClassName("button-tts");
+                let ttsElement = document.getElementsByClassName("button-tts");
 
-                if(ttsElement.length === 0){
-                    console.error("Couldn't find TTS element! Unable to replace!");
+                if(ttsElement.length === 0)
                     return;
-                }
 
                 ttsElement = ttsElement[0];
-
-                ttsElement.classList.add("icon-multiuser");
-                ttsElement.style.backgroundImage = "url(mods/BTKUI/images/Multiuser.png)";
-                ttsElement.style.backgroundSize = "contain";
-                ttsElement.style.backgroundPositionY = "0";
-                ttsElement.style.backgroundPositionX = "0";
-
-                ttsElement.removeEventListener("click", uiRefBTK.actions["openTTSKeyboard"]);
-                ttsElement.addEventListener("click", uiRefBTK.actions["btkUI-pushPage"]);
-                ttsElement.setAttribute("data-x", "btkUI-pushPage");
-                ttsElement.setAttribute("data-page", "btkUI-PlayerList");
-                ttsElement.setAttribute("data-tooltip", "Opens the UILib PlayerList");*/
+                ttsElement.classList.add("hidden");
                 break;
-            case "Replace Events":
+            case "ReplaceEvents":
                 let eventButton = document.getElementsByClassName("events");
 
                 if(eventButton.length === 0){
@@ -426,6 +404,19 @@ cvr.menu.prototype.BTKUI = {
                 let label = eventButton.querySelector('.label');
                 label.innerHTML = "Playerlist";
                 break;
+            default:
+                tabBarMode = true;
+                break;
+        }
+
+        if(plButtonStyle !== "TabBar" && !tabBarMode){
+            let tabCont = document.getElementById("btkUI-TabContainer");
+            if(tabCont !== null)
+                tabCont.classList.remove("container-tabs-left")
+            let scrollCont = document.getElementById("btkUI-TabScroll-Container");
+            if(scrollCont !== null)
+                scrollCont.classList.remove("scroll-bg-left");
+            cvr("#btkUI-UserMenu").hide();
         }
     },
 
@@ -848,6 +839,7 @@ cvr.menu.prototype.BTKUI = {
         }
     },
     btkOpenMultiSelect: function(name, options, selectedIndex, playerListMode = false){
+        btkMultiSelectPLMode = playerListMode;
         let element = cvr("#btkUI-Dropdown-OptionRoot");
         if(playerListMode)
             element = cvr("#btkUI-DropdownPL-OptionRoot");

UserInterface.cs

@@ -121,7 +121,7 @@ private void OnMenuIsLoaded()
             foreach(var css in CustomCSSStyles)
                 UIUtils.GetInternalView().TriggerEvent("btkSetCustomCSS", css);
 
-            UIUtils.GetInternalView().TriggerEvent("btkModInit", BTKUILib.Instance.PlayerListStyle.Value);
+            UIUtils.GetInternalView().TriggerEvent("btkModInit", Enum.GetName(typeof(PlayerListStyleEnum), BTKUILib.Instance.PlayerListStyle.Value));
 
             //Run the ml prefs tab generation
             BTKUILib.Instance.GenerateMlPrefsTab();