Class ObjectPool

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

ObjectPool

Inherited Members

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

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

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

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

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

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

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

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsByType(System.Type, UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindFirstObjectByType<T>()

UnityEngine.Object.FindAnyObjectByType<T>()

UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindFirstObjectByType(System.Type)

UnityEngine.Object.FindAnyObjectByType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.FindFirstObjectByType(System.Type, UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType(System.Type, UnityEngine.FindObjectsInactive)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: GameKit.Dependencies.Utilities.ObjectPooling

Assembly: GameKit.Dependencies.dll

Syntax

public class ObjectPool : MonoBehaviour

Methods

__Reset(Boolean)

Destroys all stored and optionally retrieved objects. Race conditions may be created by this coroutine if trying to retrieve or store objects before it finishes executing.

Declaration

public IEnumerator __Reset(bool destroyActive)

Parameters

Type	Name	Description
System.Boolean	destroyActive	True to also destroy active retrieved gameObjects. False will erase active objects from memory, but not destroy them.

Returns

Type	Description
System.Collections.IEnumerator

Retrieve(GameObject)

Returns a pooled object of the specified prefab.

Declaration

public static GameObject Retrieve(GameObject poolObject)

Parameters

Type	Name	Description
UnityEngine.GameObject	poolObject	Prefab to retrieve.

Returns

Type	Description
UnityEngine.GameObject

Retrieve(GameObject, Transform, Boolean)

Returns a pooled object of the specified prefab.

Declaration

public static GameObject Retrieve(GameObject poolObject, Transform parent, bool instantiateInWorldSpace = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	poolObject	Prefab to retrieve.
UnityEngine.Transform	parent	Parent to attach the retrieved prefab to.
System.Boolean	instantiateInWorldSpace	Use true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent.

Returns

Type	Description
UnityEngine.GameObject

Retrieve(GameObject, Vector3, Quaternion)

Returns a pooled object of the specified prefab.

Declaration

public static GameObject Retrieve(GameObject poolObject, Vector3 position, Quaternion rotation)

Parameters

Type	Name	Description
UnityEngine.GameObject	poolObject	Prefab to retrieve.
UnityEngine.Vector3	position	Position for the retrieved object.
UnityEngine.Quaternion	rotation	Orientation for the retrieved object.

Returns

Type	Description
UnityEngine.GameObject

Retrieve(GameObject, Vector3, Quaternion, Transform)

Returns a pooled object of the specified prefab.

Declaration

public GameObject Retrieve(GameObject poolObject, Vector3 position, Quaternion rotation, Transform parent)

Parameters

Type	Name	Description
UnityEngine.GameObject	poolObject	Prefab to retrieve.
UnityEngine.Vector3	position	Position for the retrieved object.
UnityEngine.Quaternion	rotation	Orientation for the retrieved object.
UnityEngine.Transform	parent	Transform to parent the retrieved object to.

Returns

Type	Description
UnityEngine.GameObject

Retrieve<T>(GameObject)

Returns a pooled object of the specified prefab.

Declaration

public static T Retrieve<T>(GameObject prefab)

Parameters

Type	Name	Description
UnityEngine.GameObject	prefab	Prefab to retrieve.

Returns

Type	Description
T

Type Parameters

Name	Description
T

Retrieve<T>(GameObject, Transform, Boolean)

Returns a pooled object of the specified prefab.

Declaration

public static T Retrieve<T>(GameObject prefab, Transform parent, bool instantiateInWorldSpace = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	prefab	Prefab to retrieve.
UnityEngine.Transform	parent	Parent to attach the retrieved prefab to.
System.Boolean	instantiateInWorldSpace	Use true when assigning a parent Object to maintain the world position of the Object, instead of setting its position relative to the new parent. Pass false to set the Object's position relative to its new parent.

Returns

Type	Description
T

Type Parameters

Name	Description
T

Retrieve<T>(GameObject, Vector3, Quaternion)

Returns a pooled object of the specified prefab.

Declaration

public static T Retrieve<T>(GameObject prefab, Vector3 position, Quaternion rotation)

Parameters

Type	Name	Description
UnityEngine.GameObject	prefab	Prefab to retrieve.
UnityEngine.Vector3	position	Position for the retrieved object.
UnityEngine.Quaternion	rotation	Orientation for the retrieved object.

Returns

Type	Description
T

Type Parameters

Name	Description
T

Retrieve<T>(GameObject, Vector3, Quaternion, Transform)

Returns a pooled object of the specified prefab.

Declaration

public static T Retrieve<T>(GameObject prefab, Vector3 position, Quaternion rotation, Transform parent)

Parameters

Type	Name	Description
UnityEngine.GameObject	prefab	Prefab to retrieve.
UnityEngine.Vector3	position	Position for the retrieved object.
UnityEngine.Quaternion	rotation	Orientation for the retrieved object.
UnityEngine.Transform	parent	Transform to parent the retrieved object to.

Returns

Type	Description
T

Type Parameters

Name	Description
T

RetrieveInternal(GameObject, Transform, Boolean)

Declaration

public GameObject RetrieveInternal(GameObject poolObject, Transform parent, bool instantiateInWorldSpace = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	poolObject
UnityEngine.Transform	parent
System.Boolean	instantiateInWorldSpace

Returns

Type	Description
UnityEngine.GameObject

Store(GameObject, Boolean)

Returns an object to it's pool.

Declaration

public static void Store(GameObject instantiatedObject, bool parentPooler = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	instantiatedObject
System.Boolean	parentPooler	True to set the objects parent as the ObjectPooler.

Store(GameObject, Single, Boolean)

Returns an object to it's pool.

Declaration

public static void Store(GameObject instantiatedObject, float delay, bool parentPooler = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	instantiatedObject
System.Single	delay
System.Boolean	parentPooler	True to set the objects parent as the ObjectPooler.