babylon.quarks - v0.19.0
    Preparing search index...

    Class ParticleSystem

    Implements

    Index

    Constructors

    Properties

    autoDestroy: boolean

    Whether the ParticleSystem should be automatically disposed when it finishes emitting particles.

    behaviors: Behavior[]
    duration: number

    Duration of the system.

    emissionBursts: BurstParameters[]
    emissionOverDistance: ValueGenerator | FunctionValueGenerator
    emissionState: EmissionState

    Emitter for the particles.

    emitterShape: EmitterShape
    emitterVelocity: Vector3 = ...

    World-space velocity of the emitter, updated each frame by the runtime.

    looping: boolean

    Whether the system is looping.

    neededToUpdateRender: boolean
    onlyUsedByOther: boolean

    Whether this system only emits through another system, which is when its particles carry their own parent transform.

    particleNum: number

    Number of particles.

    particles: Particle[]

    Array of particles.

    paused: boolean
    prewarm: boolean
    rendererEmitterSettings: RendererEmitterSettings

    Optional renderer.

    rendererSettings: VFXBatchSettings
    startTileIndex: ValueGenerator
    store: ParticleStore = ...

    Column storage shared by this system's particles.

    worldSpace: boolean

    Whether the system is in world space.

    Accessors

    • get simulationResidual(): number

      Wall-clock time that has passed since the last simulated step, in seconds, when the implementation simulates on a fixed timestep. Negative when that step ran a hair ahead of real time instead (rounded to the nearest step rather than floored, so this stays small either way). A renderer uses it to draw where the particles are now rather than where the last step left them.

      Returns number

    Methods