Class VelocityOverLifetimeModule

Velocity over lifetime

Export

VelocityOverLifetimeModule

Date

2024.3.29

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system orbitalOffsetX orbitalOffsetY orbitalOffsetZ orbitalX orbitalY orbitalZ radial space speedModifier x y z

Accessors

enable orbitalOffsetXMultiplier orbitalOffsetYMultiplier orbitalOffsetZMultiplier orbitalXMultiplier orbitalYMultiplier orbitalZMultiplier radialMultiplier speedModifierMultiplier system xMultiplier yMultiplier zMultiplier

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

orbitalOffsetX

orbitalOffsetX: MinMaxCurve = ...

Specify a custom center of rotation for the orbital and radial velocities.

Memberof

VelocityOverLifetimeModule

orbitalOffsetY

orbitalOffsetY: MinMaxCurve = ...

Specify a custom center of rotation for the orbital and radial velocities.

Memberof

VelocityOverLifetimeModule

orbitalOffsetZ

orbitalOffsetZ: MinMaxCurve = ...

Specify a custom center of rotation for the orbital and radial velocities.

Memberof

VelocityOverLifetimeModule

orbitalX

orbitalX: MinMaxCurve = ...

Curve to control particle speed based on lifetime, around the x-axis.

Memberof

VelocityOverLifetimeModule

orbitalY

orbitalY: MinMaxCurve = ...

Curve to control particle speed based on lifetime, around the y-axis.

Memberof

VelocityOverLifetimeModule

orbitalZ

orbitalZ: MinMaxCurve = ...

Specify a custom center of rotation for the orbital and radial velocities.

Memberof

VelocityOverLifetimeModule

radial

radial: MinMaxCurve = ...

Curve to control particle speed based on lifetime, away from a center position.

Memberof

VelocityOverLifetimeModule

space

space: ParticleSystemSimulationSpace = ParticleSystemSimulationSpace.Local

Space used to calculate particle velocity.

Memberof

VelocityOverLifetimeModule

speedModifier

speedModifier: MinMaxCurve = ...

Speed modifier.

Memberof

VelocityOverLifetimeModule

x

x: MinMaxCurve = ...

Velocity on X axis.

Memberof

VelocityOverLifetimeModule

y

y: MinMaxCurve = ...

Velocity on Y axis.

Memberof

VelocityOverLifetimeModule

z

z: MinMaxCurve = ...

Velocity on Z axis.

Memberof

VelocityOverLifetimeModule

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

orbitalOffsetXMultiplier

  • get orbitalOffsetXMultiplier(): number

  • A multiplier for orbitalOffsetX.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalOffsetXMultiplier(value): void

  • A multiplier for orbitalOffsetX.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

orbitalOffsetYMultiplier

  • get orbitalOffsetYMultiplier(): number

  • A multiplier for orbitalOffsetY.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalOffsetYMultiplier(value): void

  • A multiplier for orbitalOffsetY.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

orbitalOffsetZMultiplier

  • get orbitalOffsetZMultiplier(): number

  • A multiplier for orbitalOffsetZ.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalOffsetZMultiplier(value): void

  • A multiplier for orbitalOffsetZ.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

orbitalXMultiplier

  • get orbitalXMultiplier(): number

  • Speed multiplier along the x-axis.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalXMultiplier(value): void

  • Speed multiplier along the x-axis.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

orbitalYMultiplier

  • get orbitalYMultiplier(): number

  • Speed multiplier along the y-axis.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalYMultiplier(value): void

  • Speed multiplier along the y-axis.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

orbitalZMultiplier

  • get orbitalZMultiplier(): number

  • Speed multiplier along the z-axis.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set orbitalZMultiplier(value): void

  • Speed multiplier along the z-axis.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

radialMultiplier

  • get radialMultiplier(): number

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.radial.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set radialMultiplier(value): void

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.radial.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

speedModifierMultiplier

  • get speedModifierMultiplier(): number

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.speedModifier.

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set speedModifierMultiplier(value): void

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.speedModifier.

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

system

xMultiplier

  • get xMultiplier(): number

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.x

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set xMultiplier(value): void

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.x

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

yMultiplier

  • get yMultiplier(): number

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.y

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set yMultiplier(value): void

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.y

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

zMultiplier

  • get zMultiplier(): number

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.z

    Returns number

    Memberof

    VelocityOverLifetimeModule

  • set zMultiplier(value): void

  • A multiplier for ParticleSystem.VelocityOverLifetimeModule.z

    Parameters

    • value: number

    Returns void

    Memberof

    VelocityOverLifetimeModule

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

    VelocityOverLifetimeModule

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

    VelocityOverLifetimeModule

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
""