Packageorg.flintparticles.common.initializers
Classpublic class ChooseInitializer
InheritanceChooseInitializer Inheritance InitializerBase

The ChooseInitializer initializer selects one of multiple initializers, using optional weighting values to produce an uneven distribution for the choice, and applies it to the particle. This is often used with the InitializerGroup initializer to apply a randomly chosen group of initializers to the particle.

See also

org.flintparticles.common.initializers.InitializerGroup


Public Methods
 MethodDefined by
  
ChooseInitializer(initializers:Array, weights:Array = null)
The constructor creates a ChooseInitializer initializer for use by an emitter.
ChooseInitializer
 Inherited
addedToEmitter(emitter:Emitter):void
This method does nothing.
InitializerBase
  
addInitializer(initializer:Number, weight:Number = 1):void
ChooseInitializer
 Inherited
Returns a default priority of 0 for this action.
InitializerBase
  
initialize(emitter:Emitter, particle:Particle):void
This method does nothing.
ChooseInitializer
 Inherited
This method does nothing.
InitializerBase
  
removeInitializer(initializer:Number):void
ChooseInitializer
Constructor detail
ChooseInitializer()constructor
public function ChooseInitializer(initializers:Array, weights:Array = null)

The constructor creates a ChooseInitializer initializer for use by an emitter. To add a ChooseInitializer to an emitter, use the emitter's addInitializer method.

Parameters
initializers:Array — An array containing the Initializers to use.
 
weights:Array (default = null) — The weighting to apply to each initializer. If no weighting values are passed, the initializers are all assigned a weighting of 1.

See also

Method detail
addInitializer()method
public function addInitializer(initializer:Number, weight:Number = 1):voidParameters
initializer:Number
 
weight:Number (default = 1)
initialize()method 
public override function initialize(emitter:Emitter, particle:Particle):void

This method does nothing. All derived classes override this method to initialize each particle created by the emitter.

Parameters
emitter:Emitter
 
particle:Particle
removeInitializer()method 
public function removeInitializer(initializer:Number):voidParameters
initializer:Number