| Package | org.flintparticles.threeD.actions |
| Class | public class ZonedAction |
| Inheritance | ZonedAction ActionBase |
| Property | Defined 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 : Zone3D
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
This method does nothing.
| ZonedAction | ||
|
getDefaultPriority():Number
Returns a default priority of 0 for this action.
| ZonedAction | ||
|
removedFromEmitter(emitter:Emitter):void
This method does nothing.
| ZonedAction | ||
|
This method does nothing.
| ZonedAction | ||
| action | property |
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
| invertZone | property |
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
| zone | property |
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
| ZonedAction | () | constructor |
public function ZonedAction(action:Action, zone:Zone3D, 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 — The action to apply when inside the zone.
|
|
zone:Zone3D — 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
| addedToEmitter | () | method |
public override function addedToEmitter(emitter:Emitter):voidThis method does nothing. Some derived classes override this method to perform actions when the action is added to an emitter.
Parametersemitter:Emitter — The Emitter that the Action was added to.
|
| getDefaultPriority | () | method |
public override function getDefaultPriority():NumberReturns a default priority of 0 for this action. Derived classes override this method if they want a different default priority.
ReturnsNumber |
| removedFromEmitter | () | method |
public override function removedFromEmitter(emitter:Emitter):voidThis method does nothing. Some derived classes override this method to perform actions when the action is removed from the emitter.
Parametersemitter:Emitter — The Emitter that the Action was removed from.
|
| update | () | method |
public override function update(emitter:Emitter, particle:Particle, time:Number):voidThis method does nothing. All derived classes override this method to update each particle every frame.
Parametersemitter: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.
|