Class Emitter

constructor

• new Emitter(properties?: Record<string, unknown>): Emitter

  Parameters

  • Optionalproperties: Record<string, unknown>

  Returns Emitter

bindEmitter

bindEmitterEvent

cID

currentEmitTime

damping

emitterBehaviours

eventDispatcher

initializers

isEmitting

name

particles

rate

totalEmitTimes

system

• get system(): System | null

  An emitter's parent is the System it was added to (a particle's parent is its emitter, hence the inherited parent field is narrowed here).

  Returns System | null

addBehaviour

• addBehaviour(behaviour: Behaviour): this

  Adds a behaviour to the emitter.

  Parameters

  • behaviour: Behaviour

  Returns this

addBehaviours

• addBehaviours(behaviours: Behaviour[]): this

  Adds multiple behaviours to the emitter.

  Parameters

  • behaviours: Behaviour[]

  Returns this

addEmitterBehaviour

• addEmitterBehaviour(behaviour: Behaviour): this

  Adds an emitter behaviour to the emitter.

  Parameters

  • behaviour: Behaviour

  Returns this

addEmitterBehaviours

• addEmitterBehaviours(behaviours: Behaviour[]): this

  Adds multiple behaviours to the emitter.

  Parameters

  • behaviours: Behaviour[]

  Returns this

addInitializer

• addInitializer(initializer: Initializer): this

  Adds a particle initializer to the emitter.

  Parameters

  • initializer: Initializer

  Returns this

addInitializers

• addInitializers(initializers: Initializer[]): this

  Adds multiple particle initializers to the emitter.

  Parameters

  • initializers: Initializer[]

  Returns this

addOnEmitterDeadEventListener

• addOnEmitterDeadEventListener(onEmitterDead: () => void): this

  Adds the event listener for the EMITTER_DEAD event.

  Parameters

  • onEmitterDead: () => void

  Returns this

createParticle

• createParticle(): Particle

  Creates a particle by retreiving one from the pool and setting it up with the supplied initializer and behaviour.

  Returns Particle

destroy

• destroy(): void

  Kills the emitter.

  Returns void

dispatch

• dispatch(event: string, target?: unknown): void

  Proxy method for the internal event dispatcher's dispatchEvent method.

  Parameters

  • event: string
  • target: unknown = ...

  Returns void

emit

• emit(totalEmitTimes?: number | "once", life?: number): this

  Sets the total number of times the emitter should emit particles as well as the emitter's life. Also intializes the emitter rate. This enables the emitter to emit particles.

  Parameters

  • totalEmitTimes: number | "once" = Infinity
  • life: number = Infinity

  Returns this

experimental_emit

• experimental_emit(): this

  Experimental emit method that is designed to be called from the System.emit method.

  Returns this

generate

• generate(time: number): void

  Generates new particles.

  Parameters

  • time: number

  Returns void

integrate

• integrate(time: number): void

  Runs the integration algorithm on the emitter and all particles.

  Parameters

  • time: number

  Returns void

removeAllBehaviours

• removeAllBehaviours(): this

  Removes all behaviours from the emitter.

  Returns this

removeAllEmitterBehaviours

• removeAllEmitterBehaviours(): this

  Removes all behaviours from the emitter.

  Returns this

removeAllInitializers

• removeAllInitializers(): this

  Removes all initializers.

  Returns this

removeAllParticles

• removeAllParticles(): void

  Kills all of the emitter's particles.

  Returns void

removeBehaviour

• removeBehaviour(behaviour: Behaviour): this

  Removes the behaviour from the emitter's behaviours array.

  Parameters

  • behaviour: Behaviour

  Returns this

removeEmitterBehaviour

• removeEmitterBehaviour(behaviour: Behaviour): this

  Removes the behaviour from the emitter's behaviours array.

  Parameters

  • behaviour: Behaviour

  Returns this

removeInitializer

• removeInitializer(initializer: Initializer): this

  Removes an initializer from the emitter's initializers array.

  Parameters

  • initializer: Initializer

  Returns this

setBehaviours

• setBehaviours(behaviours: Behaviour[]): this

  Sets the emitter's behaviours.

  Parameters

  • behaviours: Behaviour[]

  Returns this

setEmitterBehaviours

• setEmitterBehaviours(behaviours: Behaviour[]): this

  Sets the emitter's behaviours.

  Parameters

  • behaviours: Behaviour[]

  Returns this

setInitializers

• setInitializers(initializers: Initializer[]): this

  Sets the emitter's particle initializers.

  Parameters

  • initializers: Initializer[]

  Returns this

setLife

• setLife(life?: number): this

  Sets the life of the emitter.

  Parameters

  • life: number = Infinity

  Returns this

setPosition

• setPosition(newPosition?: Vector3Props): this

  Sets the position of the emitter.

  Parameters

  • newPosition: Vector3Props = {}

  Returns this

setRate

• setRate(rate: Rate): this

  Sets the emitter rate.

  Parameters

  • rate: Rate

  Returns this

setRotation

• setRotation(newRotation?: Vector3Props): this

  Sets the rotation of the emitter.

  Parameters

  • newRotation: Vector3Props = {}

  Returns this

setTotalEmitTimes

• setTotalEmitTimes(totalEmitTimes?: number): this

  Sets the total emit times for the emitter.

  Parameters

  • totalEmitTimes: number = Infinity

  Returns this

setupParticle

• setupParticle(particle: Particle, index?: number): void

  Sets up a particle by running all initializers on it and setting its behaviours. Also adds the particle to this.particles.

  Parameters

  • particle: Particle
  • Optionalindex: number

  Returns void

stopEmit

• stopEmit(): void

  Stops the emitter from emitting particles.

  Returns void

update

• update(time: number): void

  Updates the emitter according to the time passed by calling the generate and integrate methods.

  Parameters

  • time: number

  Returns void

updateEmitterBehaviours

• updateEmitterBehaviours(time: number): void

  Updates the emitter's emitter behaviours.

  Parameters

  • time: number

  Returns void