Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface VFXParticleGeneratorData

    interface VFXParticleGeneratorData {
        alpha: { max: number; min: number };
        area: object | null;
        blend: number;
        config: object;
        count: number;
        duration?: number;
        elevation: number;
        fade: { in: number; out: number } | null;
        initial: number;
        lifetime: { max: number | null; min: number };
        mode: string;
        perFrame: number;
        rotationSpeed: number;
        scale: { max: number; min: number };
        sort: number;
        textures: string[];
        velocity: { angle: number; speed: number; x: number; y: number } | null;
    }
    Index

    Properties

    alpha area blend config count duration? elevation fade initial lifetime mode perFrame rotationSpeed scale sort textures velocity

    Properties

    alpha: { max: number; min: number }

    Alpha range [min, max] (default 1)

    area: object | null

    Spawn area; a point, rect, circle, ring, or line object. Supports reference resolution (e.g. {reference: "target"}).

    blend: number

    PIXI blend mode (default NORMAL = 0)

    config: object

    Additional ParticleGenerator configuration passed directly to the constructor. Can include orbit, follow, constraints, drift, blur, clip, anchor, callbacks, and any other ParticleGeneratorConfiguration fields. Values here override any explicitly-set schema fields of the same name.

    count: number

    Target particle count (default 50)

    duration?: number

    How long the generator runs in ms before soft-stopping to let existing particles expire. If absent, runs until the component is explicitly stopped.

    elevation: number

    Layer elevation for the particle container (default 0)

    fade: { in: number; out: number } | null

    Fade-in and fade-out durations in ms (default null)

    initial: number

    Proportion of count to spawn immediately on start [0, 1] (default 0.25)

    lifetime: { max: number | null; min: number }

    Particle lifetime in ms. If max is null, min is used as a fixed value. Otherwise, spawns with a random lifetime in [min, max] (default min 1000).

    mode: string

    Generator mode: "ambient" or "effect" (default "effect")

    perFrame: number

    Maximum particles spawned per frame during auto-spawn (default 5)

    rotationSpeed: number

    Rotation in degrees per second (default 0)

    scale: { max: number; min: number }

    Scale range [min, max] (default 1)

    sort: number

    Sort order within the elevation layer (default 0)

    textures: string[]

    Texture paths for particles

    velocity: { angle: number; speed: number; x: number; y: number } | null

    Initial particle velocity. Specify either x/y components or speed (px/frame) and angle (degrees). (default null)

    Settings

    Member Visibility

    On This Page

    Properties