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

    Interface ParticleGeneratorOrbitOptions

    interface ParticleGeneratorOrbitOptions {
        angularSpeed?: ParticleGeneratorRange;
        direction?: 1 | -1 | "random";
        phase?: ParticleGeneratorRange;
        radialSpeed?: ParticleGeneratorRange;
        radius?: ParticleGeneratorRange | null;
        rotation?: "none" | "tangent" | "radial";
    }
    Index

    Properties

    angularSpeed?: ParticleGeneratorRange

    Angular speed in degrees per second.

    direction?: 1 | -1 | "random"

    Orbit direction.

    Initial angle in degrees. Only used when ParticleGeneratorOrbitOptions#radius is provided.

    Radial speed in pixels per second.

    radius?: ParticleGeneratorRange | null

    Orbit radius in pixels. If null, use the particle's initial distance from the anchor.

    rotation?: "none" | "tangent" | "radial"

    If set, override sprite rotation each frame.