Packagecom.desuade.partigen.particles
Classpublic dynamic class BasicParticle
InheritanceBasicParticle Inheritance flash.display.Sprite
Implements IBasicParticle
Subclasses Particle

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

The most basic form of Particle, only the minimum necessary.



Public Properties
 PropertyDefined By
  classPool : MultiPool
[static] This is the MultiPool that stores all the object pools for particle classes.
BasicParticle
  emitter : BasicEmitter
[read-only] The parent emitter that emitted this particle.
BasicParticle
  group : Array
This holds the particles inside of the group.
BasicParticle
  id : int
[read-only] The unique id of the particle.
BasicParticle
  isbuilt : Boolean = false
This is used by the emitter and pools to determine if the controllers, groups, bitmaps, etc have already been built.
BasicParticle
  isclean : Boolean = true
This is used by the emitter and pools to determine if/how the particle has been used before in memory.
BasicParticle
  life : Number
The life of the particle: how long the particle will live for.
BasicParticle
Public Methods
 MethodDefined By
  
Creates a new particle.
BasicParticle
  
kill(... args):void
This instantly kills the particle and dispatches a "DIED" event.
BasicParticle
Property Detail
classPoolproperty
public static var classPool:MultiPool

This is the MultiPool that stores all the object pools for particle classes.

emitterproperty 
emitter:BasicEmitter  [read-only]

The parent emitter that emitted this particle.


Implementation
    public function get emitter():BasicEmitter
groupproperty 
public var group:Array

This holds the particles inside of the group.

idproperty 
id:int  [read-only]

The unique id of the particle.


Implementation
    public function get id():int
isbuiltproperty 
public var isbuilt:Boolean = false

This is used by the emitter and pools to determine if the controllers, groups, bitmaps, etc have already been built.

iscleanproperty 
public var isclean:Boolean = true

This is used by the emitter and pools to determine if/how the particle has been used before in memory.

lifeproperty 
public var life:Number

The life of the particle: how long the particle will live for. This also effects the duration of controller tweens.

Constructor Detail
BasicParticle()Constructor
public function BasicParticle()

Creates a new particle. This should normally not be called; use emitter.emit() instead of this.

As of v2.1, Particles act as containers for the "actual particles" used from the library. This allows any class/symbol to be used without having to be extended from Particle. It also adopts grouping.

See also

Method Detail
kill()method
public function kill(... args):void

This instantly kills the particle and dispatches a "DIED" event.

Parameters

... args