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.PlaygroundEventParticle Class Reference

Holds information for a PlaygroundEventParticle. The Playground Event Particle contains detailed data upon an event and is sent towards any event listeners. More...

Public Member Functions

PlaygroundEventParticle Clone ()
 Copies this PlaygroundEventParticle. More...
 

Public Attributes

float initialSize
 The initial size of this particle. More...
 
float size
 The lifetime size of this particle. More...
 
float rotation
 The rotation of this particle. More...
 
float life
 The lifetime of this particle. More...
 
float totalLifetime
 The total time this particle will live. This will take lifetime subtraction into account. More...
 
float birth
 The time of birth for this particle. More...
 
float birthDelay
 The delayed time of birth when emission has changed. More...
 
float death
 The time of death for this particle. More...
 
bool emission
 The emission for this particle (controlled by emission rate). More...
 
bool rebirth
 Determines if this particle should rebirth. More...
 
float lifetimeOffset
 The offset in birth-death (sorting). More...
 
Vector3 velocity
 The velocity of this particle. More...
 
Vector3 initialVelocity
 The initial velocity of this particle. More...
 
Vector3 initialLocalVelocity
 The initial local velocity of this particle. More...
 
Vector3 position
 The position of this particle. More...
 
Vector3 targetPosition
 The source position at birth for this particle. More...
 
Vector3 targetDirection
 The source direction at birth for this particle. More...
 
Vector3 previousTargetPosition
 The previous source position for this particle (used to calculate delta movement). More...
 
Vector3 previousParticlePosition
 The previous calculated frame's particle position. More...
 
Vector3 collisionParticlePosition
 The calculated particle position for collision. More...
 
Vector3 localSpaceMovementCompensation
 The delta to compensate for moving particles in local space. More...
 
Vector3 scatterPosition
 The scattered position to apply on this particle birth. More...
 
float initialRotation
 The initial rotation of this particle. More...
 
float rotationSpeed
 The rotation speed of this particle. More...
 
Color32 color
 The current color of this particle. More...
 
Color32 scriptedColor
 The color set from script of this particle. More...
 
Color32 initialColor
 The set source color. More...
 
int lifetimeColorId
 The color gradient for this particle if Color Source is set to LifetimeColors. More...
 
bool noForce
 The particle does not respond to forces during its lifetime. More...
 
bool isNonBirthed
 The particle is non birthed. More...
 
bool isFirstLoop
 The particle is in its first loop. More...
 
int particleId
 The id of this particle. More...
 
int particleSystemId
 The id of the particle system this particle belongs to (list position in Playground Manager). More...
 
int manipulatorId
 The id of the last manipulator affecting this particle. More...
 
bool changedByProperty
 The interaction with property manipulators of this particle. More...
 
bool changedByPropertyColor
 The interaction with property manipulators that change color of this particle. More...
 
bool changedByPropertyColorLerp
 The interaction with property manipulators that change color over time of this particle. More...
 
bool changedByPropertyColorKeepAlpha
 The interaction with property manipulators that change color and wants to keep alpha. More...
 
bool changedByPropertySize
 The interaction with property manipulators that change size of this particle. More...
 
bool changedByPropertyTarget
 The interaction with property manipulators that change target of this particle. More...
 
bool changedByPropertyDeath
 The interaction with death manipulators that forces a particle to a sooner end. More...
 
int propertyTarget
 The property target pointer for this particle. More...
 
