carrerasilvio / brightpoolsystem

Pool system in Unity. Create and manage your pools.

Bright Pool System

A pooling system that creates and manages access to your pool of objects.

Features

• Create pools when it's best for your project.
• Avoid garbage collection by resuing objects.
• Use Aquire and Release methods as your "Instantiate" and "Destroy" objects.
• Use events to notify other systems when objects are aquired and released.

Prerequisites

Unity 2018.3 and up

Install

Unity 2019.3

1. Open the package manager and point to the rep url

Before Unity 2019.3

Option A

1. Open the manifest

2. Add the repo url either via https or ssh

    {
    	"dependencies": {
    		"com.brightlib.poolsystem": "https://github.com/carreraSilvio/poolsystem.git"
    	}
    }
   

Option B

1. Clone or download the project zip
2. Copy the repo inside your project assets folder

Usage

Create Pools

Option A

1. Add PoolSystemInitializer behaviour
2. Edit the PoolConfig array by adding a string id and a poolable prefab
3. Run the game and you'll see the pool in your hierachy

Option B

public string poolableId;
public GameObject poolablePrefab;
public int poolSize;

void Awake()
{
    PoolSystem.CreatePool(poolableId, poolablePrefab, poolSize);
}

Fetch Available

private void Shoot()
{
    if (PoolSystem.TryFetchAvailable("Bullet", out PrefabPoolable bullet))
    {
        bullet.transform.position = transform.position;
    }
    else
    {
        Debug.Log("no more bullets available in pool");
    }
}

Listen to Events

void OnEnable()
{
    PoolSystem.AddListener("Bullet", PoolEvent.OnAquire, HandleBulletAquire);
}

private void HandleBulletAquire(string poolableName, int poolSize, int poolableInUse)
{
	Debug.Log("A bullet was aquired.");
}