Class ParticleEmitter

Handles spawning of new particles using the specified parameters and shape.

Hierarchy

  • FrameworkObject
    • ParticleEmitter

Constructors

  • Creates a new emitter.

    Parameters

    • OptionalisInternalConstructor: boolean

    Returns ParticleEmitter

Accessors

  • get flipProbabilityU(): number
  • Determines should particle U texture coordinate be randomly flipped, mirroring the image. The value represents a percent of particles that should be flipped, in range [0, 1].

    Returns number

  • set flipProbabilityU(value): void
  • Parameters

    • value: number

    Returns void

  • get flipProbabilityV(): number
  • Determines should particle V texture coordinate be randomly flipped, mirroring the image. The value represents a percent of particles that should be flipped, in range [0, 1].

    Returns number

  • set flipProbabilityV(value): void
  • Parameters

    • value: number

    Returns void

  • get initialRotation(): FloatDistribution
  • Determines the rotation of the particles when initially spawned, in degrees. The rotation is applied around the particle's local Z axis. Only used if 3D rotation is disabled.

    Returns FloatDistribution

  • set initialRotation(value): void
  • Parameters

    Returns void

  • get initialSpeed(): FloatDistribution
  • Sets the initial speed of the particles, in meters/second. The speed is applied along the particle's velocity direction, which is determined by the emission shape and potentially other properties.

    Returns FloatDistribution

  • set initialSpeed(value): void
  • Parameters

    Returns void

  • get randomOffset(): number
  • Determines a range of values determining a random offset to apply to particle position after it has been emitted. Offset will be randomly selected in all three axes in range [-value, value].

    Returns number

  • set randomOffset(value): void
  • Parameters

    • value: number

    Returns void

  • get use3DRotation(): boolean
  • Determines should the initial particle rotation be a single angle applied around a Z axis (if disabled), or a set of Euler angles that allow you to rotate around every axis (if enabled).

    Returns boolean

  • set use3DRotation(value): void
  • Parameters

    • value: boolean

    Returns void

  • get use3DSize(): boolean
  • Determines should the initial particle size be applied uniformly (if disabled), or evaluated separately for each dimension (if enabled).

    Returns boolean

  • set use3DSize(value): void
  • Parameters

    • value: boolean

    Returns void