ParticlesComponent

Signature

export interface ParticlesComponent {
  type: "particles"
  preset: ParticlePreset
  rate: number
  color?: string
  /** A key of scene.assets whose kind is "material": a material file with a `shader` the sprites draw with, on both renderers. */
  material?: string
  /** A particle effect (docs/VFX.md): an `effect` asset id, a `*.vfx.json` path, `"builtin:<preset>"` or `"builtin:fx/<preset>"` (the preset library). When set, `preset` and `rate` are not used. */
  effect?: string
  /** Values for the effect's declared params. */
  params?: Record<string, unknown>
}

Import: import type { ParticlesComponent } from "@argus/gameplay"

Members