Partigen Class

Inheritance > Partigen

ActionScript Class Name com.desuade.partigen.Partigen

Partigen is the main engine that manages all the emitters. The entire class is static, and is automatically initialized and ready to go.

To use Partigen, you must drag the Partigen component from the Components panel from within Flash, regardless if you use the IDE or AS to create emitters. This must be placed on any frame before any calls to the class or an Emitter component..

Method summary for the Partigen Class

Method	Description
`Partigen.createEmitter()`	Creates a Partigen Emitter.
`Partigen.duplicateEmitter()`	Duplicates a Partigen Emitter.
`Partigen.getAllEmitters()`	Returns a property or a comparison of values from all emitters.
`Partigen.removeEmitter()`	Reomves the emitter and optionally all child particles.
`Partigen.resolveID()`	Returns a full path from an ID.
`Partigen.setAllEmitters()`	Performs the same function or sets the same property to all emitters.

Property summary for the Partigen Class

Property	Description
`Partigen._defaultease`	The default tween ease for created emitters.
`Partigen._defaultmode`	The default mode for created emitters.
`Partigen._defaultsource`	The default sprite source for created emitters.
`Partigen._emitters`	An array with all current emitters and their corresponding IDs.
`Partigen._events`	The events object is responsible for turning on and off events.
`Partigen._idle`	Current status if the user is idle.
`Partigen._idletimeout`	Timeout to set _idle and to stop all emitters.
`Partigen._output`	Output level to display traces.
`Partigen._useinterval`	Use an interval for emissions.

Event summary for the Partigen Class

Event	Description
`Partigen.onBirth`	Defines a function to do every time a particle is born.
`Partigen.onDeath`	Defines a function to do everytime a particle dies.
`Partigen.onIdle`	Defines a function to do everytime the user goes idle along with stopping active emitters.
`Partigen.onReturn`	Defines a function to do everytime the user returns from being idle along with starting previously stopped emitters.
`Partigen.onTweenEnd`	Defines a function to do everytime a particle finishes tweening.

Documentation generated by BLDoc Community Edition from B-Line Express.