| Package | com.desuade.partigen.emitters |
| Class | public dynamic class IDEEmitter |
| Inheritance | IDEEmitter  Emitter BasicEmitter flash.display.Sprite |
| Language Version : | ActionScript 3 |
| Since : | 20.08.2009 |
| Runtime Versions : | AIR 1.0, Flash Player 9.0.0 |
| Property | Defined By | ||
|---|---|---|---|
 | active : Boolean [read-only]
This is true if the emitter is currently emitting. | BasicEmitter | |
| angle : int = 0
This is the angle used by ParticlePhysicsControllers on new particles. | Emitter | |
| angleSpread : * = 0
This is the spread for the angle, to create a random range for ParticlePhysicsControllers. | Emitter | |
| autoStart : Boolean
Start the emitter automatically. | IDEEmitter | ||
| burst : int = 1
This is the amount of particles to be created on each emission. | BasicEmitter | |
| cacheParticleAsBitmap : Boolean = false
This will set "cacheAsBitmap = true" on all created particles.
Test using this vs groupBitmap - as performance will vary based on each effect.
Also test this with BitmapRenderer, as it may vary the effect and performance.
| BasicEmitter | |
| config : String
Getter/setter that uses XML methods to return (as String) or set the configuration of the emitter from String/XML. | IDEEmitter | ||
| controllers : Object
This object holds the EmitterController and the ParticleController.
They are accessible as follows: controllers.emitter and controllers.particle
These controllers are what is used to configure particles and the way the behave, as well as properties for the emitter itself.
| Emitter | |
| enableEvents : Boolean = false
Enable particle BORN and DIED events. | BasicEmitter | |
| eps : Number
This stands for "emissions per second". | BasicEmitter | |
| followMouse : Boolean
If the emitter follows the mouse. | IDEEmitter | ||
| forceVariety : Boolean = false
This forces pooled particles to rebuild their groups and controllers to eliminate any possible repetition or error at the cost of performance.
Set this to true if you plan on making changes to the emitter while it's running. | BasicEmitter | |
| groupAmount : int = 1
This controls how may particles are made in a "particle group". | BasicEmitter | |
| groupBitmap : Boolean = false
This will create a new Bitmap object for the particle instead of the direct display object. | BasicEmitter | |
| groupProximity : int = 0
This determines the maximum distance away from the center of the group to create new particles. | BasicEmitter | |
| id : int [read-only]
The unique id of the emitter. | BasicEmitter | |
| life : Number = 1
This is the duration in seconds a particle will exist for.
If the value is 0, the particle will live forever.
| BasicEmitter | |
| lifeSpread : * = 0
This is the spread for particle lives. | BasicEmitter | |
| particle : Class
This is the class used to create new particles from. | BasicEmitter | |
| particleBaseClass : Class
This is the base class to used for all created particles.
When the pools create particle objects, they use this. | BasicEmitter | |
| particleBlendMode : String = normal
This defines the blendmode for each particle created.
Choices: "add", "alpha", "darken", "difference", "erase", "hardlight", "invert", "layer", "lighten", "multiply", "normal", "overlay", "screen", "subtract"
Note: PixelRenderer will assume the blendmode of all particles/pixels is the same.
| BasicEmitter | |
| particleFilters : Array
This is an array of filters that gets applied to each particle as it's born. | BasicEmitter | |
| pool : Pool
This is the Pool to use to store and manage the actual particle objects. | BasicEmitter | |
| prefetchTime : Number = 0
This is the prefetch time used when automatically starting the emitter. | IDEEmitter | ||
| renderer : Renderer
The Renderer to use for created particles. | BasicEmitter | |
| showIndicator : Boolean
If the emitter indicator should be shown, marking it's position on the stage. | IDEEmitter | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new IDEEmitter (usually from a component)
| IDEEmitter | ||
| createParticleBitmap(padding:int = 0):void
This creates the main bitmapdata object used when groupBitmap == true. | BasicEmitter | |
| emit(burst:int = 1):void
This method creates new particles each time it's called. | BasicEmitter | |
| fromXML(xml:XML, reset:Boolean = true, renderer:Boolean = false):* [override]
This configures the emitter based on the XML, and adds any controllers (if available)
| Emitter | |
| getPrefetchLifeArray(time:Number):Array
This creates an array of particle's life values, both original and current, based on the eps/burst and supplied time value as it would if the emitter was running for the time duration. | BasicEmitter | |
| killParticles():void
This kills all currently existing particles in the pool created by this emitter
| BasicEmitter | |
| prefetch(time:Number):void
This prefetches (and creates) the particles that would have existed if the emitter was running for the given time. | BasicEmitter | |
| reset():void [override]
This resets the emitter to the defaults and purges the pool
| Emitter | |
| start(time:Number = 0, startcontrollers:Boolean = true):void [override]
Starts the emitter. | Emitter | |
| stop(stopcontrollers:Boolean = true, purge:Boolean = true):void [override]
This stops the emitter. | Emitter | |
| toXML():XML [override]
This generates an XML object representing the entire emitter
| Emitter | |
| autoStart | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautoStart:BooleanStart the emitter automatically.
public function get autoStart():Boolean public function set autoStart(value:Boolean):void| config | property |
config:StringGetter/setter that uses XML methods to return (as String) or set the configuration of the emitter from String/XML.
public function get config():String public function set config(value:String):void| followMouse | property |
followMouse:BooleanIf the emitter follows the mouse.
public function get followMouse():Boolean public function set followMouse(value:Boolean):void| prefetchTime | property |
public var prefetchTime:Number = 0This is the prefetch time used when automatically starting the emitter.
| showIndicator | property |
showIndicator:BooleanIf the emitter indicator should be shown, marking it's position on the stage.
public function get showIndicator():Boolean public function set showIndicator(value:Boolean):void| IDEEmitter | () | Constructor |
public function IDEEmitter()Creates a new IDEEmitter (usually from a component)