Talos Engine
Start a pilot
Menu
Talos docs

ParticleDirector

Since 0.6
Plain text

Signature

export class ParticleDirector {
  constructor(ctx: Ctx)
  emit(preset: ParticlePreset, at?: Target, overrides: Partial<ParticleParams> = {}): ParticleParams
  burst(preset: ParticlePreset, at?: Target, count?: number, overrides: Partial<ParticleParams> = {}): ParticleParams
  fromComponent(component?: ParticlesComponent, at?: Target): ParticleParams | null
}

Import: import { ParticleDirector } from "@argus/gameplay"

Members

MemberSignatureDescription
constructorconstructor(ctx: Ctx)
emitemit(preset: ParticlePreset, at?: Target, overrides: Partial<ParticleParams> = {}): ParticleParamsStart a preset emitter at a point. Returns the parameters that were sent.
burstburst(preset: ParticlePreset, at?: Target, count?: number, overrides: Partial<ParticleParams> = {}): ParticleParamsA one-shot: count particles now, no continuous rate.
fromComponentfromComponent(component?: ParticlesComponent, at?: Target): ParticleParams | nullRun the emitter a particles component describes: its preset, its rate, and its colour when it sets one. Everything else comes from the preset. Returns null when the entity has no such component.