https://github.com/capsize-games/gameobjectpool

Unity3D GameObject pool manager
https://github.com/capsize-games/gameobjectpool

Last synced: over 1 year ago
JSON representation

Unity3D GameObject pool manager

• Host: GitHub
• URL: https://github.com/capsize-games/gameobjectpool
• Owner: Capsize-Games
• License: mit
• Created: 2017-06-19T00:58:06.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-05-05T04:17:03.000Z (about 4 years ago)
• Last Synced: 2025-02-13T13:24:44.804Z (over 1 year ago)
• Language: C#
• Size: 7.32 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GameObjectPool

![Logo](https://user-images.githubusercontent.com/25737761/166617633-fc360248-09cd-49c9-80b4-dca6d281626d.png)

***Average runtime of 0.0001930632 seconds to spawn an object using `PoolManager` based on 5000 iterations.***

![alt text](Screenshots/example.gif)

Easily create and access pools of GameObjects to save on memory.

`GameObjectPool.Pool` extends `System.Collections.Generic.Queue` and takes

instructions in the form of `PoolSettings` objects.

## PoolSettings

- `Name` - the name of the pool

- `Prefab` - the prefab item that will fill the pool

- `Starting Item Count` - the number of items to initially create

- `Max Item Count` - the number of items to add to the pool before triggering an error message

- `Parent` - transform to parent pooled objects to

- `Allow Unrestricted Growth` - allow pool to continue populating itself with objects after max reached

## Using with a project

### Installation

1. [Get latest GameObjectPool.unitypackage release from Github](https://github.com/mdmnk/GameObjectPool/releases/latest)

2. Import package into project through menu in Unity `Assets > Import package > Custom Package...`

2. Uncheck example if you don't need it

3. Add ObjectPool project to your version control ignore file

### Scene setup

Assign `GameObjectPool.PoolManager` to a game object in your main scene

![alt text](Screenshots/objectpool_manager_inspector_1.png)

On that game object script set `Pool > Size` to a number greater than zero and a list of properties called "Element N" will show up

![alt text](Screenshots/objectpool_manager_inspector_size.png)

See `PoolSettings` in this file for information regarding the settings available

![image](https://user-images.githubusercontent.com/25737761/166725509-bea923b5-fb23-4039-ac37-bf88db16b431.png)

Clicking on the "Regenerate pool" button will cause the Pool Manager to regenerate (or generate if clicked the first time) the pools according to the settings in the Pool Manager. This allows you to generate GameObjects for the pool within the editor rather than at run-time.

**Note** Items will still be generated at run time if the pool does not have the minimum number of start items in it at run time.

#### Get an object from a pool

`GameObjectPool.PoolManager.Get("PoolName")`

#### Return an object to the pool

Use the standard MonoBehaviour method `SetActive(false)` on the game object you want to disable and it will return to its pool.

## Examples

See **Example > Scenes > Test** for sample usage involving shape spawning.