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

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.

Default MXML Propertyinitializers

See also

org.flintparticles.common.initializers.InitializerGroup

Public Properties
 PropertyDefined By
  initializers : Array
[write-only]
ChooseInitializer
 Inheritedpriority : int
Returns a default priority of 0 for this action.
InitializerBase
  weights : Array
[write-only]
ChooseInitializer
Protected Properties
 PropertyDefined By
 Inherited_priority : int = 0
InitializerBase
Public Methods
 MethodDefined By
  
ChooseInitializer(initializers:Array = null, weights:Array = null)
The constructor creates a ChooseInitializer initializer for use by an emitter.
ChooseInitializer
  
addedToEmitter(emitter:Emitter):void
[override]
ChooseInitializer
  
addInitializer(initializer:Initializer, weight:Number = 1):void
ChooseInitializer
  
initialize(emitter:Emitter, particle:Particle):void
[override] This method does nothing.
ChooseInitializer
 Inherited
removedFromEmitter(emitter:Emitter):void
This method does nothing.
InitializerBase
  
removeInitializer(initializer:Initializer):void
ChooseInitializer
Property Detail
initializersproperty
initializers:Array  [write-only]


Implementation
    public function set initializers(value:Array):void
weightsproperty 
weights:Array  [write-only]


Implementation
    public function set weights(value:Array):void
Constructor Detail
ChooseInitializer()Constructor
public function ChooseInitializer(initializers:Array = null, 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 (default = null) — 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

org.flintparticles.common.emitters.Emitter.addInitializer()
Method Detail
addedToEmitter()method
override public function addedToEmitter(emitter:Emitter):void

Parameters

emitter:Emitter

addInitializer()method 
public function addInitializer(initializer:Initializer, weight:Number = 1):void

Parameters

initializer:Initializer
 
weight:Number (default = 1)

initialize()method 
override public 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:Initializer):void

Parameters

initializer:Initializer




© Richard Lord 2008-2011

Sun Feb 27 2011, 06:00 PM Z