ecspresso
    Preparing search index...

    Interface ParticleEffectInput

    User-facing config input for defining a particle effect. All properties optional except maxParticles and texture.

    interface ParticleEffectInput {
        angle?: ParticleValue;
        blendMode?: ParticleBlendMode;
        burstCount?: number;
        duration?: number;
        emissionRadius?: number;
        emissionShape?: EmissionShape;
        endAlpha?: ParticleValue;
        endSize?: ParticleValue;
        endTint?: number;
        gravity?: { x: number; y: number };
        lifetime?: ParticleValue;
        maxParticles: number;
        rotationSpeed?: ParticleValue;
        spawnRate?: number;
        speed?: ParticleValue;
        startAlpha?: ParticleValue;
        startRotation?: ParticleValue;
        startSize?: ParticleValue;
        startTint?: number;
        texture: unknown;
        worldSpace?: boolean;
    }
    Index

    Properties

    angle? blendMode? burstCount? duration? emissionRadius? emissionShape? endAlpha? endSize? endTint? gravity? lifetime? maxParticles rotationSpeed? spawnRate? speed? startAlpha? startRotation? startSize? startTint? texture worldSpace?

    Properties

    angle?: ParticleValue

    Emission direction in radians (default: [0, 2*PI])

    blendMode?: ParticleBlendMode

    Blend mode (default: 'normal')

    burstCount?: number

    Particles per burst (default: 0)

    duration?: number

    Emitter lifetime in seconds (-1 = infinite, default: -1)

    emissionRadius?: number

    Radius for 'circle' shape (default: 0)

    emissionShape?: EmissionShape

    Spawn geometry (default: 'point')

    endAlpha?: ParticleValue

    Final opacity (default: 0)

    endSize?: ParticleValue

    Final scale (default: same as startSize)

    endTint?: number

    Final hex color (default: same as startTint)

    gravity?: { x: number; y: number }

    Acceleration in pixels/second^2 (default: {x: 0, y: 0})

    lifetime?: ParticleValue

    Per-particle lifetime in seconds (default: 1)

    maxParticles: number

    Pool size — maximum simultaneous particles

    rotationSpeed?: ParticleValue

    Rotation velocity in rad/s (default: 0)

    spawnRate?: number

    Particles per second (0 = burst-only, default: 10)

    speed?: ParticleValue

    Initial speed in pixels/second (default: 100)

    startAlpha?: ParticleValue

    Initial opacity (default: 1)

    startRotation?: ParticleValue

    Initial rotation in radians (default: 0)

    startSize?: ParticleValue

    Initial scale (default: 1)

    startTint?: number

    Initial hex color (default: 0xffffff)

    texture: unknown

    PixiJS Texture for particles

    worldSpace?: boolean

    Particles in world coordinates (default: true)

    Settings

    Member Visibility

    On This Page

    Properties