Particles

Inherits Dynamic

Particles represents a particle system that can be used to create various visual effects.

Properties

Playing : boolean

Determines if particles should be emitting.

Image : ImageAsset

The image used for the particles.

Color : ColorSeries

The color gradient used for the particles.

Lifetime : NumberRange

Determines the lifetime of a particle.

Amount : number

Determines the number of particles emitted.

Gravity : Vector3

Determines the gravity effect applied to the particles.

VelocityDirection : Vector3

Determines the velocity direction

InitialVelocity : NumberRange

Determines the initial velocity

Spread : number

Determines the spread angle of the velocity

Flatness : number

Determines how flat the spread angle should be

Scale : NumberRange

Determine the initial scale range

HueVariation : NumberRange

Determine the hue variation

BlendMode : BlendMode

Determines the blend mode of the particle.

Shaded : boolean

Determines whether the particles are shaded.

EmissionShape : ParticleEmissionShape

Determines the emission shape of this particle

EmissionShapeScale : Vector3

Determines the emission shape's scale

SimulationSpace : ParticleSimulationSpace

Whether the particles are simulated in world or local space.

Methods

Play → nil

Parameters: ``

Starts playing the particle system.

Stop → nil

Parameters: ``

Stops playing the particle system.

Emit → nil

Parameters: count [ number ]

Emits a specified number of particles immediately.