Class Particles

constructor

• new Particles(engine, container): Particles

• Parameters

  • engine: Engine

  • container: Container

  Returns Particles

lastZIndex

limit

movers

needsSort

pool

Optional pushing

quadTree

updaters

count

• get count(): number

• Returns number

addManualParticles

• addManualParticles(): void

• Returns void

addParticle

• addParticle(position?, overrideOptions?, group?, initializer?): undefined | Particle

• Parameters

  • Optional position: ICoordinates

  • Optional overrideOptions: RecursivePartial<IParticlesOptions>

  • Optional group: string

  • Optional initializer: ((particle) => boolean)

    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns undefined | Particle

clear

• clear(): void

• Returns void

destroy

• destroy(): void

• Returns void

draw

• draw(delta): Promise<void>

• Parameters

  • delta: IDelta

  Returns Promise<void>

filter

• filter(condition): Particle[]

• Parameters

  • condition: ((particle) => boolean)

    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns Particle[]

find

• find(condition): undefined | Particle

• Parameters

  • condition: ((particle) => boolean)

    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns undefined | Particle

handleClickMode

• handleClickMode(mode): void

• Parameters

  • mode: string

  Returns void

init

• init(): void

• Returns void

push

• push(nb, mouse?, overrideOptions?, group?): void

• Parameters

  • nb: number

  • Optional mouse: IMouseData

  • Optional overrideOptions: RecursivePartial<IParticlesOptions>

  • Optional group: string

  Returns void

redraw

• redraw(): Promise<void>

• Returns Promise<void>

remove

• remove(particle, group?, override?): void

• Parameters

  • particle: Particle

  • Optional group: string

  • Optional override: boolean

  Returns void

removeAt

• removeAt(index, quantity?, group?, override?): void

• Parameters

  • index: number

  • Optional quantity: number

  • Optional group: string

  • Optional override: boolean

  Returns void

removeQuantity

• removeQuantity(quantity, group?): void

• Parameters

  • quantity: number

  • Optional group: string

  Returns void

setDensity

• setDensity(): void

• Returns void

update

• update(delta): Promise<void>

• Parameters

  • delta: IDelta

  Returns Promise<void>