Packageidv.cjcat.stardust.common.particles
Classpublic class Particle
SubclassesParticle2D, Particle3D

This class represents a particle and its properties.



Public Properties
 PropertyDefined by
  alpha : Number
The alpha value of the particle.
Particle
  collisionRadius : Number
The collision radius of the particle.
Particle
  color : uint
Particle color.
Particle
  dictionary : Dictionary
Dictionary for storing additional information.
Particle
  initAlpha : Number
The normal alpha value upon birth.
Particle
  initLife : Number
The initial life upon birth.
Particle
  initScale : Number
The normal scale upon birth.
Particle
  isDead : Boolean
Whether the particle is marked as dead.
Particle
  life : Number
The remaining life of the particle.
Particle
  mask : int
The mask value of the particle.
Particle
  mass : Number
The mass of the particle.
Particle
  recyclers : Dictionary
Particle
  scale : Number
The scale of the particle.
Particle
  sortedIndexIterator : ParticleIterator
The sorted index iterator.
Particle
  target : *
Custom user data of the particle.
Particle
Public Methods
 MethodDefined by
  
Particle
  
destroy():void
Particle
  
init():void
Initializes properties to default values.
Particle
Property detail
alphaproperty
public var alpha:Number

The alpha value of the particle.

collisionRadiusproperty 
public var collisionRadius:Number

The collision radius of the particle.

colorproperty 
public var color:uint

Particle color.

This information can be used by the PixelRenderer class for determining pixel colors.

dictionaryproperty 
public var dictionary:Dictionary

Dictionary for storing additional information.

initAlphaproperty 
public var initAlpha:Number

The normal alpha value upon birth.

initLifeproperty 
public var initLife:Number

The initial life upon birth.

initScaleproperty 
public var initScale:Number

The normal scale upon birth.

isDeadproperty 
public var isDead:Boolean

Whether the particle is marked as dead.

Dead particles would be removed from simulation by an emitter.

lifeproperty 
public var life:Number

The remaining life of the particle.

maskproperty 
public var mask:int

The mask value of the particle.

The particle can only affected by an action or initializer only if the bitwise AND of their masks is non-zero.

massproperty 
public var mass:Number

The mass of the particle.

recyclersproperty 
public var recyclers:Dictionary
scaleproperty 
public var scale:Number

The scale of the particle.

sortedIndexIteratorproperty 
public var sortedIndexIterator:ParticleIterator

The sorted index iterator.

targetproperty 
public var target:*

Custom user data of the particle.

Normally, this property contains information for renderers. For instance this property should refer to a display object for a DisplayObjectRenderer.

Constructor detail
Particle()constructor
public function Particle()
Method detail
destroy()method
public function destroy():void
init()method 
public function init():void

Initializes properties to default values.

life = 0. scale = 1. alpha = 1. mass = 1. mask = 1. collisoinRadius = 0. target = null. sortedIndex = NaN.