hObjectPoolItem Class Reference

A drop in implementation of the Hydrogen.Core.ObjectPoolItem. This is one possible way of setting up an ObjectPoolItem to handle spawning and despawning appropriately. More...

Inheritance diagram for hObjectPoolItem:

Public Member Functions
override void	DespawnSafely ()
	Despawn the gameObject safely after all particles have done their thing. More...
override bool	IsInactive ()
	Is the object idle, and therefore can be despawned organically? More...
override void	OnDespawned ()
	Raised when the object is 'despawned' back into the pool. More...
override void	OnSpawned ()
	Raised when the object is 'spawned' from the pool. More...

Public Attributes
float	LifeTime
	Despawn gameObject after this number of seconds. More...

Detailed Description

A drop in implementation of the Hydrogen.Core.ObjectPoolItem. This is one possible way of setting up an ObjectPoolItem to handle spawning and despawning appropriately.

Learn from it, make your own, as long as you extend from the base class you still get the performance benefits.

Definition at line 41 of file hObjectPoolItem.cs.

Member Function Documentation

override void hObjectPoolItem.DespawnSafely ( )

virtual

Despawn the gameObject safely after all particles have done their thing.

If you are going to utilize this make sure that your function contains: hObjectPool.Instance.objectPools[poolID].DespawnImmediate(gameObject);

Implements Hydrogen.Core.ObjectPoolItemBase.

Definition at line 54 of file hObjectPoolItem.cs.

        {
                StartCoroutine (WaitForParticles ());
        }

override bool hObjectPoolItem.IsInactive ( )

virtual

Is the object idle, and therefore can be despawned organically?

Returns

true

false

This will only work on tracked spawned objects.

Implements Hydrogen.Core.ObjectPoolItemBase.

Definition at line 65 of file hObjectPoolItem.cs.

        {
                // A simple rigidbody check, otherwise no bueno
                return ParentPool.HasRigidbody && gameObject.rigidbody.IsSleeping ();
        }

override void hObjectPoolItem.OnDespawned ( )

virtual

Raised when the object is 'despawned' back into the pool.

It does not set "active", you must handle that yourself.

Implements Hydrogen.Core.ObjectPoolItemBase.

Definition at line 75 of file hObjectPoolItem.cs.

        {
                // If our object has a rigidbody (cached check), make sure to zero its velocity.
                if (ParentPool.HasRigidbody)
                        gameObject.rigidbody.velocity = Vector3.zero;
        
                // Disable the gameObject
                gameObject.SetActive (false);
        }

override void hObjectPoolItem.OnSpawned ( )

virtual

Raised when the object is 'spawned' from the pool.

It does not set "active", you must handle that yourself.

Implements Hydrogen.Core.ObjectPoolItemBase.

Definition at line 89 of file hObjectPoolItem.cs.

        {
                // Make sure our object is active please and thank you
                gameObject.SetActive (true);

                // If there is a LifeTime greater then 0, we set a timer to despawn
                if (LifeTime > 0)
                        StartCoroutine (DespawnTimer ());
        }

Member Data Documentation

float hObjectPoolItem.LifeTime

Despawn gameObject after this number of seconds.

In seconds, use 0 to disable.

Definition at line 47 of file hObjectPoolItem.cs.