Class InheritVelocityModule

Inherit velocity module

Export

InheritVelocityModule

Note

The inherit velocity module only has an effect if the Particle System is set to simulate in world space. If the system is simulating in local space, this module is ignored.

Date

2024.4.12

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system curve mode

Accessors

curveMultiplier enable system

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

curve

curve: MinMaxCurve = ...

Curve to define how much of the emitter velocity the system applies during the lifetime of a particle.

Memberof

InheritVelocityModule

mode

mode: ParticleSystemInheritVelocityMode = ParticleSystemInheritVelocityMode.Initial

Specifies how to apply emitter velocity to particles.

Memberof

InheritVelocityModule

Accessors

curveMultiplier

  • get curveMultiplier(): number

  • Change the curve multiplier.

    Returns number

    Memberof

    InheritVelocityModule

  • set curveMultiplier(value): void

  • Change the curve multiplier.

    Parameters

    • value: number

    Returns void

    Memberof

    InheritVelocityModule

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

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

    InheritVelocityModule

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

    InheritVelocityModule

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