Particle

Emission Module

EmissionModule is the emission module of ParticleGeneratorModule. This module is used to handle the emission behavior of the particle system, including particle emission rate, emission shape, and burst behavior.

avatar

Properties

PropertyDescription
rateOverTimeThis is a ParticleCompositeCurve object, representing the particle emission rate. The default value is 10.
rateOverDistanceThis is a ParticleCompositeCurve object, representing the particle distance emission rate. The default value is 0.
shapeThis is a BaseShape object, representing the shape of the emitter.

Methods

MethodDescription
addBurst(burst: Burst)Add a burst behavior
removeBurst(burst: Burst)Remove a burst behavior
removeBurstByIndex(index: number)Remove a burst behavior by index
clearBurst()Clear all burst behaviors

Shapes

Currently, the engine has the following built-in emitter shapes, providing corresponding shape auxiliary displays when the particle component is selected.

Emitter Shape TypeDescription
BoxShapeBoxShape object, emitter shape is a cube
MeshShapeMeshShape object, emitter shape is specified by selected mesh
CircleShapeCircleShape object, emitter shape is a circle
ConeShapeConeShape object, emitter shape is a cone
HemisphereShapeHemisphereShape object, emitter shape is a hemisphere
SphereShapeSphereShape object, emitter shape is a sphere

Was this page helpful?