Class EdgeZone

constructor

• new EdgeZone(
      source: EdgeZoneSource,
      quantity: number,
      stepRate?: number,
      yoyo?: boolean,
      seamless?: boolean,
      total?: number,
  ): EdgeZone

  Parameters

  • source: EdgeZoneSource

    An object instance with a getPoints(quantity, stepRate) method returning an array of points.
  • quantity: number

    The number of particles to place on the source edge. Set to 0 to use stepRate instead.
  • OptionalstepRate: number

    The distance between each particle. When set, quantity is implied and should be set to 0.
  • Optionalyoyo: boolean

    Whether particles are placed from start to end and then end to start. Default false.
  • Optionalseamless: boolean

    Whether one endpoint will be removed if it's identical to the other. Default true.
  • Optionaltotal: number

    The total number of particles this zone will emit before passing over to the next emission zone in the Emitter. -1 means it will never pass over and you must use setEmitZone to change it. Default -1.

  Returns EdgeZone

counter

points

quantity

seamless

source

stepRate

total

yoyo

changeSource

• changeSource(source: EdgeZoneSource): this

  Change the source of the EdgeZone.

  Parameters

  • source: EdgeZoneSource

    An object instance with a getPoints(quantity, stepRate) method returning an array of points.

  Returns this

getPoint

• getPoint(particle: Particle): void

  Get the next point in the Zone and set its coordinates on the given Particle.

  Parameters

  • particle: Particle

    The Particle.

  Returns void

updateSource

• updateSource(): this

  Update the Phaser.GameObjects.Particles.Zones.EdgeZone#points from the EdgeZone's Phaser.GameObjects.Particles.Zones.EdgeZone#source.

  Also updates internal properties.

  Returns this