AutoMovie API
    Preparing search index...

    Interface IAutoMovieEffectRecipe

    Seeded environmental billboard emitter with explicit transport and live-instance budgets. Fog, smoke and dust share the same bounded stream representation.

    interface IAutoMovieEffectRecipe {
        blend: "alpha";
        budget: { lodDistance: number; maxParticles: number };
        emission: { burst: number; duration: number; rate: number };
        id: string;
        kind: "fog" | "smoke" | "dust" | "spray";
        motion: {
            ballistic?: {
                floor: number;
                gravity: number;
                retainStains: boolean;
                stainSizeMultiplier?: number;
                velocitySpread?: IAutoMovieVector3;
            };
            rise: number;
            turbulence: number;
            wind: IAutoMovieVector3;
        };
        particle: {
            color: string;
            lifetime: { max: number; min: number };
            opacity: { envelope?: "constant" | "sine"; max: number; min: number };
            size: { end?: number; max: number; min: number };
        };
        seed: number;
    }
    Index
    blend: "alpha"

    Only supported transparency law.

    budget: { lodDistance: number; maxParticles: number }

    Hard runtime and LOD budgets.

    Type Declaration

    • lodDistance: number

      Finite thinning distance in metres, within [0.1, 2000].

    • maxParticles: number

      Integer maximum live billboard instances, within [1, 4096].

    emission: { burst: number; duration: number; rate: number }

    Bounded deterministic emission.

    Type Declaration

    • burst: number

      Integer particles emitted at cue start, within [0, 4096].

    • duration: number

      Finite emitting duration in seconds, within [1 / 240, 60].

    • rate: number

      Finite particles per second, within [0, 1024].

    id: string

    Stable recipe id.

    kind: "fog" | "smoke" | "dust" | "spray"

    Supported primitive effect family.

    motion: {
        ballistic?: {
            floor: number;
            gravity: number;
            retainStains: boolean;
            stainSizeMultiplier?: number;
            velocitySpread?: IAutoMovieVector3;
        };
        rise: number;
        turbulence: number;
        wind: IAutoMovieVector3;
    }

    Bounded deterministic transport.

    Type Declaration

    • Optionalballistic?: {
          floor: number;
          gravity: number;
          retainStains: boolean;
          stainSizeMultiplier?: number;
          velocitySpread?: IAutoMovieVector3;
      }

      Optional ballistic transport; omission preserves the original v1 stream.

      • floor: number

        Horizontal landing plane, world metres.

      • gravity: number

        Nonnegative downward acceleration, m/s².

      • retainStains: boolean

        Keep particles which land before their lifetime expires as floor-facing stains through the cue end.

      • OptionalstainSizeMultiplier?: number

        Landed billboard size multiplier, (0,16]; omission retains its airborne size.

      • OptionalvelocitySpread?: IAutoMovieVector3

        Independent world-axis initial velocity half-ranges, m/s, each 0..50; omission adds no spread.

    • rise: number

      Finite additional upward metres per second, within [-50, 50].

    • turbulence: number

      Finite maximum lateral velocity deviation in metres per second, within [0, 50].

    • wind: IAutoMovieVector3

      Finite world velocity components in metres per second, each within [-50, 50].

    particle: {
        color: string;
        lifetime: { max: number; min: number };
        opacity: { envelope?: "constant" | "sine"; max: number; min: number };
        size: { end?: number; max: number; min: number };
    }

    Bounded billboard appearance.

    Type Declaration

    • color: string

      Exact opaque hexadecimal RGB color.

    • lifetime: { max: number; min: number }

      Ordered inclusive lifetime endpoints in seconds, within [1 / 240, 30].

      • max: number

        Longest sampled lifetime, seconds, at least min.

      • min: number

        Shortest sampled lifetime, seconds.

    • opacity: { envelope?: "constant" | "sine"; max: number; min: number }

      Inclusive alpha range from zero through one.

      • Optionalenvelope?: "constant" | "sine"

        Alpha over a live particle's lifetime; defaults to the original sine envelope.

      • max: number

        Upper unitless sampled alpha, within [min, 1].

      • min: number

        Lower unitless sampled alpha, within [0, 1].

    • size: { end?: number; max: number; min: number }

      Ordered inclusive initial world-size endpoints in metres, within [0.01, 20].

      • Optionalend?: number

        Final airborne billboard extent in metres, from max through 20. The extent grows linearly from its seeded initial size over the particle lifetime, or stops growing on landing. Omit for fixed size.

      • max: number

        Largest sampled billboard extent, world metres, at least min.

      • min: number

        Smallest sampled billboard extent, world metres.

    seed: number

    Explicit nonnegative safe-integer deterministic seed.