Strata - v1.4.10
    Preparing search index...

    Interface ParticleBurstProps

    Props for the ParticleBurst component.

    interface ParticleBurstProps {
        behavior?: ParticleBehavior;
        blending?: Blending;
        count?: number;
        depthWrite?: boolean;
        endColor?: ColorRepresentation;
        endOpacity?: number;
        endSize?: number;
        forces?: ParticleForces;
        lifetime?: number;
        lifetimeVariance?: number;
        maxParticles?: number;
        onComplete?: () => void;
        paused?: boolean;
        position?: [number, number, number] | Vector3;
        positionVariance?: [number, number, number] | Vector3;
        shape?: EmissionShape;
        shapeParams?: EmitterShapeParams;
        sizeVariance?: number;
        sortParticles?: boolean;
        startColor?: ColorRepresentation;
        startOpacity?: number;
        startSize?: number;
        texture?: Texture<unknown>;
        trigger?: number | boolean;
        velocity?: [number, number, number] | Vector3;
        velocityVariance?: [number, number, number] | Vector3;
    }

    Hierarchy

    Index

    Properties

    behavior? blending? count? depthWrite? endColor? endOpacity? endSize? forces? lifetime? lifetimeVariance? maxParticles? onComplete? paused? position? positionVariance? shape? shapeParams? sizeVariance? sortParticles? startColor? startOpacity? startSize? texture? trigger? velocity? velocityVariance?

    Properties

    behavior?: ParticleBehavior

    Behavioral modifiers like attraction or color pulsing.

    blending?: Blending

    GPU blending mode for particles. Default: AdditiveBlending.

    count?: number

    Number of particles to emit in the burst. Default: 100.

    depthWrite?: boolean

    Whether particles should write to the depth buffer. Default: false.

    endColor?: ColorRepresentation

    Final color of particles before death. Default: white.

    endOpacity?: number

    Final opacity of particles before death (0-1). Default: 0.0.

    endSize?: number

    Final size of particles before death. Default: 0.05.

    forces?: ParticleForces

    External physics forces like gravity, wind, or turbulence.

    lifetime?: number

    Base lifetime of a particle in seconds. Default: 2.0.

    lifetimeVariance?: number

    Random variance applied to particle lifetime. Default: 0.2.

    maxParticles?: number

    Maximum number of simultaneous particles in the system. Default: 1000.

    onComplete?: () => void

    Callback fired when all particles from the burst have died.

    paused?: boolean

    Whether emission is currently paused. Default: false.

    position?: [number, number, number] | Vector3

    Emitter position in world space. Default: [0, 0, 0].

    positionVariance?: [number, number, number] | Vector3

    Random variance applied to particle spawn positions. Default: [0, 0, 0].

    shape?: EmissionShape

    Shape of the emission volume ('point', 'sphere', 'box', 'cone', 'disk'). Default: 'point'.

    shapeParams?: EmitterShapeParams

    Specific parameters for the chosen emission shape (e.g., radius, angle).

    sizeVariance?: number

    Random variance applied to particle size. Default: 0.2.

    sortParticles?: boolean

    Whether to sort particles by distance for correct transparency. Default: false.

    startColor?: ColorRepresentation

    Initial color of particles at spawn. Default: white.

    startOpacity?: number

    Initial opacity of particles at spawn (0-1). Default: 1.0.

    startSize?: number

    Initial size of particles at spawn. Default: 0.1.

    texture?: Texture<unknown>

    Optional texture for particle sprites.

    trigger?: number | boolean

    When this value changes to truthy, a burst is triggered.

    velocity?: [number, number, number] | Vector3

    Initial velocity direction and speed for particles. Default: [0, 1, 0].

    velocityVariance?: [number, number, number] | Vector3

    Random variance applied to initial particle velocity. Default: [0.5, 0.5, 0.5].

    Settings

    Member Visibility

    On This Page

    Properties