Packageorg.flintparticles.common.actions
Classpublic class ChangeMass
InheritanceChangeMass Inheritance ActionBase Inheritance Object

The ChangeMass action adjusts the mass of the particle as it ages. It uses the particle's energy level to decide what mass the particle should be.

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
  endMass : Number
The mass for the particle when its energy is 0 - usually at the end of its lifetime.
ChangeMass
 Inheritedpriority : int
Returns a default priority of 0 for this action.
ActionBase
  startMass : Number
The mass for the particle when its energy is 1 - usually at the start of its lifetime.
ChangeMass
Protected Properties
 PropertyDefined By
 Inherited_priority : int = 0
ActionBase
Public Methods
 MethodDefined By
  
ChangeMass(startMass:Number = 1, endMass:Number = 1)
The constructor creates a ChangeMass action for use by an emitter.
ChangeMass
 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 mass of the particle based on the values defined and the particle's energy level.
ChangeMass
Property Detail
endMassproperty
endMass:Number

The mass for the particle when its energy is 0 - usually at the end of its lifetime.


Implementation
    public function get endMass():Number
    public function set endMass(value:Number):void
startMassproperty 
startMass:Number

The mass for the particle when its energy is 1 - usually at the start of its lifetime.


Implementation
    public function get startMass():Number
    public function set startMass(value:Number):void
Constructor Detail
ChangeMass()Constructor
public function ChangeMass(startMass:Number = 1, endMass:Number = 1)

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

Parameters
startMass:Number (default = 1) — The mass for the particle when its energy is 1 - usually at the start of its lifetime.
 
endMass:Number (default = 1) — The mass for the particle when its energy is 0 - usually at the end of its lifetime.

See also

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

Sets the mass of the particle based on the values defined 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