Class Particles

constructor

• new Particles(engine, container): Particles

• Parameters

  • engine: Engine
  • container: Container

  Returns Particles

movers

quadTree

updaters

count

• get count(): number

• Returns number

addManualParticles

• addManualParticles(): void

• Returns void

addParticle

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

• Parameters

  • Optionalposition: ICoordinates
  • OptionaloverrideOptions: RecursivePartial<IParticlesOptions>
  • Optionalgroup: string
  • Optionalinitializer: ((particle: Particle) => boolean)
    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns undefined | Particle

clear

• clear(): void

• Removes all particles from the array

  Returns void

destroy

• destroy(): void

• Returns void

draw

• draw(delta): void

• Parameters

  • delta: IDelta

  Returns void

filter

• filter(condition): Particle[]

• Parameters

  • condition: ((particle: Particle) => boolean)
    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns Particle[]

find

• find(condition): undefined | Particle

• Parameters

  • condition: ((particle: Particle) => boolean)
    • • (particle): boolean

      • Parameters

        • particle: Particle

        Returns boolean

  Returns undefined | Particle

get

• get(index): undefined | Particle

• Parameters

  • index: number

  Returns undefined | Particle

handleClickMode

• handleClickMode(mode): void

• Parameters

  • mode: string

  Returns void

init

• init(): Promise<void>

• Returns Promise<void>

initPlugins

• initPlugins(): Promise<void>

• Returns Promise<void>

push

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

• Parameters

  • nb: number
  • Optionalmouse: IMouseData
  • OptionaloverrideOptions: RecursivePartial<IParticlesOptions>
  • Optionalgroup: string

  Returns void

redraw

• redraw(): Promise<void>

• Returns Promise<void>

remove

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

• Parameters

  • particle: Particle
  • Optionalgroup: string
  • Optionaloverride: boolean

  Returns void

removeAt

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

• Parameters

  • index: number
  • quantity: number = defaultRemoveQuantity
  • Optionalgroup: string
  • Optionaloverride: boolean

  Returns void

removeQuantity

• removeQuantity(quantity, group?): void

• Parameters

  • quantity: number
  • Optionalgroup: string

  Returns void

setDensity

• setDensity(): void

• Returns void

setLastZIndex

• setLastZIndex(zIndex): void

• Parameters

  • zIndex: number

  Returns void

setResizeFactor

• setResizeFactor(factor): void

• Parameters

  • factor: IDimension

  Returns void

update

• update(delta): void

• Parameters

  • delta: IDelta

  Returns void