Packageorg.flintparticles.threeD.actions
Classpublic class Jet
InheritanceJet Inheritance ActionBase

The Jet Action applies an acceleration to the particle only if it is in the specified zone.



Public Properties
 PropertyDefined by
  acceleration : Vector3D
The x coordinate of the acceleration.
Jet
  invertZone : Boolean
If true, the zone is treated as the safe area and being ouside the zone results in the particle dying.
Jet
  zone : Zone3D
The zone in which to apply the acceleration.
Jet
Public Methods
 MethodDefined by
  
Jet(acceleration:Vector3D, accelerationY:Number, zone:Zone3D, invertZone:Boolean = false)
The constructor creates a Jet action for use by an emitter.
Jet
 Inherited
addedToEmitter(emitter:Emitter):void
This method does nothing.
ActionBase
 Inherited
Returns a default priority of 0 for this action.
ActionBase
 Inherited
This method does nothing.
ActionBase
  
update(emitter:Emitter, particle:Particle, time:Number):void
This method does nothing.
Jet
Property detail
accelerationproperty
acceleration:Vector3D  [read-write]

The x coordinate of the acceleration.

Implementation
    public function get acceleration():Vector3D
    public function set acceleration(value:Vector3D):void
invertZoneproperty 
invertZone:Boolean  [read-write]

If true, the zone is treated as the safe area and being ouside the zone results in the particle dying. Otherwise, being inside the zone causes the particle to die.

Implementation
    public function get invertZone():Boolean
    public function set invertZone(value:Boolean):void
zoneproperty 
zone:Zone3D  [read-write]

The zone in which to apply the acceleration.

Implementation
    public function get zone():Zone3D
    public function set zone(value:Zone3D):void
Constructor detail
Jet()constructor
public function Jet(acceleration:Vector3D, accelerationY:Number, zone:Zone3D, invertZone:Boolean = false)

The constructor creates a Jet action for use by an emitter. To add a Jet to all particles created by an emitter, use the emitter's addAction method.

Parameters
acceleration:Vector3D — The x coordinate of the acceleration to apply, in pixels per second per second.
 
accelerationY:Number — The y coordinate of the acceleration to apply, in pixels per second per second.
 
zone:Zone3D — The zone in which to apply the acceleration.
 
invertZone:Boolean (default = false) — If false (the default) the acceleration is applied only to particles inside the zone. If true the acceleration is applied only to particles outside the zone.

See also

Method detail
update()method
public override function update(emitter:Emitter, particle:Particle, time:Number):void

This method does nothing. All derived classes override this method to update each particle every frame.

Parameters
emitter:Emitter — The Emitter that created the particle.
 
particle:Particle — The particle to be updated.
 
time:Number — The duration of the frame - used for time based updates.