additive scene manager bugfix with scene names and objects. FrameCount now can render to a specific TextMeshpro textbox. Prefabs for framecount now position the frame counters relative to the screen

Author: Ryan Kim

AdditiveSceneManager/AdditiveSceneManager.cs

@@ -7,61 +7,97 @@
 public class AdditiveSceneManager : MonoBehaviour
 {
 
+    [System.Serializable]
+    public class Ref
+    {
+        public string key;
+        public GameObject reference;
+    }
+
     // Global instance
     public static AdditiveSceneManager Instance;
 
     [Header("=== Scene Lists ===")]
     [Tooltip("List of additive scenes. These scenes must be added to \"Build Settings\" too.")]
+    #if UNITY_EDITOR
     public Object[] scenes;
-    public Dictionary<string, Object> sceneDict;
+    #endif
+    [HideInInspector] 
+    public List<string> scene_names;
+    private Dictionary<string, Object> sceneDict;
     private List<string> activeScenes = new List<string>();
 
+    [Header("=== Reference Management ===")]
+    public List<Ref> references = new List<Ref>();
+    private Dictionary<string, GameObject> refDict;
+
     [Header("=== Callbacks ===")]
     public UnityEvent onSceneLoadedCallback;
     public UnityEvent onSceneUnloadedCallback;
 
+    #if UNITY_EDITOR
+    private void OnValidate()
+    {
+        scene_names.Clear();
+        foreach (Object s in scenes) {
+            if (s != null) scene_names.Add(s.name);
+        }
+    }
+    #endif
+
     // Awake
     private void Awake() {
         Instance = this;
         InitializeScenes();
+        InitializeRefs();
     }
 
     private void InitializeScenes() {
         // Load listeners
         SceneManager.sceneLoaded += OnSceneLoaded;
         SceneManager.sceneUnloaded += OnSceneUnloaded;
-
         // Initialize arrays and dictionary
         activeScenes = new List<string>();
-        sceneDict = new Dictionary<string, Object>();
-        foreach(Object s in scenes) {
-            sceneDict.Add(s.name, s);
-        }
     }
 
-    // Add Scene from `scenes` to scene
-    public void LoadScene(string query, LoadSceneMode mode = LoadSceneMode.Additive) {
-        if(!sceneDict.ContainsKey(query)) {
+    private void InitializeRefs()
+    {
+        refDict = new Dictionary<string, GameObject>();
+        foreach(Ref r in references) refDict.Add(r.key, r.reference);
+    }
+
+    // Add Scene from `_scenes` to scene
+    public void LoadScene(string query, LoadSceneMode mode) {
+        if(!scene_names.Contains(query)) {
             Debug.LogError($"Query scene \"{query}\" doesn't exist in this scene manager!");
             return;
         }
         if (activeScenes.Contains(query)) {
             Debug.LogError($"Query scene \"{query}\" is already loaded additively. Will not add scene again.");
             return;
         }
-        SceneManager.LoadScene(sceneDict[query].name, mode);
+        SceneManager.LoadScene(query, mode);
+    }
+    public void LoadScene(string query) {
+        LoadScene(query, LoadSceneMode.Additive);
     }
 
     public void UnloadScene(string query) {
-        if (!sceneDict.ContainsKey(query)) {
+        if (!scene_names.Contains(query)) {
             Debug.LogError($"Query scene \"{query}\" doesn't exist in this scene manager!");
             return;
         }
         if (!activeScenes.Contains(query)) {
             Debug.LogError($"Query scene \"{query}\" is not loaded.");
             return;
         }
-        SceneManager.UnloadSceneAsync(sceneDict[query].name);
+        SceneManager.UnloadSceneAsync(query);
+    }
+
+    public void ToggleScene(string query)
+    {
+        if (activeScenes.Contains(query)) UnloadScene(query);
+        else LoadScene(query, LoadSceneMode.Additive);
     }
 
     public void OnSceneLoaded(Scene scene, LoadSceneMode mode) {
@@ -81,6 +117,13 @@ public bool QuerySceneLoaded(string query) {
         return activeScenes.Contains(query);
     }
 
+    public bool TryGetRef(string query, out GameObject g)
+    {
+        bool found = refDict.ContainsKey(query);
+        g = found ? refDict[query] : null;
+        return found;
+    }
+
     void OnDestroy() {
         SceneManager.sceneLoaded -= OnSceneLoaded;
         SceneManager.sceneUnloaded -= OnSceneUnloaded;

AdditiveSceneManager/Editor/AdditiveSceneManagerEditor.cs

@@ -18,22 +18,22 @@ public override void OnInspectorGUI() {
 
         // Render controls for each scene
         EditorGUILayout.LabelField("=== Scene Controls ===", EditorStyles.boldLabel);
-        foreach(Object s in manager.scenes) SceneButtons(s);
+        foreach(string s in manager.scene_names) SceneButtons(s);
     }
 
-    public void SceneButtons(Object s) {
+    public void SceneButtons(string s) {
 
         // Query if scene is active
-        bool sceneActive = manager.QuerySceneLoaded(s.name);
+        bool sceneActive = manager.QuerySceneLoaded(s);
 
         // Start a horizontal group for the buttons
         GUILayout.BeginHorizontal();
 
         GUI.enabled = !sceneActive;
-        if (GUILayout.Button($"Load \"{s.name}\"")) manager.LoadScene(s.name);
+        if (GUILayout.Button($"Load \"{s}\"")) manager.LoadScene(s);
         GUI.enabled = sceneActive;
         GUILayout.Space(5);
-        if (GUILayout.Button($"Unload \"{s.name}\"")) manager.UnloadScene(s.name);
+        if (GUILayout.Button($"Unload \"{s}\"")) manager.UnloadScene(s);
         GUI.enabled = true;
 
         // End the horizontal group

FrameCount/FrameCount.cs

@@ -1,11 +1,21 @@
 using System.Collections;
 using System.Collections.Generic;
 using UnityEngine;
+using TMPro;
 
 public class FrameCount : MonoBehaviour
 {
 
     public static FrameCount Instance;
+
+    public enum TextboxWriteType { FrameCount, FPS, SmoothFPS }
+
+    [System.Serializable]
+    public class Textbox
+    {
+        public TextMeshProUGUI textbox;
+        public TextboxWriteType write_type;
+    }
 
     [Header("=== Calculated (Read-Only) ===")]
     [Tooltip("The raw frame number of the current frame. Wil always increment from 0 at the start of the scene.")]
@@ -19,6 +29,8 @@ public class FrameCount : MonoBehaviour
     [Header("=== Settings ===")]
     [Range(0f,1f), Tooltip("The ratio for calculating the smoothed FPS. 1 = focus only on raw FPS on the current frame, 0 = focus only on the previous FPS of the previous frame.")]
     public float smoothed_ratio = 0.75f;
+    [Tooltip("Which textboxes should this write to?")]
+    public Textbox[] textboxes;
 
     // Outputs readable to other external scripts    
     public int frame_count => _frame_count;
@@ -34,6 +46,20 @@ private void Update() {
         _fps = 1f / Time.unscaledDeltaTime;
         _smoothed_fps = _prev_fps * (1f-smoothed_ratio) + _fps * smoothed_ratio;
         _prev_fps = _smoothed_fps;
+        foreach(Textbox t in textboxes) {
+            switch(t.write_type)
+            {
+                case TextboxWriteType.FrameCount:
+                    t.textbox.text = _frame_count.ToString();
+                    break;
+                case TextboxWriteType.FPS:
+                    t.textbox.text = _fps.ToString();
+                    break;
+                case TextboxWriteType.SmoothFPS:
+                    t.textbox.text = _smoothed_fps.ToString();
+                    break;
+            }
+        }
 
     }