Particle Playground - Script Reference  3.0.1
Framework for controlling particles in the Unity Engine.
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
ParticlePlayground.PlaygroundEventC Class Reference

Holds information for a Playground Event. More...

Public Member Functions

void Initialize ()
 Initialize this Playground Event. More...
 
bool UpdateTime ()
 Determines if this Playground Event is ready to send a time-based event. More...
 
void SetTimer (float newTime)
 Sets the timer for time-based events. More...
 
void SendParticleEvent (PlaygroundEventParticle eventParticle)
 Sends the particle event. More...
 
PlaygroundEventC Clone ()
 Return a copy of this PlaygroundEventC. More...
 

Public Attributes

bool enabled = true
 Is this PlaygroundEvent enabled? More...
 
bool sendToManager = false
 Should events be sent to PlaygroundC.particleEvent? More...
 
bool initializedTarget = false
 Has this PlaygroundEvent initialized with its target? More...
 
bool initializedEvent = false
 Does this PlaygroundEvent have any subscribers to the particleEvent? More...
 
PlaygroundParticlesC target
 The target particle system to send events to. More...
 
EVENTBROADCASTC broadcastType
 The broadcast type of this event (A PlaygroundParticlesC target and/or Event Listeners). More...
 
EVENTTYPEC eventType
 The type of event. More...
 
EVENTINHERITANCEC eventInheritancePosition
 The inheritance method of position. More...
 
EVENTINHERITANCEC eventInheritanceVelocity
 The inheritance method of velocity. More...
 
EVENTINHERITANCEC eventInheritanceColor
 The inheritance method of color. More...
 
Vector3 eventPosition
 The position to send (if inheritance is User). More...
 
Vector3 eventVelocity
 The velocity to send (if inheritance is User). More...
 
Color32 eventColor = Color.white
 The color to send (if inheritance is User). More...
 
float eventTime = 1f
 The time between events (if type is set to Time). More...
 
float collisionThreshold = 10f
 The magnitude threshold to trigger collision events. More...
 
float velocityMultiplier = 1f
 The multiplier of velocity. More...
 

Events

OnPlaygroundParticle particleEvent
 The event of a particle (when using Event Listeners). More...
 

Detailed Description

Holds information for a Playground Event.

Member Function Documentation

PlaygroundEventC ParticlePlayground.PlaygroundEventC.Clone ( )

Return a copy of this PlaygroundEventC.

void ParticlePlayground.PlaygroundEventC.Initialize ( )

Initialize this Playground Event.

void ParticlePlayground.PlaygroundEventC.SendParticleEvent ( PlaygroundEventParticle  eventParticle)

Sends the particle event.

Parameters
eventParticleEvent particle.
void ParticlePlayground.PlaygroundEventC.SetTimer ( float  newTime)

Sets the timer for time-based events.

Parameters
newTimeNew time.
bool ParticlePlayground.PlaygroundEventC.UpdateTime ( )

Determines if this Playground Event is ready to send a time-based event.

Returns
true, if time was updated, false otherwise.

Member Data Documentation

EVENTBROADCASTC ParticlePlayground.PlaygroundEventC.broadcastType

The broadcast type of this event (A PlaygroundParticlesC target and/or Event Listeners).

float ParticlePlayground.PlaygroundEventC.collisionThreshold = 10f

The magnitude threshold to trigger collision events.

bool ParticlePlayground.PlaygroundEventC.enabled = true

Is this PlaygroundEvent enabled?

Color32 ParticlePlayground.PlaygroundEventC.eventColor = Color.white

The color to send (if inheritance is User).

EVENTINHERITANCEC ParticlePlayground.PlaygroundEventC.eventInheritanceColor

The inheritance method of color.

EVENTINHERITANCEC ParticlePlayground.PlaygroundEventC.eventInheritancePosition

The inheritance method of position.

EVENTINHERITANCEC ParticlePlayground.PlaygroundEventC.eventInheritanceVelocity

The inheritance method of velocity.

Vector3 ParticlePlayground.PlaygroundEventC.eventPosition

The position to send (if inheritance is User).

float ParticlePlayground.PlaygroundEventC.eventTime = 1f

The time between events (if type is set to Time).

EVENTTYPEC ParticlePlayground.PlaygroundEventC.eventType

The type of event.

Vector3 ParticlePlayground.PlaygroundEventC.eventVelocity

The velocity to send (if inheritance is User).

bool ParticlePlayground.PlaygroundEventC.initializedEvent = false

Does this PlaygroundEvent have any subscribers to the particleEvent?

bool ParticlePlayground.PlaygroundEventC.initializedTarget = false

Has this PlaygroundEvent initialized with its target?

bool ParticlePlayground.PlaygroundEventC.sendToManager = false

Should events be sent to PlaygroundC.particleEvent?

PlaygroundParticlesC ParticlePlayground.PlaygroundEventC.target

The target particle system to send events to.

float ParticlePlayground.PlaygroundEventC.velocityMultiplier = 1f

The multiplier of velocity.

Event Documentation

OnPlaygroundParticle ParticlePlayground.PlaygroundEventC.particleEvent

The event of a particle (when using Event Listeners).


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