Click or drag to resize

PoolGroup Class

A PoolGroup represents a collection of Pools grouped by name. Can be used to group together pools of different types and components, or configure them together.
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Kit.PoolingPoolGroup

Namespace:  Kit.Pooling
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0
Syntax
C#
public class PoolGroup : MonoBehaviour, IEnumerable<Pool>, 
	IEnumerable
Request Example View Source

The PoolGroup type exposes the following members.

Properties
  NameDescription
Public propertyAvailable
All the instances available for re-use in this group.
Public propertyAvailableCount
Total number of instances available for re-use in this group.
Public propertyIsDestroying
Public propertyUsed
All the instances being used by pools in this group.
Public propertyUsedCount
Total number of instances being used by pools in this group.
Top
Methods
  NameDescription
Public methodAddPool
Add a pool to this group.
Public methodContainsPool
Return whether a pool is a part of this group.
Public methodRemovePool
Remove a pool from this group.
Top
Fields
  NameDescription
Public fieldMessageMode
MessageMode of pools added to this group.
Public fieldOrganize
Whether to organize groups, pools, and instances for a cleaner scene hierarchy?
Public fieldPersistent
Keep pools under this group persistent across scenes.
Public fieldPools
List of pools associated with this group.
Top
Extension Methods
  NameDescription
Public Extension MethodDestroy
Destroy the object.
(Defined by UnityObjectExtensions.)
Public Extension MethodDisable
Set the enabled property to .
(Defined by BehaviourExtensions.)
Public Extension MethodEnable
Set the enabled property to .
(Defined by BehaviourExtensions.)
Public Extension MethodForEachPool
Perform an action on a enumerable of items.
(Defined by EnumerableExtensions.)
Public Extension MethodGetBounds

Returns the bounds of the Component.

(Defined by ComponentExtensions.)
Public Extension MethodIndexOfPool(Pool)Overloaded.
Return the index of an item, or -1 if not found.
(Defined by EnumerableExtensions.)
Public Extension MethodIndexOfPool(Pool, IEqualityComparerPool)Overloaded.
Return the index of an item, or -1 if not found.
(Defined by EnumerableExtensions.)
Public Extension MethodIsPrefab
Returns whether the Component is a part of a prefab.
(Defined by ComponentExtensions.)
Public Extension MethodLogPool
Log all the items in enumerable to the Console.
(Defined by EnumerableExtensions.)
Public Extension MethodWithIndexPool
Allows to traverse over an enumerable along with the indices of items.
(Defined by EnumerableExtensions.)
Top
See Also