Packageverlocity.particle
Classpublic final class ParticleEmitter
InheritanceParticleEmitter Inheritance flash.geom.Point


Public Properties
 PropertyDefined By
  iCurParticles : int
ParticleEmitter
  iMaxParticleAmount : int
ParticleEmitter
Public Methods
 MethodDefined By
  
ParticleEmitter(nPosX:Number, nPosY:Number, iSetLifeTime:int, iMaxPartAmount:int)
Creates a particle emitter
ParticleEmitter
  
_Update():void
Updates the emitter.
ParticleEmitter
  
CanEmit():Boolean
Returns if the emitter can actually emit a particle
ParticleEmitter
  
Dispose():void
Deletes any data assoc.
ParticleEmitter
  
GeneratePosition():Point
Gets a random position based on the origin and returns it as a Point for particles.
ParticleEmitter
  
GenerateProperties():ParticleProperties
Generates a random particle properties for applying to particles Make sure everything is set before calling this.
ParticleEmitter
  
IsDead():Boolean
Returns if the emitter is dead
ParticleEmitter
  
Remove():void
Removes the emitter.
ParticleEmitter
  
SetPartAcceleration(nAccelXLow:Number, nAccelXHigh:Number, nAccelYLow:Number, nAccelYHigh:Number):void
Sets the particles' starting acceleration
ParticleEmitter
  
SetPartColorEnd(uiColor1:uint, uiColor2:uint = 0):void
Sets the particles' ending color.
ParticleEmitter
  
SetPartColorStart(uiColor1:uint, uiColor2:uint = 0):void
Sets the particles' starting color.
ParticleEmitter
  
SetPartLifeTime(nLifeTimeLow:Number, nLifeTimeHigh:Number):void
Sets the particles' life time.
ParticleEmitter
  
SetPartPosition(nPosXLow:Number, nPosXHigh:Number, nPosYLow:Number, nPosYHigh:Number):void
Sets the start position of the particles.
ParticleEmitter
  
SetPartVelocity(nVelXLow:Number, nVelXHigh:Number, nVelYLow:Number, nVelYHigh:Number):void
Sets the particles' starting velocity
ParticleEmitter
Property Detail
iCurParticlesproperty
public var iCurParticles:int

iMaxParticleAmountproperty 
public var iMaxParticleAmount:int

Constructor Detail
ParticleEmitter()Constructor
public function ParticleEmitter(nPosX:Number, nPosY:Number, iSetLifeTime:int, iMaxPartAmount:int)

Creates a particle emitter

Parameters
nPosX:Number — X position of the emitter
 
nPosY:Number — Y position of the emitter
 
iSetLifeTime:int — Sets the lifetime of the emitter
 
iMaxPartAmount:int — Max particles allowed to be emitted at any one time
Method Detail
_Update()method
public function _Update():void

Updates the emitter.

CanEmit()method 
public function CanEmit():Boolean

Returns if the emitter can actually emit a particle

Returns
Boolean —
Dispose()method 
public function Dispose():void

Deletes any data assoc. with the particle emitter

GeneratePosition()method 
public function GeneratePosition():Point

Gets a random position based on the origin and returns it as a Point for particles.

Returns
Point —
GenerateProperties()method 
public function GenerateProperties():ParticleProperties

Generates a random particle properties for applying to particles Make sure everything is set before calling this.

Returns
ParticleProperties —
IsDead()method 
public function IsDead():Boolean

Returns if the emitter is dead

Returns
Boolean
Remove()method 
public function Remove():void

Removes the emitter.

SetPartAcceleration()method 
public function SetPartAcceleration(nAccelXLow:Number, nAccelXHigh:Number, nAccelYLow:Number, nAccelYHigh:Number):void

Sets the particles' starting acceleration

Parameters

nAccelXLow:Number (default = NaN) — Low range of the X accel
 
nAccelXHigh:Number (default = NaN) — High range of the X accel
 
nAccelYLow:Number (default = NaN) — Low range of the Y accel
 
nAccelYHigh:Number (default = NaN) — High range of the Y accel

SetPartColorEnd()method 
public function SetPartColorEnd(uiColor1:uint, uiColor2:uint = 0):void

Sets the particles' ending color. Randomly chooses between first and second colors.

Parameters

uiColor1:uint — The first color
 
uiColor2:uint (default = 0) — The second color

SetPartColorStart()method 
public function SetPartColorStart(uiColor1:uint, uiColor2:uint = 0):void

Sets the particles' starting color. Randomly chooses between first and second colors.

Parameters

uiColor1:uint — The first color
 
uiColor2:uint (default = 0) — The second color

SetPartLifeTime()method 
public function SetPartLifeTime(nLifeTimeLow:Number, nLifeTimeHigh:Number):void

Sets the particles' life time. Randomly chooses between low and high.

Parameters

nLifeTimeLow:Number — The lowest lifetime
 
nLifeTimeHigh:Number (default = NaN) — The highest lifetime

SetPartPosition()method 
public function SetPartPosition(nPosXLow:Number, nPosXHigh:Number, nPosYLow:Number, nPosYHigh:Number):void

Sets the start position of the particles.

Parameters

nPosXLow:Number (default = NaN) — Low range of X position
 
nPosXHigh:Number (default = NaN) — High range of X position
 
nPosYLow:Number (default = NaN) — Low range of Y position
 
nPosYHigh:Number (default = NaN) — High range of Y postiion

SetPartVelocity()method 
public function SetPartVelocity(nVelXLow:Number, nVelXHigh:Number, nVelYLow:Number, nVelYHigh:Number):void

Sets the particles' starting velocity

Parameters

nVelXLow:Number (default = NaN) — Low range of X velocity
 
nVelXHigh:Number (default = NaN) — High range of X velocity
 
nVelYLow:Number (default = NaN) — Low range of Y velocity
 
nVelYHigh:Number (default = NaN) — High range of Y velocity





Wed Feb 29 2012, 07:04 PM -08:00