using UnityEngine; namespace Crosstales.Common.Util { /// Base-class for all singletons. public abstract class Singleton : MonoBehaviour where T : Singleton { #region Variables [Tooltip("Don't destroy gameobject during scene switches (default: false)."), SerializeField] private bool dontDestroy = true; /// Fully qualified prefab path. public static string PrefabPath; protected static T instance; private static readonly object lockObj = new object(); #endregion #region Properties /// Returns the singleton instance of this class. /// Singleton instance of this class. public static T Instance { get { if (SingletonHelper.isQuitting) { //Debug.LogWarning($"[Singleton] Instance '{typeof(T)}' already destroyed. Returning null."); return instance; } if (instance == null) CreateInstance(); //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' GET: {instance.GetInstanceID()}"); return instance; } protected set { lock (lockObj) { //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' SET: {value?.GetInstanceID()}"); instance = value; } } } /// Don't destroy gameobject during scene switches. public bool DontDestroy { get => dontDestroy; set => dontDestroy = value; } #endregion #region MonoBehaviour methods protected virtual void Awake() { //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' AWAKE: {activeInstance.GetInstanceID()}"); Util.BaseHelper.ApplicationIsPlaying = Application.isPlaying; //needed to enforce the right mode //isQuitting = false; if (instance == null) { Instance = GetComponent(); if (!Util.BaseHelper.isEditorMode && dontDestroy) DontDestroyOnLoad(transform.root.gameObject); } else { if (!Util.BaseHelper.isEditorMode && dontDestroy && instance != this) { Debug.LogWarning($"Only one active instance of '{typeof(T).Name}' allowed in all scenes!{System.Environment.NewLine}This object will now be destroyed.", this); Destroy(gameObject, 0.1f); } } } protected virtual void OnDestroy() { if (instance == this) { //SingletonHelper.isQuitting = !BaseHelper.isEditorMode; SingletonHelper.isQuitting = true; //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' ONDESTROY: {instance.GetInstanceID()}"); if (!dontDestroy) Instance = null; //DeleteInstance(); } } protected virtual void OnApplicationQuit() { SingletonHelper.isQuitting = true; Util.BaseHelper.ApplicationIsPlaying = false; } #endregion /// Creates an instance of this object. /// Search for existing GameObjects of this object (default: true, optional) /// Delete existing instance of this object (default: false, optional) public static void CreateInstance(bool searchExistingGameObject = true, bool deleteExistingInstance = false) { if (deleteExistingInstance) DeleteInstance(); if (instance == null) { // Search for existing instance. if (searchExistingGameObject) Instance = (T)FindObjectOfType(typeof(T)); // Create new instance if one doesn't already exist. if (instance == null) { if (!string.IsNullOrEmpty(PrefabPath)) { T prefab = Resources.Load(PrefabPath); if (prefab == null) { Debug.LogWarning("Singleton prefab missing: " + PrefabPath); } else { Instance = Instantiate(prefab); //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' CREATE Prefab: {instance.GetInstanceID()}"); } } if (instance == null) { if (BaseHelper.isEditorMode) { #if UNITY_EDITOR //instanceEditor = UnityEditor.EditorUtility.CreateGameObjectWithHideFlags($"{typeof(T).Name} (Hidden Singleton)", HideFlags.DontSaveInBuild | HideFlags.HideInHierarchy).AddComponent(); Instance = new GameObject($"{typeof(T).Name} (Singleton)").AddComponent(); #endif //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' CREATE Editor: {instance.GetInstanceID()} - {BaseHelper.isEditorMode}"); } else { Instance = new GameObject($"{typeof(T).Name} (Singleton)").AddComponent(); //Debug.LogWarning($"{Time.realtimeSinceStartup}-[Singleton] Instance '{typeof(T)}' CREATE Play: {instance.GetInstanceID()} - {BaseHelper.isEditorMode}"); } } } } } /// Deletes the instance of this object. public static void DeleteInstance() { if (instance != null) { T _instance = instance; Instance = null; Destroy(_instance.gameObject); } } } /// Helper-class for singletons. #if UNITY_EDITOR [UnityEditor.InitializeOnLoad] #endif public class SingletonHelper { #if UNITY_EDITOR private const string key = "CT_SINGLETON_ISQUITTING"; private static bool quitting; private static bool isQuittingSet; public static bool isQuitting { get { if (!isQuittingSet) { isQuittingSet = true; quitting = UnityEditor.BuildPipeline.isBuildingPlayer || Crosstales.Common.Util.CTPlayerPrefs.GetBool(key); } return quitting; } set { //Debug.Log("SET isQuitting: " + value); if (value != quitting) { quitting = value; Crosstales.Common.Util.CTPlayerPrefs.SetBool(key, value); Crosstales.Common.Util.CTPlayerPrefs.Save(); } } } #else public static bool isQuitting { get; set; } #endif private static bool isInitialized; #region Constructor static SingletonHelper() { //Debug.Log($"{Time.realtimeSinceStartup} - Constructor!"); initialize(); } #endregion [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)] private static void initialize() { if (isInitialized) { //Debug.Log($"{Time.realtimeSinceStartup} - already initialized!"); } else { //Debug.Log($"{Time.realtimeSinceStartup} - initialize: {isQuitting}"); isInitialized = true; UnityEngine.SceneManagement.SceneManager.sceneLoaded += onSceneLoaded; UnityEngine.SceneManagement.SceneManager.sceneUnloaded += onSceneUnloaded; Application.quitting += onQuitting; //Application.wantsToQuit += onWantsToQuit; #if UNITY_EDITOR UnityEditor.EditorApplication.playModeStateChanged += onPlayModeStateChanged; UnityEditor.SceneManagement.EditorSceneManager.sceneClosing += onSceneClosing; //UnityEditor.SceneManagement.EditorSceneManager.sceneOpening += onSceneOpening; UnityEditor.SceneManagement.EditorSceneManager.sceneOpened += onSceneOpened; #endif } } #if UNITY_EDITOR private static void onSceneOpened(UnityEngine.SceneManagement.Scene scene, UnityEditor.SceneManagement.OpenSceneMode mode) { //Debug.Log($"{Time.realtimeSinceStartup} - onSceneOpened"); isQuitting = false; } /* private static void onSceneOpening(string path, UnityEditor.SceneManagement.OpenSceneMode mode) { Debug.Log($"{Time.realtimeSinceStartup} - onSceneOpening"); isQuitting = false; } */ private static void onSceneClosing(UnityEngine.SceneManagement.Scene scene, bool removingscene) { //Debug.Log($"{Time.realtimeSinceStartup} - onSceneClosing"); isQuitting = true; } private static void onPlayModeStateChanged(UnityEditor.PlayModeStateChange obj) { isQuitting = obj == UnityEditor.PlayModeStateChange.ExitingEditMode || obj == UnityEditor.PlayModeStateChange.ExitingPlayMode; //Debug.LogWarning($"{Time.realtimeSinceStartup} - onPlayModeStateChanged: {obj} - {isQuitting}"); } #endif /* private static bool onWantsToQuit() { Debug.Log($"{Time.realtimeSinceStartup} - onWantsToQuit"); isQuitting = true; return true; } */ private static void onQuitting() { //Debug.Log($"{Time.realtimeSinceStartup} - onQuitting"); isQuitting = true; } private static void onSceneLoaded(UnityEngine.SceneManagement.Scene scene, UnityEngine.SceneManagement.LoadSceneMode mode) { //Debug.Log($"{Time.realtimeSinceStartup} - onSceneLoaded"); isQuitting = false; Util.BaseHelper.ApplicationIsPlaying = true; } private static void onSceneUnloaded(UnityEngine.SceneManagement.Scene scene) { //Debug.Log($"{Time.realtimeSinceStartup} - onSceneUnloaded"); isQuitting = true; Util.BaseHelper.ApplicationIsPlaying = false; } } } // © 2020 crosstales LLC (https://www.crosstales.com)