Packageorg.flintparticles.common.actions
Classpublic class ColorChange
InheritanceColorChange Inheritance ActionBase Inheritance Object

The ColorChange action alters the color of the particle as it ages. It uses the particle's energy level to decide what colour to display.

Usually a particle's energy changes from 1 to 0 over its lifetime, but this can be altered via the easing function set within the age action.

This action should be used in conjunction with the Age action.

See also

org.flintparticles.common.actions.Action
org.flintparticles.common.actions.Age


Public Properties
 PropertyDefined By
  endColor : uint
The color of the particle when its energy is zero.
ColorChange
 Inheritedpriority : int
Returns a default priority of 0 for this action.
ActionBase
  startColor : uint
The color of the particle when its energy is 1.
ColorChange
Protected Properties
 PropertyDefined By
 Inherited_priority : int = 0
ActionBase
Public Methods
 MethodDefined By
  
ColorChange(startColor:uint = 0xFFFFFF, endColor:uint = 0xFFFFFF)
The constructor creates a ColorChange action for use by an emitter.
ColorChange
 Inherited
addedToEmitter(emitter:Emitter):void
This method does nothing.
ActionBase
 Inherited
This method does nothing.
ActionBase
  
update(emitter:Emitter, particle:Particle, time:Number):void
[override] Sets the color of the particle based on the colors and the particle's energy level.
ColorChange
Property Detail
endColorproperty
endColor:uint

The color of the particle when its energy is zero.


Implementation
    public function get endColor():uint
    public function set endColor(value:uint):void
startColorproperty 
startColor:uint

The color of the particle when its energy is 1.


Implementation
    public function get startColor():uint
    public function set startColor(value:uint):void
Constructor Detail
ColorChange()Constructor
public function ColorChange(startColor:uint = 0xFFFFFF, endColor:uint = 0xFFFFFF)

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

Parameters
startColor:uint (default = 0xFFFFFF) — The 32bit (ARGB) color of the particle when its energy is 1 - usually at the beginning of its life.
 
endColor:uint (default = 0xFFFFFF) — The 32bit (ARGB) color of the particle when its energy is 0 - usually at the end of its life.

See also

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

Sets the color of the particle based on the colors and the particle's energy level.

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