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

    Interface ParticleGeneratorDebugStats

    interface ParticleGeneratorDebugStats {
        active: number;
        newlyVisibleAreaCount: number;
        pool: number;
        recycledConstraint: number;
        recycledLifetime: number;
        recycledStop: number;
        spawnAttempts: number;
        spawned: number;
        spawnMS: number;
        spawnRejectedNoArea: number;
        spawnRejectedPositionTest: number;
        spawnRejectedProbability: number;
        target: number;
        tickMS: number;
        updateMS: number;
    }
    Index

    Properties

    active: number

    Current number of active particles.

    newlyVisibleAreaCount: number

    Number of newly-visible rectangles this frame (ambient mode).

    pool: number

    Current number of pooled particles.

    recycledConstraint: number

    Particles recycled due to constraint handling.

    recycledLifetime: number

    Particles recycled due to lifetime expiration.

    recycledStop: number

    Particles recycled/cleared due to a hard stop.

    spawnAttempts: number

    Number of spawn attempts.

    spawned: number

    Number of successfully spawned particles.

    spawnMS: number

    Time spent auto-spawning particles during the most recent tick (milliseconds).

    spawnRejectedNoArea: number

    Spawn attempts rejected because no valid spawn area was available.

    spawnRejectedPositionTest: number

    Spawn attempts rejected by ParticleGeneratorConfiguration#positionTest.

    spawnRejectedProbability: number

    Spawn attempts rejected by probability (auto-spawn only).

    target: number

    Current adjusted target particle count.

    tickMS: number

    Total tick time for the most recent tick (milliseconds).

    updateMS: number

    Time spent updating particles during the most recent tick (milliseconds).