ParticleSystem.LightsModule
Script interface for LightsModule.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.ParticleSystemModule
public struct ParticleSystem.LightsModule
Remarks
This module allows you to attach real-time Lights to a percentage of your particles.
This module allows particles to cast light onto their environment easily. Lights can inherit properties from the particles they are attached to, such as color and size. This module supports Point and Spot Lights, including shadow casting and Light cookies.
Additional Resources: ParticleSystem, _lights
Examples
using UnityEngine;using System.Collections;[RequireComponent(typeof(ParticleSystem))]public class ExampleClass : MonoBehaviour{ public Light myLight; void Start() { ParticleSystem ps = GetComponent<ParticleSystem>(); var lights = ps.lights; lights.enabled = true; lights.ratio = 0.5f; lights.light = myLight; }}
Properties
Property | Description |
|---|---|
| alphaAffectsIntensity | Toggle whether the system multiplies the particle alpha by the light intensity when it computes the final light intensity. |
| enabled | Specifies whether the LightsModule is enabled or disabled. |
| intensity | Define a curve to apply custom intensity scaling to particle Lights. |
| intensityMultiplier | Intensity multiplier. |
| light | Select what Light Prefab you want to base your particle lights on. |
| maxLights | Set a limit on how many Lights this Module can create. |
| range | Define a curve to apply custom range scaling to particle Lights. |
| rangeMultiplier | Range multiplier. |
| ratio | Choose what proportion of particles receive a dynamic light. |
| sizeAffectsRange | Toggle whether the system multiplies the particle size by the light range to determine the final light range. |
| useParticleColor | Toggle whether the particle lights multiply their color by the particle color. |
| useRandomDistribution | Randomly assign Lights to new particles based on _ratio. |