| Package | org.flintparticles.twoD.actions |
| Class | public class ZonedAction |
| Inheritance | ZonedAction  ActionBase Object |
| Package | org.flintparticles.twoD.actions |
| Class | public class ZonedAction |
| Inheritance | ZonedAction ActionBase Object |
| Property | Defined By | ||
|---|---|---|---|
| action : Action
The action to apply when inside the zone. | ZonedAction | ||
| invertZone : Boolean
If false (the default), the action is applied only to particles inside
the zone. | ZonedAction | ||
| priority : int [override]
Provides acces to the priority of the action being used. | ZonedAction | ||
| zone : Zone2D
The zone in which to apply the acceleration. | ZonedAction | ||
| Method | Defined By | ||
|---|---|---|---|
The constructor creates a ZonedAction action for use by an emitter. | ZonedAction | ||
addedToEmitter(emitter:Emitter):void [override]
Calls the addedToEmitter method of the action being used. | ZonedAction | ||
removedFromEmitter(emitter:Emitter):void [override]
Calls the removedFromEmitter method of the action being used. | ZonedAction | ||
[override]
Checks if the particle is in the zone and if so calls the update
method of the action being used. | ZonedAction | ||
| action | property |
Hide Inherited Protected Properties
Show Inherited Protected Properties
action:ActionThe action to apply when inside the zone.
public function get action():Action public function set action(value:Action):void| invertZone | property |
invertZone:BooleanIf 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.
public function get invertZone():Boolean public function set invertZone(value:Boolean):void| priority | property |
priority:int[override] Provides acces to the priority of the action being used.
public function get priority():int public function set priority(value:int):voidSee also
| zone | property |
zone:Zone2DThe zone in which to apply the acceleration.
public function get zone():Zone2D public function set zone(value:Zone2D):void| ZonedAction | () | Constructor |
public function ZonedAction(action:Action = null, zone:Zone2D = null, 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.
Parametersaction:Action (default = null) | |
zone:Zone2D (default = null) | |
invertZone:Boolean (default = false) |
See also
| addedToEmitter | () | method |
override public function addedToEmitter(emitter:Emitter):voidCalls the addedToEmitter method of the action being used.
Parameters
emitter:Emitter — The emitter this action has been added to.
|
See also
| removedFromEmitter | () | method |
override public function removedFromEmitter(emitter:Emitter):voidCalls the removedFromEmitter method of the action being used.
Parameters
emitter:Emitter — The emitter this action has been added to.
|
See also
| update | () | method |
override public function update(emitter:Emitter, particle:Particle, time:Number):voidChecks if the particle is in the zone and if so calls the update method of the action being used.
This method is called by the emitter 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.
|
See also