Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ParticleSystem.LightsModule.enabled

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public var enabled: bool;
public bool enabled;

Description

Enable/disable the Lights module.

#pragma strict
// For best results, use Deferred Rendering (see Camera settings)
private var ps: ParticleSystem;
public var lightPrefab: Light;
public var moduleEnabled: boolean = true;
function Start() {
	ps = GetComponent.<ParticleSystem>();
	ps.transform.localRotation = Quaternion.Euler(0.0f, 0.0f, 45.0f);
	var shape: var = ps.shape;
	shape.shapeType = ParticleSystemShapeType.Circle;
	var lights: var = ps.lights;
	lights.light = lightPrefab;
	lights.ratio = 1.0f;
	lights.maxLights = 1000;
	// plane to receive lights
	var plane: var = GameObject.CreatePrimitive(PrimitiveType.Plane);
	plane.transform.parent = ps.transform;
	plane.transform.localPosition = new Vector3(0.0f, 0.0f, 3.0f);
	plane.transform.localScale = new Vector3(20.0f, 20.0f, 20.0f);
	plane.transform.localRotation = Quaternion.Euler(-90.0f, 0.0f, 0.0f);
	var material: var = new Material(Shader.Find("Standard"));
	material.color = new Color(0.1f, 0.1f, 0.1f, 1.0f);
	plane.GetComponent.<MeshRenderer>().material = material;
}
function Update() {
	var lights: var = ps.lights;
	lights.enabled = moduleEnabled;
}
function OnGUI() {
	moduleEnabled = GUI.Toggle(new Rect(25, 45, 200, 30), moduleEnabled, "Enabled");
}
using UnityEngine;
using System.Collections;

// For best results, use Deferred Rendering (see Camera settings) public class ExampleClass : MonoBehaviour { private ParticleSystem ps; public Light lightPrefab; // Provide a light Prefab in the inspector (eg a default Point Light) public bool moduleEnabled = true;

void Start() { ps = GetComponent<ParticleSystem>(); ps.transform.localRotation = Quaternion.Euler(0.0f, 0.0f, 45.0f);

var shape = ps.shape; shape.shapeType = ParticleSystemShapeType.Circle;

var lights = ps.lights; lights.light = lightPrefab; lights.ratio = 1.0f; lights.maxLights = 1000;

// plane to receive lights var plane = GameObject.CreatePrimitive(PrimitiveType.Plane); plane.transform.parent = ps.transform; plane.transform.localPosition = new Vector3(0.0f, 0.0f, 3.0f); plane.transform.localScale = new Vector3(20.0f, 20.0f, 20.0f); plane.transform.localRotation = Quaternion.Euler(-90.0f, 0.0f, 0.0f);

var material = new Material(Shader.Find("Standard")); material.color = new Color(0.1f, 0.1f, 0.1f, 1.0f); plane.GetComponent<MeshRenderer>().material = material; }

void Update() { var lights = ps.lights; lights.enabled = moduleEnabled; }

void OnGUI() { moduleEnabled = GUI.Toggle(new Rect(25, 45, 200, 30), moduleEnabled, "Enabled"); } }