Packageorg.flintparticles.common.counters
Classpublic class Blast
InheritanceBlast Inheritance Object
Implements Counter

The Blast counter causes the emitter to create a single burst of particles when it starts and then emit no further particles. It is used, for example, to simulate an explosion.



Public Properties
 PropertyDefined By
  complete : Boolean
[read-only] Indicates if the counter has emitted all its particles.
Blast
  running : Boolean
[read-only] Indicates if the counter is currently emitting particles
Blast
  startCount : Number
The number of particles to emit when the emitter starts.
Blast
Public Methods
 MethodDefined By
  
Blast(startCount:uint = 0)
The constructor creates a Blast counter for use by an emitter.
Blast
  
resume():void
Does nothing.
Blast
  
startEmitter(emitter:Emitter):uint
Initilizes the counter.
Blast
  
stop():void
Does nothing.
Blast
  
updateEmitter(emitter:Emitter, time:Number):uint
Returns 0 to indicate that no particles should be emitted after the initial blast.
Blast
Property Detail
completeproperty
complete:Boolean  [read-only]

Indicates if the counter has emitted all its particles.


Implementation
    public function get complete():Boolean
runningproperty 
running:Boolean  [read-only]

Indicates if the counter is currently emitting particles


Implementation
    public function get running():Boolean
startCountproperty 
startCount:Number

The number of particles to emit when the emitter starts.


Implementation
    public function get startCount():Number
    public function set startCount(value:Number):void
Constructor Detail
Blast()Constructor
public function Blast(startCount:uint = 0)

The constructor creates a Blast counter for use by an emitter. To add a Blast counter to an emitter use the emitter's counter property.

Parameters
startCount:uint (default = 0) — The number of particles to emit when the emitter starts.

See also

org.flintparticles.common.emitter.Emitter.counter
Method Detail
resume()method
public function resume():void

Does nothing. Since the blast counter emits a single blast and then stops, stopping and resuming it changes nothing.

startEmitter()method 
public function startEmitter(emitter:Emitter):uint

Initilizes the counter. Returns startCount to indicate that the emitter should emit that many particles when it starts.

This method is called within the emitter's start method and need not be called by the user.

Parameters

emitter:Emitter — The emitter.

Returns
uint — the value of startCount.

See also

stop()method 
public function stop():void

Does nothing. Since the blast counter emits a single blast and then stops, stopping it changes nothing.

updateEmitter()method 
public function updateEmitter(emitter:Emitter, time:Number):uint

Returns 0 to indicate that no particles should be emitted after the initial blast.

This method is called within the emitter's update loop and need not be called by the user.

Parameters

emitter:Emitter — The emitter.
 
time:Number — The time, in seconds, since the previous call to this method.

Returns
uint — 0

See also