timelinefx:timelinefx.tlEffect
Class tlEffect Extends tlFXObject
The effect class which is the main parent class for emitters. Effect types are the main containers for emitters and has a set of global attributes that can affect any emitters it stores. The basic entity structure of an effect is: Effect -> Emitter(s) -> Particle(s)
Public Fields
OnUpdate A function to call on every update of the effect
Public Properties
CurrentSizeX
Data Use this to store and retrieve some data in the effect
Directory Get the effect directory
DistanceSetByLife Set to true to make the distance travelled determined by the life of the particle.
DoNotTimeOut Get/Set whehter or not the effect times out
EffectClass The effect class, being one of tlPOINTEFFECT, tlLINEEFFECT, tlAREAEFFECT, tlELLIPSEEFFECT
EffectLength Set the length of the effect
EllipseArc Set range in degrees of the arc
EllipseOffset Offset where the ellipse arc starts from.
EmissionType Set the emission type
EmitatPoints Sets whether the effect should emit at points
EndBehaviour Set the end behaviour of particles traversing a line
IdleTime Set the amount of time before idle effects are deleted from the particle manager
MaxGX Get/Set maximum width grid points
MaxGY Get/Set maximum height grid points
ParentEmitter Get the parent emitter of the effect
ParticleCount Get the Particle number of particles within this effect.
ParticleManager Set the effects particle manager
ReverseSpawnDirection Set the order particles spawn
SpawnDirection This sets the direction particles are spawned.
TraverseEdge Set to true for particles to traverse line type effects
Uniform Set Uniform
Public Constructors
New Constructor for the effect. Use this to create a new effect from scratch.
Public Methods
GetEffect Retrieve an effect from the directory of the effect
GetEmitter Retrieve an emitter from the directory of the effect
HardKill Hard kill an effect
SetAmount Set the Global attribute Amount of the effect
SetAreaSize Set the area size of the effect
SetEffectAlpha Set the Global attribute Alpha of the effect
SetEffectAngle Set the Angle of the effect
SetEffectEmissionRange Set the Global attribute EmissionRange of the effect
SetEffectParticleSize Set the Global attribute Sizex of the effect
SetEmissionAngle Set the Emission Angle of the effect
SetGlobalZoom Set the current zoom level of the effect
SetLife Set the Global attribute Life of the effect
SetLineLength Set the line length of the effect
SetSize Set the Global attribute Sizex and Sizey of the effect
SetSizeX Set the Global attribute Sizex of the effect
SetSizeY Set the Global attribute Sizey of the effect
SetSpin Set the Global attribute Spin of the effect
SetStretch Set the Global attribute Stretch of the effect
SetVelocity Set the Global attribute velocity of the effect
SetWeight Set the Global attribute Weight of the effect
SetZ Set the current zoom level of the effect
SoftKill Softly kill an effect
Update