C# Class UnityPooler.PoolableGameObject

This class is a required component for any prefab that is to be pooled

Inheritance: UnityEngine.MonoBehaviour

Public Properties

Method	Description
AddToPool ( int numberToAdd ) : void	Adds 'numberToAdd' to the pool.
AmountInPool ( ) : int	Count of GameObjects currently in the pool.
Get ( ) : PoolableGameObject	Returns an object from the pool
IncrementPool ( ) : void	Adds one object to the pool
PopulatePool ( int numberToPopulate ) : void	Populates the pool up to 'numberToPopulate' will not add to the pool past that count.
Release ( ) : void	Releases an object back to the pool.
ReleaseObjectsAndClearPool ( ) : void

Method	Description
Awake ( ) : void
Clear ( ) : void	Completely resets the pool. Live objects are on their own but pooled objects will be destroyed.
Initialize ( ) : void
OnDestroy ( ) : void
ReleaseObjects ( ) : void
ReuseObject ( ) : PoolableGameObject
SceneTransitioning ( Scene from, Scene to ) : void
SendCreationMessage ( PoolableGameObject newObj ) : void

Adds 'numberToAdd' to the pool.

public AddToPool ( int numberToAdd ) : void
numberToAdd	int	Amount to add to the pool.
return	void

Count of GameObjects currently in the pool.

public AmountInPool ( ) : int
return	int

Returns an object from the pool

public Get ( ) : PoolableGameObject
return	PoolableGameObject

Adds one object to the pool

public IncrementPool ( ) : void
return	void

Populates the pool up to 'numberToPopulate' will not add to the pool past that count.

public PopulatePool ( int numberToPopulate ) : void
numberToPopulate	int	Amount to bring the pool up to.
return	void

Releases an object back to the pool.

public Release ( ) : void
return	void

public ReleaseObjectsAndClearPool ( ) : void
return	void

If there is a cap then what is that cap amount?

public int capAmount
return	int

Attach to be invoked when a new GameObject is created.

public static System.Action onObjectCreation
return	System.Action

Should the pooled objects persist across scenes? Otherwise the pool is torn down when the next scene is loaded.

public bool persistAcrossScenes
return	bool

If we persist across scenes then should all live objects be released back into the pool?

public bool releaseOnSceneTransition
return	bool

Is there a cap for this pool?

public bool useCap
return	bool