Packageorg.flintparticles.actions
Classpublic class ZonedAction
InheritanceZonedAction Inheritance Action

The ZonedAction Action applies an action to the particle only if it is in the specified zone.


Public Properties
 PropertyDefined by
  action : Action
The action to apply when inside the zone.
ZonedAction
  invertZone : Boolean
If false (the default), the action is applied to particles inside the zone.
ZonedAction
  zone : Zone
The zone in which to apply the acceleration.
ZonedAction
Public Methods
 MethodDefined by
  
ZonedAction(action:Action, zone:Zone, invertZone:Boolean = false)
The constructor creates a ZonedAction action for use by an emitter.
ZonedAction
  
addedToEmitter(emitter:Emitter):void
The addedToEmitter method is called by the emitter when the Action is added to it It is called within the emitter's addAction method and need not be called by the user.
ZonedAction
  
getDefaultPriority():Number
The getDefaultPriority method is used to order the execution of actions.
ZonedAction
  
removedFromEmitter(emitter:Emitter):void
The removedFromEmitter method is called by the emitter when the Action is removed from it It is called within the emitter's removeAction method and need not be called by the user.
ZonedAction
  
update(emitter:Emitter, particle:Particle, time:Number):void
The update method is used by the emitter to apply the action to every particle.
ZonedAction
Property detail
actionproperty
action:Action  [read-write]

The action to apply when inside the zone.

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

If false (the default), the action is applied to particles inside the zone. If true, the action is applied to particles outside the zone.

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

The zone in which to apply the acceleration.

Implementation
    public function get zone():Zone
    public function set zone(value:Zone):void
Constructor detail
ZonedAction()constructor
public function ZonedAction(action:Action, zone:Zone, invertZone:Boolean = false)

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

Parameters
action:Action — The action to apply when inside the zone.
 
zone:Zone — The zone in which to apply the action.
 
invertZone:Boolean (default = false) — If false (the default) the action is applied only to particles inside the zone. If true the action is applied only to particles outside the zone.

See also

org.flintparticles.emitters.Emitter.addAction()
Method detail
addedToEmitter()method
public override function addedToEmitter(emitter:Emitter):void

The addedToEmitter method is called by the emitter when the Action is added to it It is called within the emitter's addAction method and need not be called by the user.

Parameters
emitter:Emitter — The Emitter that the Action was added to.
getDefaultPriority()method 
public override function getDefaultPriority():Number

The getDefaultPriority method is used to order the execution of actions. It is called within the emitter's addAction method when the user doesn't manually set a priority. It need not be called directly by the user.

Returns
Number
removedFromEmitter()method 
public override function removedFromEmitter(emitter:Emitter):void

The removedFromEmitter method is called by the emitter when the Action is removed from it It is called within the emitter's removeAction method and need not be called by the user.

Parameters
emitter:Emitter — The Emitter that the Action was removed from.
update()method 
public override function update(emitter:Emitter, particle:Particle, time:Number):void

The update method is used by the emitter to apply the action to every particle. It is called within the emitter's update loop and need not be called by the user.

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.