| Package | org.flintparticles.common.counters |
| Class | public class Pulse |
| Inheritance | Pulse  Object |
| Implements | Counter |
| Package | org.flintparticles.common.counters |
| Class | public class Pulse |
| Inheritance | Pulse Object |
| Implements | Counter |
| Property | Defined By | ||
|---|---|---|---|
| complete : Boolean [read-only]
Indicates if the counter has emitted all its particles. | Pulse | ||
| period : Number
The time, in seconds, between each pulse. | Pulse | ||
| quantity : uint
The number of particles to emit at each pulse. | Pulse | ||
| running : Boolean [read-only]
Indicates if the counter is currently emitting particles
| Pulse | ||
| Method | Defined By | ||
|---|---|---|---|
Pulse(period:Number = 1, quantity:uint = 0)
The constructor creates a Pulse counter for use by an emitter. | Pulse | ||
resume():void
Resumes the emitter after a stop
| Pulse | ||
startEmitter(emitter:Emitter):uint
Initilizes the counter. | Pulse | ||
stop():void
Stops the emitter from emitting particles
| Pulse | ||
updateEmitter(emitter:Emitter, time:Number):uint
Uses the time, period and quantity to calculate how many
particles the emitter should emit now. | Pulse | ||
| complete | property |
complete:Boolean [read-only] Indicates if the counter has emitted all its particles. For this counter this will always be false.
public function get complete():Boolean| period | property |
period:NumberThe time, in seconds, between each pulse.
public function get period():Number public function set period(value:Number):void| quantity | property |
quantity:uintThe number of particles to emit at each pulse.
public function get quantity():uint public function set quantity(value:uint):void| running | property |
running:Boolean [read-only] Indicates if the counter is currently emitting particles
public function get running():Boolean| Pulse | () | Constructor |
public function Pulse(period:Number = 1, quantity:uint = 0)The constructor creates a Pulse counter for use by an emitter. To add a Pulse counter to an emitter use the emitter's counter property.
Parametersperiod:Number (default = 1) | |
quantity:uint (default = 0) |
See also
| resume | () | method |
public function resume():voidResumes the emitter after a stop
| startEmitter | () | method |
public function startEmitter(emitter:Emitter):uintInitilizes the counter. Returns 0 to indicate that the emitter should emit no 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.
|
uint — 0
|
See also
| stop | () | method |
public function stop():voidStops the emitter from emitting particles
| updateEmitter | () | method |
public function updateEmitter(emitter:Emitter, time:Number):uintUses the time, period and quantity to calculate how many particles the emitter should emit now.
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.
|
uint — the number of particles the emitter should create.
|
See also