Core GameKit  3.2.9.0
The ultimate pooling / combat / spawning / variable plugin!
DarkTonic.CoreGameKit.SpawnUtility Class Reference

This class is used as a wrapper for Pool Boss, but if you prefer to use Pool Manager, you can change that hookup here. More...

Static Public Member Functions

static void DamageAllOfPrefab (Transform transToDamage, int damagePoints)
 Call this method to damage all instances of a prefab using Pool Boss. More...
 
static void DespawnAllOfPrefab (Transform transToDespawn)
 Call this method to despawn all instances of a prefab using Pool Boss. More...
 
static void KillAllOfPrefab (Transform transToKill)
 Call this method to kill all instances of a prefab using Pool Boss. Only prefabs with a Killable component can be killed. More...
 
static void DespawnAllPrefabs ()
 Call this method to despawn all instances of all prefabs that use Pool Boss. More...
 
static void DamageAllPrefabs (int damagePoints)
 Call this method to damage all instances of a prefab using Pool Boss. More...
 
static void KillAllPrefabs ()
 Call this method to kill all instances of all prefabs that use Pool Boss. Only prefabs with a Killable component can be killed. More...
 
static void DespawnAllPrefabsInCategory (string category)
 Call this method to despawn all instances of all prefabs in a certain Pool Boss category. More...
 
static void DamageAllPrefabsInCategory (string category, int damagePoints)
 Call this method to damage all instances of all prefabs in a certain Pool Boss category. Only prefabs with a Killable component can be damaged. More...
 
static void KillAllPrefabsInCategory (string category)
 Call this method to kill all instances of all prefabs in a certain Pool Boss category. Only prefabs with a Killable component can be killed. More...
 
static bool IsDespawnedOrDestroyed (GameObject objectToCheck)
 This method will tell you if a GameObject is either despawned or destroyed. More...
 
static bool IsActive (GameObject go)
 This is a cross-Unity-version method to tell you if a GameObject is active in the Scene. More...
 
static void SetActive (GameObject go, bool isActive)
 This is a cross-Unity-version method to set a GameObject to active in the Scene. More...
 

Detailed Description

This class is used as a wrapper for Pool Boss, but if you prefer to use Pool Manager, you can change that hookup here.

Member Function Documentation

static void DarkTonic.CoreGameKit.SpawnUtility.DamageAllOfPrefab ( Transform  transToDamage,
int  damagePoints 
)
static

Call this method to damage all instances of a prefab using Pool Boss.

Parameters
transToDamageTransform to damage
damagePointsHow many points of damage to deal to each
static void DarkTonic.CoreGameKit.SpawnUtility.DamageAllPrefabs ( int  damagePoints)
static

Call this method to damage all instances of a prefab using Pool Boss.

Parameters
damagePointsHow many points of damage to deal to each
static void DarkTonic.CoreGameKit.SpawnUtility.DamageAllPrefabsInCategory ( string  category,
int  damagePoints 
)
static

Call this method to damage all instances of all prefabs in a certain Pool Boss category. Only prefabs with a Killable component can be damaged.

Parameters
categoryCategory to affect
damagePointsAmount of damage to deal to each
static void DarkTonic.CoreGameKit.SpawnUtility.DespawnAllOfPrefab ( Transform  transToDespawn)
static

Call this method to despawn all instances of a prefab using Pool Boss.

Parameters
transToDespawnTransform to despawn
static void DarkTonic.CoreGameKit.SpawnUtility.DespawnAllPrefabs ( )
static

Call this method to despawn all instances of all prefabs that use Pool Boss.

static void DarkTonic.CoreGameKit.SpawnUtility.DespawnAllPrefabsInCategory ( string  category)
static

Call this method to despawn all instances of all prefabs in a certain Pool Boss category.

Parameters
categoryCategory to affect
static bool DarkTonic.CoreGameKit.SpawnUtility.IsActive ( GameObject  go)
static

This is a cross-Unity-version method to tell you if a GameObject is active in the Scene.

Parameters
goThe GameObject you're asking about.
Returns
True or false
static bool DarkTonic.CoreGameKit.SpawnUtility.IsDespawnedOrDestroyed ( GameObject  objectToCheck)
static

This method will tell you if a GameObject is either despawned or destroyed.

Parameters
objectToCheckThe GameObject you're asking about.
Returns
True or false
static void DarkTonic.CoreGameKit.SpawnUtility.KillAllOfPrefab ( Transform  transToKill)
static

Call this method to kill all instances of a prefab using Pool Boss. Only prefabs with a Killable component can be killed.

Parameters
transToKillTransform to kill
static void DarkTonic.CoreGameKit.SpawnUtility.KillAllPrefabs ( )
static

Call this method to kill all instances of all prefabs that use Pool Boss. Only prefabs with a Killable component can be killed.

static void DarkTonic.CoreGameKit.SpawnUtility.KillAllPrefabsInCategory ( string  category)
static

Call this method to kill all instances of all prefabs in a certain Pool Boss category. Only prefabs with a Killable component can be killed.

Parameters
categoryCategory to affect
static void DarkTonic.CoreGameKit.SpawnUtility.SetActive ( GameObject  go,
bool  isActive 
)
static

This is a cross-Unity-version method to set a GameObject to active in the Scene.

Parameters
goThe GameObject you're setting to active or inactive
isActiveTrue to set the object to active, false to set it to inactive.

The documentation for this class was generated from the following file: