Interface ParticleSystemParameters

Interface representing the parameters for a particle system.

interface ParticleSystemParameters {
    autoDestroy?: boolean;
    behaviors?: Behavior[];
    blendTiles?: boolean;
    duration?: number;
    emissionBursts?: BurstParameters[];
    emissionOverDistance?: ValueGenerator | FunctionValueGenerator;
    emissionOverTime?: ValueGenerator | FunctionValueGenerator;
    instancingGeometry?: BufferGeometry;
    layers?: Layers;
    looping?: boolean;
    material: Material;
    onlyUsedByOther?: boolean;
    prewarm?: boolean;
    rendererEmitterSettings?: RendererEmitterSettings;
    renderMode?: RenderMode;
    renderOrder?: number;
    shape?: EmitterShape;
    softFarFade?: number;
    softNearFade?: number;
    softParticles?: boolean;
    speedFactor?: number;
    startColor?: ColorGenerator | FunctionColorGenerator;
    startLength?: ValueGenerator | FunctionValueGenerator;
    startLife?: ValueGenerator | FunctionValueGenerator;
    startRotation?: ValueGenerator | FunctionValueGenerator | RotationGenerator;
    startSize?: ValueGenerator | FunctionValueGenerator | Vector3Generator;
    startSpeed?: ValueGenerator | FunctionValueGenerator;
    startTileIndex?: ValueGenerator;
    uTileCount?: number;
    vTileCount?: number;
    worldSpace?: boolean;
}

Properties

autoDestroy? behaviors? blendTiles? duration? emissionBursts? emissionOverDistance? emissionOverTime? instancingGeometry? layers? looping? material onlyUsedByOther? prewarm? rendererEmitterSettings? renderMode? renderOrder? shape? softFarFade? softNearFade? softParticles? speedFactor? startColor? startLength? startLife? startRotation? startSize? startSpeed? startTileIndex? uTileCount? vTileCount? worldSpace?

Properties

OptionalautoDestroy

autoDestroy?: boolean

Whether the particle system auto-destroys.

Optionalbehaviors

behaviors?: Behavior[]

The behaviors of the particle system.

OptionalblendTiles

blendTiles?: boolean

Whether to blend tiles.

Optionalduration

duration?: number

The duration of the particle system.

OptionalemissionBursts

emissionBursts?: BurstParameters[]

The burst parameters for emission.

OptionalemissionOverDistance

emissionOverDistance?: ValueGenerator | FunctionValueGenerator

The emission rate over distance.

OptionalemissionOverTime

emissionOverTime?: ValueGenerator | FunctionValueGenerator

The emission rate over time.

OptionalinstancingGeometry

instancingGeometry?: BufferGeometry

The instancing geometry of the particle system.

Optionallayers

layers?: Layers

The layers of the particle system.

Optionallooping

looping?: boolean

Whether the particle system loops.

material

material: Material

The material of the particle system.

OptionalonlyUsedByOther

onlyUsedByOther?: boolean

Whether the particle system is only used by others.

Optionalprewarm

prewarm?: boolean

Whether the particle system prewarms.

OptionalrendererEmitterSettings

rendererEmitterSettings?: RendererEmitterSettings

The renderer emitter settings.

OptionalrenderMode

renderMode?: RenderMode

The render mode of the particle system.

OptionalrenderOrder

renderOrder?: number

The render order of the particle system.

Optionalshape

shape?: EmitterShape

The shape of the emitter.

OptionalsoftFarFade

softFarFade?: number

The far fade distance for soft particles.

OptionalsoftNearFade

softNearFade?: number

The near fade distance for soft particles.

OptionalsoftParticles

softParticles?: boolean

Whether to use soft particles.

OptionalspeedFactor

speedFactor?: number

The speed factor of the particle system.

OptionalstartColor

startColor?: ColorGenerator | FunctionColorGenerator

The initial color of particles.

OptionalstartLength

startLength?: ValueGenerator | FunctionValueGenerator

The initial length of particles.

OptionalstartLife

startLife?: ValueGenerator | FunctionValueGenerator

The initial life of particles.

OptionalstartRotation

startRotation?: ValueGenerator | FunctionValueGenerator | RotationGenerator

The initial rotation of particles.

OptionalstartSize

startSize?: ValueGenerator | FunctionValueGenerator | Vector3Generator

The initial size of particles.

OptionalstartSpeed

startSpeed?: ValueGenerator | FunctionValueGenerator

The initial speed of particles.

OptionalstartTileIndex

startTileIndex?: ValueGenerator

The initial tile index for particles.

OptionaluTileCount

uTileCount?: number

The number of tiles in the u direction.

OptionalvTileCount

vTileCount?: number

The number of tiles in the v direction.

OptionalworldSpace

worldSpace?: boolean

Whether the particle system uses world space.

Settings

Member Visibility

On This Page

Properties