Class LightsModule

Lights module

Export

LightsModule

Date

2024.7.2

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_enable _system alphaAffectsIntensity intensity range sizeAffectsRange useParticleColor useRandomDistribution

Accessors

enable intensityMultiplier light maxLights rangeMultiplier ratio system

Methods

_onDisable _onEnable _serialize dispose emit fromJSON off on once toJSON

Constructors

constructor

Properties

Protected_enable

_enable: boolean = false

Protected_system

_system: ParticleSystem

alphaAffectsIntensity

alphaAffectsIntensity: boolean = false

Toggle whether the system multiplies the particle alpha by the light intensity when it computes the final light intensity.

Memberof

LightsModule

intensity

intensity: MinMaxCurve = ...

Define a curve to apply custom intensity scaling to particle Lights.

Memberof

LightsModule

range

range: MinMaxCurve = ...

Define a curve to apply custom range scaling to particle Lights.

Memberof

LightsModule

sizeAffectsRange

sizeAffectsRange: boolean = false

Toggle whether the system multiplies the particle size by the light range to determine the final light range.

Memberof

LightsModule

useParticleColor

useParticleColor: boolean = false

Toggle whether the particle lights multiply their color by the particle color.

Memberof

LightsModule

useRandomDistribution

useRandomDistribution: boolean = false

Randomly assign Lights to new particles based on ratio.

Memberof

LightsModule

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

intensityMultiplier

  • get intensityMultiplier(): number

  • Intensity multiplier

    Returns number

    Memberof

    LightsModule

  • set intensityMultiplier(value): void

  • Intensity multiplier

    Parameters

    • value: number

    Returns void

    Memberof

    LightsModule

light

  • set light(value): void

  • Particle light

    Parameters

    Returns void

    Memberof

    LightsModule

maxLights

  • get maxLights(): number

  • The limit on how many Lights this Module can create.

    Returns number

    Memberof

    LightsModule

  • set maxLights(value): void

  • The limit on how many Lights this Module can create.

    Parameters

    • value: number

    Returns void

    Memberof

    LightsModule

rangeMultiplier

  • get rangeMultiplier(): number

  • Range multiplier

    Returns number

    Memberof

    LightsModule

  • set rangeMultiplier(value): void

  • Range multiplier

    Parameters

    • value: number

    Returns void

    Memberof

    LightsModule

ratio

  • get ratio(): number

  • A value between 0 and 1 describing the proportion of particles that will receive a light.

    Returns number

    Memberof

    LightsModule

  • set ratio(value): void

  • A value between 0 and 1 describing the proportion of particles that will receive a light.

    Parameters

    • value: number

    Returns void

    Memberof

    LightsModule

system

Methods

Protected_onDisable

Protected_onEnable

Protected_serialize

  • _serialize(meta): void
  • Protected

    Serialize

    Parameters

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

    Returns void

    Memberof

    LightsModule

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

  • Parameters

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

    Returns void

    Memberof

    LightsModule

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