Class ParticleEventChannel<Payload>

constructor

• new ParticleEventChannel<
      Payload extends Readonly<Record<string, ParticleEventFieldValue>>,
  >(
      parameters: Readonly<ParticleEventChannelParameters<Payload>>,
  ): ParticleEventChannel<Payload>

  Type Parameters

  • Payload extends Readonly<Record<string, ParticleEventFieldValue>>

  Parameters

  • parameters: Readonly<ParticleEventChannelParameters<Payload>>

  Returns ParticleEventChannel<Payload>

Readonlycapacity

Readonlyname

Readonlyoverflow

Readonlyschema

droppedCount

• get droppedCount(): number

  Returns number

size

• get size(): number

  Returns number

drain

• drain(maxCount?: number): readonly Readonly<Payload>[]

  Parameters

  • maxCount: number = ...

  Returns readonly Readonly<Payload>[]

emitTo

• emitTo(
      system: ParticleSystem,
      options?: Readonly<
          {
              count?: number;
              emitter?: string;
              positionField?: keyof Payload & string;
              velocityField?: keyof Payload & string;
          },
      >,
  ): number

  Drain position/velocity payloads into one resident emitter without creating systems.

  Parameters

  • system: ParticleSystem
  • options: Readonly<
        {
            count?: number;
            emitter?: string;
            positionField?: keyof Payload & string;
            velocityField?: keyof Payload & string;
        },
    > = {}

  Returns number

submit

• submit(payload: Readonly<Payload>): boolean

  Parameters

  • payload: Readonly<Payload>

  Returns boolean