Light

Description

Script interface for light components.

Use this to control all aspects of Unity's lights. The properties are an exact match for the values shown in the Inspector.

Usually lights are just created in the editor but sometimes you want to create a light from a script:

function Start () {
	// Make a game object
	var lightGameObject : GameObject = new GameObject("The Light");
	// Add the light component
	lightGameObject.AddComponent(Light);
	// Set color and position
	lightGameObject.light.color = Color.blue;
	// Set the position (or any transform property) after
	// adding the light component.
	lightGameObject.transform.position = Vector3(0, 5, 0);
}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Start() {
        GameObject lightGameObject = new GameObject("The Light");
        lightGameObject.AddComponent<Light>();
        lightGameObject.light.color = Color.blue;
        lightGameObject.transform.position = new Vector3(0, 5, 0);
    }
}

import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Start() as void:
		lightGameObject as GameObject = GameObject('The Light')
		lightGameObject.AddComponent[of Light]()
		lightGameObject.light.color = Color.blue
		lightGameObject.transform.position = Vector3(0, 5, 0)

Variables

alreadyLightmapped	Has the light already been lightmapped.
areaSize	The size of the area light. Editor only.
color	The color of the light.
cookie	The cookie texture projected by the light.
cookieSize	The size of a directional light's cookie.
cullingMask	This is used to light certain objects in the scene selectively.
flare	The flare asset to use for this light.
intensity	The Intensity of a light is multiplied with the Light color.
range	The range of the light.
renderMode	How to render the light.
shadowBias	Shadow mapping bias.
shadows	How this light casts shadows
shadowSoftness	Softness of directional light's soft shadows.
shadowSoftnessFade	Fadeout speed of directional light's soft shadows.
shadowStrength	Strength of light's shadows.
spotAngle	The angle of the light's spotlight cone in degrees.
type	The type of the light.

Inherited members