ParticlePlayground.PlaygroundFollow Class Reference

Inheritance diagram for ParticlePlayground.PlaygroundFollow:

Public Member Functions
PlaygroundFollower	GetActiveFollower (int index)
	Gets an active follower at index. This will only return active followers. More...
PlaygroundFollower	GetCachedFollower (int index)
	Gets a cached follower at index. This can return inactive followers waiting for their turn to be enabled. More...
int	GetActiveFollowersCount ()
	Gets the amount of active followers. More...
int	GetCachedFollowersCount ()
	Gets the amount of cached followers. More...

Public Attributes
PlaygroundParticlesC	particles
	Reference to the particle system. More...
GameObject	referenceObject
	Reference to an existing GameObject. This will be cloned to be used on every particle. More...
float	followerLifetime = 0
	The lifetime of the followers. Set 0 to follow during each particle's individual lifetime. More...
int	cacheSize = 0
	The size of the cache. Set 0 to automatically set the needed amount. More...
bool	sendEvents = false
	Determines if the Playground Followers should broadcast to any event listeners. More...

Events
OnPlaygroundFollower	followerEventBirth
	This event occurs when followers are born and sendEvents are set to true. More...
OnPlaygroundFollower	followerEventDeath
	This event occurs when follower dies and sendEvents are set to true. More...

Member Function Documentation

PlaygroundFollower ParticlePlayground.PlaygroundFollow.GetActiveFollower

(

int

index

)

Gets an active follower at index. This will only return active followers.

Returns

The active follower.

Parameters

index

Index.

int ParticlePlayground.PlaygroundFollow.GetActiveFollowersCount

(

)

Gets the amount of active followers.

Returns

The active followers count.

PlaygroundFollower ParticlePlayground.PlaygroundFollow.GetCachedFollower

(

int

index

)

Gets a cached follower at index. This can return inactive followers waiting for their turn to be enabled.

Returns

The cached follower.

Parameters

index

Index.

int ParticlePlayground.PlaygroundFollow.GetCachedFollowersCount

(

)

Gets the amount of cached followers.

Returns

The cached followers count.

Member Data Documentation

int ParticlePlayground.PlaygroundFollow.cacheSize = 0

The size of the cache. Set 0 to automatically set the needed amount.

float ParticlePlayground.PlaygroundFollow.followerLifetime = 0

The lifetime of the followers. Set 0 to follow during each particle's individual lifetime.

PlaygroundParticlesC ParticlePlayground.PlaygroundFollow.particles

Reference to the particle system.

GameObject ParticlePlayground.PlaygroundFollow.referenceObject

Reference to an existing GameObject. This will be cloned to be used on every particle.

bool ParticlePlayground.PlaygroundFollow.sendEvents = false

Determines if the Playground Followers should broadcast to any event listeners.

Event Documentation

OnPlaygroundFollower ParticlePlayground.PlaygroundFollow.followerEventBirth

This event occurs when followers are born and sendEvents are set to true.

OnPlaygroundFollower ParticlePlayground.PlaygroundFollow.followerEventDeath

This event occurs when follower dies and sendEvents are set to true.

---

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

• PlaygroundFollow.cs