Class Singleton<T>

Namespace

Gamelogic.Extensions

Assembly

Gamelogic.Extensions.dll

Provides a generic implementation of a singleton-like pattern for MonoBehaviour classes. This class automatically searches for an existing instance in the scene or logs an error if none or more than one are found.

[Version(1, 0, 0)]
public class Singleton<T> : GLMonoBehaviour where T : MonoBehaviour

Type Parameters

T

The type of the Singleton class derived from MonoBehaviour.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

GLMonoBehaviour

Singleton<T>

Derived

ScreenshotTaker

Inherited Members

GLMonoBehaviour.Instantiate<T>(T)

GLMonoBehaviour.Instantiate<T>(T, Vector3, Quaternion)

GLMonoBehaviour.Instantiate<T>(T, GameObject)

GLMonoBehaviour.Instantiate<T>(T, GameObject, Vector3, Quaternion)

GLMonoBehaviour.Instantiate(GameObject)

GLMonoBehaviour.Instantiate(GameObject, Vector3, Quaternion)

GLMonoBehaviour.Instantiate(GameObject, GameObject)

GLMonoBehaviour.Instantiate(GameObject, GameObject, Vector3, Quaternion)

GLMonoBehaviour.FindObjectsOfInterface<TInterface>()

GLMonoBehaviour.FindRequiredObjectOfType<T>()

GLMonoBehaviour.Invoke(Action, float)

GLMonoBehaviour.InvokeRepeating(Action, float, float)

GLMonoBehaviour.InvokeRepeating(Action, IGenerator<float>)

GLMonoBehaviour.Tween<T>(T, T, float, Func<T, T, float, T>, Action<T>, Func<float>)

GLMonoBehaviour.Tween<T>(T, T, float, Func<T, T, float, T>, Action<T>)

GLMonoBehaviour.GetRequiredComponent<T>()

GLMonoBehaviour.GetRequiredComponentInChildren<T>()

GLMonoBehaviour.DestroyUniversal(Object)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

MonoBehaviourExtensions.Clone<T>(T)

MonoBehaviourExtensions.Clone<T>(T, int)

ThrowHelper.ThrowIfNull(object, string)

MonoBehaviourExtensions.FindChild(Component, string)

MonoBehaviourExtensions.FindChild(Component, string, bool)

MonoBehaviourExtensions.GetComponentInChildrenAlways<T>(Component)

MonoBehaviourExtensions.GetComponentsInChildrenAlways<T>(Component)

MonoBehaviourExtensions.GetInterfaceComponent<TInterface>(Component)

MonoBehaviourExtensions.GetRequiredComponentInChildren<T>(Component)

MonoBehaviourExtensions.GetRequiredComponent<T>(Component)

MonoBehaviourExtensions.CancelInvoke(MonoBehaviour, Action)

MonoBehaviourExtensions.Invoke(MonoBehaviour, Action, float)

MonoBehaviourExtensions.InvokeRepeating(MonoBehaviour, Action, IGenerator<float>)

MonoBehaviourExtensions.InvokeRepeating(MonoBehaviour, Action, float, float)

MonoBehaviourExtensions.IsInvoking(MonoBehaviour, Action)

MonoBehaviourExtensions.Tween<T>(MonoBehaviour, T, T, float, Func<T, T, float, T>, Action<T>)

MonoBehaviourExtensions.Tween<T>(MonoBehaviour, T, T, float, Func<T, T, float, T>, Action<T>, Func<float>)

Remarks

Singletons usually manage their own creation, but it is common in Unity projects to have a singleton already placed in the scene. In this sense, this class really checks whether an instance can be used as a singleton, and then provides access to the instance.

If you want to create a singleton that is not already placed in the scene, you can use put
<xref href="Gamelogic.Extensions.SingletonSpawner%601" data-throw-if-not-resolved="false"></xref> in the scene instead.

Fields

instance

Properties

HasInstanceInOpenScenes

Gets a value indicating whether this singleton has a unique instance in open scenes.

Instance

Returns the instance of this singleton.

IsReady

Gets a value indicating whether this singleton is ready, that is, a unique instance is available in the scene.

Methods

FindAndConnectInstance()

Finds an instance of the given type in the open scenes and assign it to the instance field of the Singleton<T>.

OnDestroy()