Pool

Usages

How get object from pool

You can get object from pool via extension method Request

using Pancake;

[SerializeField] private GameObject prefab;

prefab.Request();

//request with set position
prefab.Request(Vector3.zero);

//request with return component
prefab.Request<Type Component>();

How return object to pool

You can return object to pool via extension method Return

using Pancake;

[SerializeField] private GameObject prefab;

var instance = prefab.Request();
instance.Return(); // return instance into pool

Prewarm pool

You can prewarm pool with Prewarm method

using Pancake.Pools;
using UnityEngine;

public sealed class AudioManager : MonoBehaviour
{
    [SerializeField] private GameObject prefab;
    [SerializeField] private int prewarmSize = 10;
	
    private void Awake()
    {
        prefab.Prewarm(prewarmSize);
    }
}

Use callbacks

When using the pool, we have two callbacks: callback when an object is removed from the pool and callback when an object is returned to the pool.

• OnRequest : callback when an object is take out the pool
• OnReturn : callback when an object is put back the pool

To implement these two callbacks we need to implement the IPoolCallbackReceiver interface

using Pancake.Pools;
using UnityEngine;

public class Enemy: MonoBehaviour, IPoolCallbackReceiver
{
	[SerializeField] private float maxHP = 100f;
	
	private float _currentHP = 0f;
	
	/// <summary>
	/// This method will be called before Awake
	/// </summary>
	public void OnRequest()
	{
		_currentHP = maxHP;
	}
		
	public void OnReturn()
	{
		// TO_DO
	}
}

Generic Pool

You can create generic class pool via using ObjectPool<>

public class PooledObject
{
}

private void Start()
{
    var pool = new ObjectPool<PooledObject>(createFunc: () => new PooledObject(), // provide object creation using a Func<T>
        onRequest: instance => { }, // actions on Request (optional)
        onReturn: instance => { }, // actions on Return  (optional)
        onDestroy: instance => { } // actions when the pool is destroyed (optional)
    );

    // Pre-warm the pool with objects
    pool.Prewarm(10);

    // Use Request() to retrieve an object, and Return() to return it to the pool
    var instance = pool.Request();
    pool.Return(instance);

    // Get the number of objects in the pool
    var count = pool.Count;

    // Clear all objects in the pool
    pool.Clear();

    // Dispose of the pool with Dispose()
    pool.Dispose();
}

Custom Pool

You can custom pool by inherit from class ObjectPoolBase

using Pancake.Pools;

public class PooledObject
{
}

public sealed class CustomObjectPool : ObjectPoolBase<PooledObject>
{
    protected override PooledObject CreateInstance() { return new PooledObject(); }

    protected override void OnDestroy(PooledObject instance)
    {
        // Add actions when the object is destroyed in Clear or Dispose
    }

    protected override void OnRequest(PooledObject instance)
    {
        // Add actions when requested
    }

    protected override void OnReturn(PooledObject instance)
    {
        // Add actions when returned
    }
}

private void Start()
{
   var pool = new CustomObjectPool();
   var pooledObject = pool.Request();
}