Particulator class

Inheritance AS2 Movie Clip > UIObject > UIComponent > Particulator
Inheritance AS3 DisplayObjectContainer > Sprite > UIComponent > Particulator

(see flash help for documentation on parent classes).

ActionScript Class Name AS2 flextnet.components.Particulator
ActionScript Class Name AS3 flextnet.components.as3.Particulator

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(flextnet.components.Particulator.version);

Note: The code trace(myCmp.version); returns undefined.

Method summary for the Particulator class

Besides methods in parent classes, you can call the following methods on an Particulator component:

Method	Description
`removeAllParticles()`	Removes all current 'live' particles from the scene.

Property summary for the Particulator class

These are the properties of the Particulator class:

Property	Description
`alphaFadeStartPct`	Percentage of life span used to indicate when to begin fading each particle's alpha to 0.
`alphaRandom`	Percentage value used to randomize initial alpha value.
`depthFactor`	Percentage value used to add the illusion of depth to particles.
`emitterStage`	MovieClip to be used as a container to emit particles.
`emitterType`	Specifies an bounding area for emitting particles.
`gustDuration`	Seconds duration for a random gust of wind.
`gustFrequency`	Seconds between random gusts of wind.
`gravity`	Force of gravity acceleration in pixels per second per second.
`initialAlpha`	Initial percentage alpha value for each created particle.
`lifeSpan`	Life span in seconds for each emitted particle.
`lifeSpanRandom`	Percentage value used to randomize the life span of each particle.
`motionGuider`	Movie clip used to determine component's velocity.
`particles`	Read-only; array of currently active particles.
`particleMcPool`	Array of movie clip linkage ids or class names to be used as particles.
`particlesPerSecond`	Number of particles emitted per second. Set this to 0 to turn off the generator.
`particleSize`	Percentage scale value of each movie clip used as particles.
`particleSizeRandom`	Percentage value used to randomize the size of each particle.
`rotationSpeed`	Rotation velocity of particles in angles per second.
`rotationSpeedRandom`	Percentage values used to randomize rotation speed.
`velocityFromMotion`	Percentage for which particle velocity follows the motion guider.
`velocityMagnitude`	Magnitude of velocity for particles in pixels per second.
`velocityRandom`	Percentage value used to randomize particle velocity.
`windDirection`	Angle of wind applied to all active particles.
`windForce`	Velocity of wind applied to particles in pixels per second.
`windSwirl`	Percentage of wind swirl to apply.
`windTurbulence`	Percentage of wind turbulence.