int propertyId
 The property target id for this particle (pairing a particle's target to a manipulator). More...
 
int propertyColorId
 The property color id for this particles (pairing a particle's color to a manipulator). More...
 
int excludeFromManipulatorId
 The manipulator id to exclude to not affect this particle. More...
 
bool isMasked
 Is this particle masked? More...
 
float maskAlpha
 The alpha of this masked particle. More...
 
Transform collisionTransform
 The collision transform of this collided particle. More...
 
Collider collisionCollider
 The collision collider of this collided particle (3d). More...
 
Collider2D collisionCollider2D
 The collision collider of this collided particle (2d). More...
 

Detailed Description

Holds information for a PlaygroundEventParticle. The Playground Event Particle contains detailed data upon an event and is sent towards any event listeners.

Member Function Documentation

PlaygroundEventParticle ParticlePlayground.PlaygroundEventParticle.Clone ( )

Member Data Documentation

float ParticlePlayground.PlaygroundEventParticle.birth

The time of birth for this particle.

float ParticlePlayground.PlaygroundEventParticle.birthDelay

The delayed time of birth when emission has changed.

bool ParticlePlayground.PlaygroundEventParticle.changedByProperty

The interaction with property manipulators of this particle.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertyColor

The interaction with property manipulators that change color of this particle.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertyColorKeepAlpha

The interaction with property manipulators that change color and wants to keep alpha.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertyColorLerp

The interaction with property manipulators that change color over time of this particle.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertyDeath

The interaction with death manipulators that forces a particle to a sooner end.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertySize

The interaction with property manipulators that change size of this particle.

bool ParticlePlayground.PlaygroundEventParticle.changedByPropertyTarget

The interaction with property manipulators that change target of this particle.

Collider ParticlePlayground.PlaygroundEventParticle.collisionCollider

The collision collider of this collided particle (3d).

Collider2D ParticlePlayground.PlaygroundEventParticle.collisionCollider2D

The collision collider of this collided particle (2d).

Vector3 ParticlePlayground.PlaygroundEventParticle.collisionParticlePosition

The calculated particle position for collision.

Transform ParticlePlayground.PlaygroundEventParticle.collisionTransform

The collision transform of this collided particle.

Color32 ParticlePlayground.PlaygroundEventParticle.color

The current color of this particle.

float ParticlePlayground.PlaygroundEventParticle.death

The time of death for this particle.

bool ParticlePlayground.PlaygroundEventParticle.emission

The emission for this particle (controlled by emission rate).

int ParticlePlayground.PlaygroundEventParticle.excludeFromManipulatorId

The manipulator id to exclude to not affect this particle.

Color32 ParticlePlayground.PlaygroundEventParticle.initialColor

The set source color.

Vector3 ParticlePlayground.PlaygroundEventParticle.initialLocalVelocity

The initial local velocity of this particle.

float ParticlePlayground.PlaygroundEventParticle.initialRotation

The initial rotation of this particle.

float ParticlePlayground.PlaygroundEventParticle.initialSize

The initial size of this particle.

Vector3 ParticlePlayground.PlaygroundEventParticle.initialVelocity

The initial velocity of this particle.

bool ParticlePlayground.PlaygroundEventParticle.isFirstLoop

The particle is in its first loop.

bool ParticlePlayground.PlaygroundEventParticle.isMasked

Is this particle masked?

bool ParticlePlayground.PlaygroundEventParticle.isNonBirthed

The particle is non birthed.

float ParticlePlayground.PlaygroundEventParticle.life

The lifetime of this particle.

int ParticlePlayground.PlaygroundEventParticle.lifetimeColorId

The color gradient for this particle if Color Source is set to LifetimeColors.

float ParticlePlayground.PlaygroundEventParticle.lifetimeOffset

The offset in birth-death (sorting).

Vector3 ParticlePlayground.PlaygroundEventParticle.localSpaceMovementCompensation

The delta to compensate for moving particles in local space.

int ParticlePlayground.PlaygroundEventParticle.manipulatorId

The id of the last manipulator affecting this particle.

float ParticlePlayground.PlaygroundEventParticle.maskAlpha

The alpha of this masked particle.

bool ParticlePlayground.PlaygroundEventParticle.noForce

The particle does not respond to forces during its lifetime.

int ParticlePlayground.PlaygroundEventParticle.particleId

The id of this particle.

int ParticlePlayground.PlaygroundEventParticle.particleSystemId

The id of the particle system this particle belongs to (list position in Playground Manager).

Vector3 ParticlePlayground.PlaygroundEventParticle.position

The position of this particle.

Vector3 ParticlePlayground.PlaygroundEventParticle.previousParticlePosition

The previous calculated frame's particle position.

Vector3 ParticlePlayground.PlaygroundEventParticle.previousTargetPosition

The previous source position for this particle (used to calculate delta movement).

int ParticlePlayground.PlaygroundEventParticle.propertyColorId

The property color id for this particles (pairing a particle's color to a manipulator).

int ParticlePlayground.PlaygroundEventParticle.propertyId

The property target id for this particle (pairing a particle's target to a manipulator).

int ParticlePlayground.PlaygroundEventParticle.propertyTarget

The property target pointer for this particle.

bool ParticlePlayground.PlaygroundEventParticle.rebirth

Determines if this particle should rebirth.

float ParticlePlayground.PlaygroundEventParticle.rotation

The rotation of this particle.

float ParticlePlayground.PlaygroundEventParticle.rotationSpeed

The rotation speed of this particle.

Vector3 ParticlePlayground.PlaygroundEventParticle.scatterPosition

The scattered position to apply on this particle birth.

Color32 ParticlePlayground.PlaygroundEventParticle.scriptedColor

The color set from script of this particle.

float ParticlePlayground.PlaygroundEventParticle.size

The lifetime size of this particle.

Vector3 ParticlePlayground.PlaygroundEventParticle.targetDirection

The source direction at birth for this particle.

Vector3 ParticlePlayground.PlaygroundEventParticle.targetPosition

The source position at birth for this particle.

float ParticlePlayground.PlaygroundEventParticle.totalLifetime

The total time this particle will live. This will take lifetime subtraction into account.

Vector3 ParticlePlayground.PlaygroundEventParticle.velocity

The velocity of this particle.


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