Class ParticleEffect

constructor

• new ParticleEffect(options?: object): ParticleEffect

  Parameters

  • Optionaloptions: object = {}

    Options passed to the getParticleEmitters method which can be used to customize values of the emitter configuration.

  Returns ParticleEffect

emitters

createEmitter

• createEmitter(config: EmitterConfigV3): Emitter

  Create an emitter instance which automatically updates using the shared PIXI.Ticker

  Parameters

  • config: EmitterConfigV3

    The emitter configuration

  Returns Emitter

  The created Emitter instance

destroy

• destroy(...args: any[]): void

  Parameters

  • ...args: any[]

  Returns void

getParticleEmitters

• getParticleEmitters(options?: object): Emitter[]

  Get the particle emitters which should be active for this particle effect. This base class creates a single emitter using the explicitly provided configuration. Subclasses can override this method for more advanced configurations.

  Parameters

  • Optionaloptions: object = {}

    Options provided to the ParticleEffect constructor which can be used to customize configuration values for created emitters.

  Returns Emitter[]

play

• play(): void

  Begin animation for the configured emitters.

  Returns void

stop

• stop(): void

  Stop animation for the configured emitters.

  Returns void