Class SwiftGameObjectPoolAsset

Namespace

SwiftCollections.Pool

A ScriptableObject that manages multiple SwiftGameObjectPool instances.

[CreateAssetMenu(menuName = "SwiftCollections/SwiftGameObjectPoolAsset", fileName = "SwiftGameObjectPoolAsset")]
public class SwiftGameObjectPoolAsset : ScriptableObject, IDisposable

Inheritance

object

Object

ScriptableObject

SwiftGameObjectPoolAsset

Implements

IDisposable

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.MemberwiseClone()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

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

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

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

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.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SwiftGameObjectPoolAsset(SwiftGameObjectPool[])

Initializes an asset with the supplied pool definitions.

public SwiftGameObjectPoolAsset(SwiftGameObjectPool[] pools)

Parameters

pools SwiftGameObjectPool[]

The pool definitions managed by the asset.

Properties

ParentTransform

Gets the persistent root transform created by Init().

public Transform ParentTransform { get; }

Property Value

Transform

Methods

Dispose()

Disposes all pools and their resources.

public void Dispose()

GetObject(string)

Gets an object from the specified pool by ID.

public GameObject GetObject(string id)

Parameters

id string

The pool name.

Returns

GameObject

A pooled GameObject instance.

Exceptions

ArgumentException

id is null, empty, or whitespace.

InvalidOperationException

The pool configuration is invalid, the pool is missing, or it is exhausted.

Init()

Initializes the object pool asset, creating the parent transform and prewarming pools as needed.

public void Init()

Exceptions

InvalidOperationException

The pool definitions are missing, invalid, or contain duplicate names.

ReleaseObject(string, GameObject)

Releases an object back into the specified pool.

public void ReleaseObject(string id, GameObject gameObject)

Parameters

id string

The pool name.

gameObject GameObject

The pooled instance to release.

Exceptions

ArgumentException

id is null, empty, or whitespace.

ArgumentNullException

gameObject is null.

InvalidOperationException

The pool is missing, invalid, or does not own the instance.

TryGetObject(string, out GameObject)

Attempts to get an object from the specified pool by ID without throwing when the pool is missing or exhausted.

public bool TryGetObject(string id, out GameObject gameObject)

Parameters

id string

The pool name.

gameObject GameObject

The pooled GameObject instance when successful.

Returns

bool

true when an object was acquired; otherwise false.

Exceptions

InvalidOperationException

The pool configuration is invalid.