Class NoiseModule

Noise module

Export

NoiseModule

Date

2024.6.18

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system damping frequency octaveCount octaveMultiplier octaveScale positionAmount rotationAmount scrollSpeed separateAxes sizeAmount strength strengthX strengthY strengthZ

Accessors

enable scrollSpeedMultiplier strengthMultiplier strengthXMultiplier strengthYMultiplier strengthZMultiplier system

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

damping

damping: boolean = false

Higher frequency noise reduces the strength by a proportional amount, if enabled.

Memberof

NoiseModule

frequency

frequency: number = 0.5

Low values create soft, smooth noise, and high values create rapidly changing noise.

Memberof

NoiseModule

octaveCount

octaveCount: number = 1

Layers of noise that combine to produce final noise.

Memberof

NoiseModule

octaveMultiplier

octaveMultiplier: number = 0.5

When combining each octave, scale the intensity by this amount.

Memberof

NoiseModule

octaveScale

octaveScale: number = 2

When combining each octave, zoom in by this amount.

Memberof

NoiseModule

positionAmount

positionAmount: MinMaxCurve = ...

How much the noise affects the particle positions.

Memberof

NoiseModule

rotationAmount

rotationAmount: MinMaxCurve = ...

How much the noise affects the particle rotation, in degrees per second.

Memberof

NoiseModule

scrollSpeed

scrollSpeed: MinMaxCurve = ...

Scroll the noise map over the Particle System.

Memberof

NoiseModule

separateAxes

separateAxes: boolean = false

Control the noise separately for each axis.

Memberof

NoiseModule

sizeAmount

sizeAmount: MinMaxCurve = ...

How much the noise affects the particle sizes, applied as a multiplier on the size of each particle.

Memberof

NoiseModule

strength

strength: MinMaxCurve = ...

How strong the overall noise effect is.

Memberof

NoiseModule

strengthX

strengthX: MinMaxCurve = ...

Define the strength of the effect on the x-axis, when using the ParticleSystem.NoiseModule.separateAxes option.

Memberof

NoiseModule

strengthY

strengthY: MinMaxCurve = ...

Define the strength of the effect on the y-axis, when using the ParticleSystem.NoiseModule.separateAxes option.

Memberof

NoiseModule

strengthZ

strengthZ: MinMaxCurve = ...

Define the strength of the effect on the z-axis, when using the ParticleSystem.NoiseModule.separateAxes option.

Memberof

NoiseModule

Accessors

enable

  • get enable(): boolean

  • Specifies whether enable the module.

    Returns boolean

    Memberof

    ParticleModule

  • set enable(value): void

  • Specifies whether enable the module.

    Parameters

    • value: boolean

    Returns void

    Memberof

    ParticleModule

scrollSpeedMultiplier

  • get scrollSpeedMultiplier(): number

  • Get scroll speed multiplier.

    Returns number

    Memberof

    NoiseModule

  • set scrollSpeedMultiplier(value): void

  • Set scroll speed multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    NoiseModule

strengthMultiplier

  • get strengthMultiplier(): number

  • Get strength multiplier.

    Returns number

    Memberof

    NoiseModule

  • set strengthMultiplier(value): void

  • Set strength multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    NoiseModule

strengthXMultiplier

  • get strengthXMultiplier(): number

  • Get x-axis strength multiplier.

    Returns number

    Memberof

    NoiseModule

  • set strengthXMultiplier(value): void

  • Set x-axis strength multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    NoiseModule

strengthYMultiplier

  • get strengthYMultiplier(): number

  • Get y-axis strength multiplier.

    Returns number

    Memberof

    NoiseModule

  • set strengthYMultiplier(value): void

  • Set y-axis strength multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    NoiseModule

strengthZMultiplier

  • get strengthZMultiplier(): number

  • Get z-axis strength multiplier.

    Returns number

    Memberof

    NoiseModule

  • set strengthZMultiplier(value): void

  • Set z-axis strength multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    NoiseModule

system

Methods

Protected_onDisable

Protected_onEnable

  • _onEnable(): void
  • Protected

    Enable callback

    Returns void

    Memberof

    ParticleModule

Protected_serialize

  • _serialize(meta): void
  • Protected

    Serialize

    Parameters

    • meta: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

    Memberof

    NoiseModule

dispose

emit

  • emit(event): void

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

fromJSON

  • fromJSON(json): void

  • Deserialize

    Parameters

    • json: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

    Memberof

    NoiseModule

off

  • off(type, callback?): void

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    • type: string
    • Optionalcallback: SubscriberCallbackFn

      subscriber callback

    Returns void

    Memberof

    EventDispatcher

on

  • on(type, callback, options?): void

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

once

  • once(type, callback, options?): void

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      }
      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

toJSON

  • toJSON(): {
        [key: string]: any;
    }

  • Serialize

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    Memberof

    ParticleModule

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods