babylon.quarks - v1.0.0
    Preparing search index...

    Interface ParticleSystemJSONParameters

    A particle system in an effect file, as ParticleSystem.toJSON writes it and ParticleSystem.fromJSON reads it; docs/FORMAT.md describes the document around it. Each field mirrors the ParticleSystem member of the same name. Curves and generators are written as quarks.core's FunctionJSON; textures, materials and geometries as uuids into the document. A setting is written only when it differs from its default, and a field that is missing reads as the default, so every field is optional. The shape, instancingGeometry and material are always written.

    interface ParticleSystemJSONParameters {
        alignToDirection?: boolean;
        alphaTest?: number;
        applyFog?: boolean;
        applyImageProcessing?: boolean;
        autoDestroy?: boolean;
        behaviors?: BehaviorJSON[];
        blending?: number;
        blendTiles?: boolean;
        cullingMode?: CullingMode;
        depthTest?: boolean;
        depthWrite?: boolean;
        duration?: number;
        emissionBursts?: BurstParametersJSON[];
        emissionOverDistance?: ValueGeneratorJSON;
        emissionOverTime?: ValueGeneratorJSON;
        flip?: number[];
        instancingGeometry?: string | GeometryEntry;
        layers?: number;
        looping?: boolean;
        material?: string;
        materialColor?: [number, number, number, number];
        materialColorScale?: number;
        maxParticles?: number;
        maxParticleSize?: number;
        minParticleSize?: number;
        onlyUsedByOther?: boolean;
        particleColor?: boolean;
        pivot?: number[];
        playbackSpeed?: number;
        premultipliedMap?: boolean;
        prewarm?: boolean;
        prewarmTime?: number;
        renderAlignment?: RenderAlignment;
        rendererEmitterSettings?: RendererEmitterSettingsJSON;
        renderFace?: RenderFace;
        renderingGroupId?: number;
        renderMode?: number;
        renderOrder?: number;
        ringBufferLoopRange?: [number, number];
        ringBufferMode?: RingBufferMode;
        rotationAxis?: RotationAxis;
        scalingMode?: ScalingMode;
        seed?: number;
        shape?: ShapeJSON;
        softFarFade?: number;
        softNearFade?: number;
        softParticles?: boolean;
        sortingFudge?: number;
        sortMode?: SortMode;
        speedFactor?: number;
        startColor?: ColorGeneratorJSON;
        startDelay?: ValueGeneratorJSON;
        startLife?: ValueGeneratorJSON;
        startRotation?: RotationGeneratorJSON | ValueGeneratorJSON;
        startSize?: ValueGeneratorJSON | Vector3FunctionJSON;
        startSpeed?: ValueGeneratorJSON;
        startTileIndex?: number | ValueGeneratorJSON;
        stopAction?: StopAction;
        texture?: string;
        transparent?: boolean;
        uTileCount?: number;
        version?: string;
        vTileCount?: number;
        worldSpace?: boolean;
    }
    Index
    alignToDirection?: boolean

    Written only when true.

    alphaTest?: number
    applyFog?: boolean

    Written only when false.

    applyImageProcessing?: boolean

    Written only when false.

    autoDestroy?: boolean

    Read from older files: true is stopAction: 'destroy'. No longer written.

    behaviors?: BehaviorJSON[]

    Each behavior as its toJSON writes it.

    blending?: number
    blendTiles?: boolean
    cullingMode?: CullingMode

    Written only when not 'always'.

    depthTest?: boolean
    depthWrite?: boolean
    duration?: number
    emissionBursts?: BurstParametersJSON[]
    emissionOverDistance?: ValueGeneratorJSON
    emissionOverTime?: ValueGeneratorJSON
    flip?: number[]

    [u, v]; written only when non-zero.

    instancingGeometry?: string | GeometryEntry

    Uuid of the mesh particles' geometry entry; a document made in code may hold the entry itself.

    layers?: number

    The camera layer mask.

    looping?: boolean
    material?: string

    Uuid of the material entry.

    materialColor?: [number, number, number, number]

    [r, g, b, a], written only when not white.

    materialColorScale?: number

    Written only when not 1.

    maxParticles?: number
    maxParticleSize?: number

    Written only when limited.

    minParticleSize?: number

    Written only when not 0.

    onlyUsedByOther?: boolean
    particleColor?: boolean

    Written only when false.

    pivot?: number[]

    [x, y, z]; written only when non-zero.

    playbackSpeed?: number

    Written only when not 1.

    premultipliedMap?: boolean

    Written only when true.

    prewarm?: boolean
    prewarmTime?: number
    renderAlignment?: RenderAlignment

    Written only when not 'simulation'.

    rendererEmitterSettings?: RendererEmitterSettingsJSON

    Trail, stretched or mesh settings; a trail's startLength as ValueGeneratorJSON. Left out when the render mode has none.

    renderFace?: RenderFace

    Written only when not 'both'.

    renderingGroupId?: number

    Written only when not 0.

    renderMode?: number

    A RenderMode value.

    renderOrder?: number
    ringBufferLoopRange?: [number, number]

    [start, end]; written only when not [0, 1].

    ringBufferMode?: RingBufferMode

    Written only when not 'disabled'.

    rotationAxis?: RotationAxis

    Written only when not 'z'.

    scalingMode?: ScalingMode

    Written only when not 'local'.

    seed?: number

    Written only when set.

    shape?: ShapeJSON

    The emitter shape, as its toJSON writes it.

    softFarFade?: number
    softNearFade?: number
    softParticles?: boolean
    sortingFudge?: number

    Written only when not 0.

    sortMode?: SortMode

    Written only when not 'none'.

    speedFactor?: number

    A stretched billboard's speed factor, as older files wrote it outside rendererEmitterSettings.

    startColor?: ColorGeneratorJSON
    startDelay?: ValueGeneratorJSON
    startLife?: ValueGeneratorJSON
    startSpeed?: ValueGeneratorJSON
    startTileIndex?: number | ValueGeneratorJSON
    stopAction?: StopAction

    Written only when not 'none'.

    texture?: string

    Uuid of the texture entry.

    transparent?: boolean
    uTileCount?: number
    version?: string

    The three.quarks version line, which files before format 3 wrote. Read by nothing.

    vTileCount?: number
    worldSpace?: boolean