Packagecom.desuade.partigen.events
Classpublic class ParticleEvent
InheritanceParticleEvent Inheritance flash.events.Event

Language Version : ActionScript 3
Since : 07.05.2009
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Events for particles. Events are broadcasted from the emitter.



Public Properties
 PropertyDefined By
  data : Object
This is the info object that's gets passed to the function.
ParticleEvent
Public Methods
 MethodDefined By
  
ParticleEvent(type:String, data:Object = null, bubbles:Boolean = false, cancelable:Boolean = false)
Creates a new ParticleEvent.
ParticleEvent
  
clone():Event
[override]
ParticleEvent
Public Constants
 ConstantDefined By
  BORN : String = born
[static] This gets fired everytime a particle is born.
ParticleEvent
  DIED : String = died
[static] This gets fired everytime a particle dies.
ParticleEvent
  FINISHED : String = finished
[static] This gets fired when an emitter stops and the last particle dies.
ParticleEvent
Property Detail
dataproperty
public var data:Object

This is the info object that's gets passed to the function. It contains the particle property, that is the particle that the event is associated with. For the FINISHED event, it's the pool property.

Constructor Detail
ParticleEvent()Constructor
public function ParticleEvent(type:String, data:Object = null, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a new ParticleEvent. Events get dispatched internally, manual creation isn't necessary.

Parameters
type:String
 
data:Object (default = null)
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Method Detail
clone()method
override public function clone():Event

Returns
Event
Constant Detail
BORNConstant
public static const BORN:String = born

This gets fired everytime a particle is born.

DIEDConstant 
public static const DIED:String = died

This gets fired everytime a particle dies. Occurs naturally, or when kill() is called.

FINISHEDConstant 
public static const FINISHED:String = finished

This gets fired when an emitter stops and the last particle dies.