Interface PBParticleSystem

Hierarchy

  • PBParticleSystem

Properties

active?: boolean

--- Emission ---

additionalForce?: PBVector3

Constant force vector applied to each particle (world space).

default = PSB_ALPHA

--- Emission Bursts ---

colorOverTime?: ColorRange

default = {white, white}. Particle color lerped from start to end over its lifetime.

faceTravelDirection?: boolean

default = false. Particles orient along their velocity direction.

gravity?: number

--- Motion ---

initialColor?: ColorRange

--- Color ---

initialRotation?: FloatRange

--- Rotation ---

initialSize?: FloatRange

--- Size ---

initialVelocitySpeed?: FloatRange

--- Velocity ---

lifetime?: number

default = 5. Particle lifetime in seconds.

--- Limit Velocity Over Lifetime ---

loop?: boolean

--- Simulation ---

maxParticles?: number

default = 1000. Maximum number of live particles.

--- Playback ---

prewarm?: boolean

default = false. Start as if already simulated for one full loop cycle. Requires loop = true.

rate?: number

default = 10. Particles emitted per second.

rotationOverTime?: FloatRange

default = {0, 0}. Angular velocity in degrees/sec, lerped over lifetime.

shape?: {
    $case: "point";
    point: PBParticleSystem_Point;
} | {
    $case: "sphere";
    sphere: PBParticleSystem_Sphere;
} | {
    $case: "cone";
    cone: PBParticleSystem_Cone;
} | {
    $case: "box";
    box: PBParticleSystem_Box;
}

default = PSS_LOCAL. Controls whether particles simulate in local or world space.

sizeOverTime?: FloatRange

default = {1, 1}. Particle size lerped from start to end over its lifetime.

--- Sprite Sheet Animation ---

texture?: Texture

--- Rendering ---