Class System

constructor

• new System(preParticles?: number, integrationType?: string): System

  Parameters

  • preParticles: number = POOL_MAX
  • integrationType: string = INTEGRATION_TYPE_EULER

  Returns System

canUpdate

emitters

eventDispatcher

integrationType

pool

preParticles

renderers

type

addEmitter

• addEmitter(emitter: Emitter): this

  Adds an emitter to the System instance. Dispatches the EMITTER_ADDED event.

  Parameters

  • emitter: Emitter

  Returns this

addRenderer

• addRenderer(renderer: BaseRenderer): this

  Adds a renderer to the System instance and initializes it.

  Parameters

  • renderer: BaseRenderer

  Returns this

destroy

• destroy(): void

  Destroys all emitters, renderers and the Nebula pool.

  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(__namedParameters: LifeCycleHooks): Promise<unknown[]> | undefined

  Wires up life cycle methods and causes a system's emitters to emit particles.

  Parameters

  • __namedParameters: LifeCycleHooks

  Returns Promise<unknown[]> | undefined

getCount

• getCount(): number

  Gets a count of the total number of particles in the system.

  Returns number

removeEmitter

• removeEmitter(emitter: Emitter): this

  Removes an emitter from the System instance. Dispatches the EMITTER_REMOVED event.

  Parameters

  • emitter: Emitter

  Returns this

removeRenderer

• removeRenderer(renderer: BaseRenderer): this

  Removes a renderer from the System instance.

  Parameters

  • renderer: BaseRenderer

  Returns this

update

• update(delta?: number): Promise<void>

  Updates the particle system based on the delta passed.

  Parameters

  • delta: number = DEFAULT_SYSTEM_DELTA

  Returns Promise<void>

StaticfromJSON

• fromJSON(json: SystemJSON, THREE: __module): System

  Creates a System instance from a JSON object.

  Parameters

  • json: SystemJSON
  • THREE: __module

  Returns System

  Deprecated

  use fromJSONAsync instead

StaticfromJSONAsync

• fromJSONAsync(
      json: SystemJSON,
      THREE: __module,
      options?: FromJSONAsyncOptions,
  ): Promise<System>

  Loads a System instance from JSON asynchronously. Ensures all textures are fully loaded before resolving with the instantiated System instance.

  Parameters

  • json: SystemJSON
  • THREE: __module
  • Optionaloptions: FromJSONAsyncOptions

  Returns Promise<System>