Constructor
Variables
emitterPaused:Bool
Determines whether the emitter is currently paused. It is totally safe to directly toggle this.
emitterInterval:Float
How often a particle is emitted, if currently emitting. Can be modified at the middle of an emission safely;
emitterLaunchMode:ParticlesLaunchMode
How particles should be launched. If CIRCLE
(default), particles will use launchAngle
and speed
.
Otherwise, particles will just use velocityX
and velocityY
.
emitterKeepScaleRatio:Bool
Keep the scale ratio of the particle. Uses the scaleX
value for reference.
emitterWidth:Float
The width of the emission area.
If not defined (-1
), will use visual's width bound to this ParticleEmitter
object, if any
emitterHeight:Float
The height of the emission area.
If not defined (-1
), will use visual's height bound to this ParticleEmitter
object, if any
emitterVelocityActive:Bool
Enable or disable the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterMaxVelocityX:Float
If you are using acceleration
, you can use maxVelocity
with it
to cap the speed automatically (very useful!).
emitterMaxVelocityY:Float
If you are using acceleration
, you can use maxVelocity
with it
to cap the speed automatically (very useful!).
emitterVelocityStartMinX:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityStartMinY:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityStartMaxX:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityStartMaxY:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityEndMinX:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityEndMinY:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityEndMaxX:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterVelocityEndMaxY:Float
Sets the velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
emitterSpeedStartMin:Float
Set the speed range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
emitterSpeedStartMax:Float
Set the speed range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
emitterSpeedEndMin:Float
Set the speed range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
emitterSpeedEndMax:Float
Set the speed range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
emitterMaxAngularVelocity:Float
Use in conjunction with angularAcceleration for fluid spin speed control.
emitterAngularAccelerationActive:Bool
Enable or disable the angular acceleration range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularAccelerationStartMin:Float
Set the angular acceleration range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularAccelerationStartMax:Float
Set the angular acceleration range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularDragActive:Bool
Enable or disable the angular drag range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularDragStartMin:Float
Set the angular drag range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularDragStartMax:Float
Set the angular drag range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularVelocityActive:Bool
Enable or disable the angular velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularVelocityStartMin:Float
The angular velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularVelocityStartMax:Float
The angular velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularVelocityEndMin:Float
The angular velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngularVelocityEndMax:Float
The angular velocity range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAngleActive:Bool
Enable or disable the angle range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
emitterAngleStartMin:Float
The angle range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
emitterAngleStartMax:Float
The angle range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
emitterAngleEndMin:Float
The angle range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
emitterAngleEndMax:Float
The angle range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
emitterIgnoreAngularVelocity:Bool
Set this if you want to specify the beginning and ending value of angle,
instead of using angularVelocity
(or angularAcceleration
).
emitterLaunchAngleActive:Bool
Enable or disable the angle range at which particles will be launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Ignored unless launchMode
is set to CIRCLE
.
emitterLaunchAngleMin:Float
The angle range at which particles will be launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Ignored unless launchMode
is set to CIRCLE
.
emitterLaunchAngleMax:Float
The angle range at which particles will be launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Ignored unless launchMode
is set to CIRCLE
.
emitterLifespanActive:Bool
Enable or disable the life, or duration, range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterLifespanMin:Float
The life, or duration, range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterLifespanMax:Float
The life, or duration, range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleActive:Bool
Enable or disable scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleStartMinX:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleStartMinY:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleStartMaxX:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleStartMaxY:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleEndMinX:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleEndMinY:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleEndMaxX:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterScaleEndMaxY:Float
Sets scale
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAlphaActive:Bool
Enable or disable alpha
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAlphaStartMin:Float
Sets alpha
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAlphaStartMax:Float
Sets alpha
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAlphaEndMin:Float
Sets alpha
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAlphaEndMax:Float
Sets alpha
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterColorActive:Bool
Enable or disable color
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterColorStartMin:Color
Sets color
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterColorStartMax:Color
Sets color
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterColorEndMin:Color
Sets color
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterColorEndMax:Color
Sets color
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragActive:Bool
Enable or disable X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragStartMinX:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragStartMinY:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragStartMaxX:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragStartMaxY:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragEndMinX:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragEndMinY:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragEndMaxX:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterDragEndMaxY:Float
Sets X and Y drag component of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
emitterAccelerationActive:Bool
Enable or disable the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationStartMinX:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationStartMinY:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationStartMaxX:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationStartMaxY:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationEndMinX:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationEndMinY:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationEndMaxX:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
emitterAccelerationEndMaxY:Float
Sets the acceleration
range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Set acceleration y-values to give particles gravity.
Methods
inlineemitterSize(width:Float, height:Float):Void
The width and height of the emission area.
If not defined (-1
), will use visual's width and height bound to this ParticleEmitter
object, if any
inlineemitterPos(x:Float, y:Float):Void
The x and y position of the emission, relative to particles parent (if any)
inlineemitterMaxVelocity(maxVelocityX:Float, maxVelocityY:Float):Void
If you are using acceleration
, you can use maxVelocity
with it
to cap the speed automatically (very useful!).
inlineemitterVelocityStart(startMinX:Float, startMinY:Float, ?startMaxX:Float, ?startMaxY:Float):Void
Sets the velocity starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
inlineemitterVelocityEnd(endMinX:Float, endMinY:Float, ?endMaxX:Float, ?endMaxY:Float):Void
Sets the velocity ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with SQUARE
.
inlineemitterSpeedStart(startMin:Float, ?startMax:Float):Void
Set the speed starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
inlineemitterSpeedEnd(endMin:Float, ?endMax:Float):Void
Set the speed ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end. Only used with CIRCLE
.
inlineemitterAngularAcceleration(startMin:Float, startMax:Float):Void
Set the angular acceleration range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAngularDrag(startMin:Float, startMax:Float):Void
Set the angular drag range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAngularVelocityStart(startMin:Float, ?startMax:Float):Void
The angular velocity starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAngularVelocityEnd(endMin:Float, ?endMax:Float):Void
The angular velocity ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAngleStart(startMin:Float, ?startMax:Float):Void
The angle starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
inlineemitterAngleEnd(endMin:Float, ?endMax:Float):Void
The angle ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
angleEndMin
and angleEndMax
are ignored unless ignoreAngularVelocity
is set to true
.
inlineemitterLaunchAngle(min:Float, max:Float):Void
The angle range at which particles will be launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
Ignored unless launchMode
is set to CIRCLE
.
inlineemitterLifespan(min:Float, max:Float):Void
The life, or duration, range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterScaleStart(startMinX:Float, startMinY:Float, ?startMaxX:Float, ?startMaxY:Float):Void
Sets scale
starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterScaleEnd(endMinX:Float, endMinY:Float, ?endMaxX:Float, ?endMaxY:Float):Void
Sets scale
ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAccelerationStart(startMinX:Float, startMinY:Float, ?startMaxX:Float, ?startMaxY:Float):Void
Sets acceleration
starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAccelerationEnd(endMinX:Float, endMinY:Float, ?endMaxX:Float, ?endMaxY:Float):Void
Sets acceleration
ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterDragStart(startMinX:Float, startMinY:Float, ?startMaxX:Float, ?startMaxY:Float):Void
Sets drag
starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterdragEnd(endMinX:Float, endMinY:Float, ?endMaxX:Float, ?endMaxY:Float):Void
Sets drag
ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterColorStart(startMin:Color, ?startMax:Color):Void
Sets color
starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterColorEnd(endMin:Color, ?endMax:Color):Void
Sets color
ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAlphaStart(startMin:Float, ?startMax:Float):Void
Sets alpha
starting range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.
inlineemitterAlphaEnd(endMin:Float, ?endMax:Float):Void
Sets alpha
ending range of particles launched from this #if cs (cast emitter:ParticleEmitter) #else emitter #end.