Packageorg.flintparticles.common.events
Classpublic class ParticleEvent
InheritanceParticleEvent Inheritance flash.events.Event

The class for particle related events dispatched by classes in the Flint project.


Public Properties
 PropertyDefined By
  BOUNDING_BOX_COLLISION : String = boundingBoxCollision
[static] The event dispatched by an emitter when a particle collides with another particle.
ParticleEvent
  otherObject : *
The other object involved in the event.
ParticleEvent
  particle : Particle
The particle to which the event relates.
ParticleEvent
  PARTICLE_ADDED : String = particleAdded
[static] The event dispatched by an emitter when a pre-existing particle is added to it.
ParticleEvent
  PARTICLE_CREATED : String = particleCreated
[static] The event dispatched by an emitter when a particle is created.
ParticleEvent
  PARTICLE_DEAD : String = particleDead
[static] The event dispatched by an emitter when a particle dies.
ParticleEvent
  PARTICLES_COLLISION : String = particlesCollision
[static] The event dispatched by an emitter when a particle collides with another particle.
ParticleEvent
  ZONE_COLLISION : String = zoneCollision
[static] The event dispatched by an emitter when a particle collides with a zone.
ParticleEvent
Public Methods
 MethodDefined By
  
ParticleEvent(type:String, particle:Particle = null, bubbles:Boolean = false, cancelable:Boolean = false)
The constructor creates a ParticleEvent object.
ParticleEvent
  
clone():Event
[override] Creates a copy of this event.
ParticleEvent
Property Detail
BOUNDING_BOX_COLLISIONproperty
public static var BOUNDING_BOX_COLLISION:String = boundingBoxCollision

The event dispatched by an emitter when a particle collides with another particle.

otherObjectproperty 
public var otherObject:*

The other object involved in the event. This may be null.

particleproperty 
public var particle:Particle

The particle to which the event relates.

PARTICLE_ADDEDproperty 
public static var PARTICLE_ADDED:String = particleAdded

The event dispatched by an emitter when a pre-existing particle is added to it.

PARTICLE_CREATEDproperty 
public static var PARTICLE_CREATED:String = particleCreated

The event dispatched by an emitter when a particle is created.

PARTICLE_DEADproperty 
public static var PARTICLE_DEAD:String = particleDead

The event dispatched by an emitter when a particle dies.

PARTICLES_COLLISIONproperty 
public static var PARTICLES_COLLISION:String = particlesCollision

The event dispatched by an emitter when a particle collides with another particle.

ZONE_COLLISIONproperty 
public static var ZONE_COLLISION:String = zoneCollision

The event dispatched by an emitter when a particle collides with a zone.

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

The constructor creates a ParticleEvent object.

Parameters
type:String — The type of the event, accessible as Event.type.
 
particle:Particle (default = null) — The particle to which teh event relates.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false.
Method Detail
clone()method
override public function clone():Event

Creates a copy of this event.

Returns
Event — The copy of this event.



© Richard Lord 2008-2011

Sun Feb 27 2011, 06:00 PM Z