Size by speed module

SizeBySpeedModule

2024.4.3

yisky

Hierarchy (view full)

Constructors

Properties

_enable: boolean = false
range: Vector2 = ...

Set the minimum and maximum speed that this modules applies the size curve between.

SizeBySpeedModule

separateAxes: boolean = false

Set the size by speed on each axis separately.

SizeBySpeedModule

x: MinMaxCurve = ...

Size by speed curve for the x-axis.

SizeBySpeedModule

y: MinMaxCurve = ...

Size by speed curve for the y-axis.

SizeBySpeedModule

z: MinMaxCurve = ...

Size by speed curve for the z-axis.

SizeBySpeedModule

Accessors

  • get enable(): boolean
  • Specifies whether enable the module.

    Returns boolean

    ParticleModule

  • set enable(value): void
  • Specifies whether enable the module.

    Parameters

    • value: boolean

    Returns void

    ParticleModule

  • get size(): MinMaxCurve
  • Curve to control particle size based on speed.

    Returns MinMaxCurve

    SizeBySpeedModule

  • set size(value): void
  • Curve to control particle size based on speed.

    Parameters

    • value: MinMaxCurve

    Returns void

    SizeBySpeedModule

  • get sizeMultiplier(): number
  • A multiplier for ParticleSystem.SizeBySpeedModule.size.

    Returns number

    SizeBySpeedModule

  • set sizeMultiplier(value): void
  • A multiplier for ParticleSystem.SizeBySpeedModule.size.

    Parameters

    • value: number

    Returns void

    SizeBySpeedModule

  • get xMultiplier(): number
  • Size multiplier along the x-axis.

    Returns number

    SizeBySpeedModule

  • set xMultiplier(value): void
  • Size multiplier along the x-axis.

    Parameters

    • value: number

    Returns void

    SizeBySpeedModule

  • get yMultiplier(): number
  • Size multiplier along the y-axis.

    Returns number

    SizeBySpeedModule

  • set yMultiplier(value): void
  • Size multiplier along the y-axis.

    Parameters

    • value: number

    Returns void

    SizeBySpeedModule

  • get zMultiplier(): number
  • Size multiplier along the z-axis.

    Returns number

    SizeBySpeedModule

  • set zMultiplier(value): void
  • Size multiplier along the z-axis.

    Parameters

    • value: number

    Returns void

    SizeBySpeedModule

Methods

  • Protected

    Enable callback

    Returns void

    ParticleModule

  • Protected

    Serialize

    Parameters

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

    Returns void

    SizeBySpeedModule

  • Emit event

    Parameters

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

    Returns void

    EventDispatcher

  • Deserialize

    Parameters

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

    Returns void

    SizeBySpeedModule

  • 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

    EventDispatcher

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

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

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    EventDispatcher

  • Subscribe a event, just emit once

    Parameters

    • type: string
    • callback: SubscriberCallbackFn

      subscriber callback

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

    Returns void

    EventDispatcher

  • Serialize

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

    ParticleModule