Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

Light.cullingMask

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 cullingMask: int;
public int cullingMask;
public cullingMask as int

Description

This is used to light certain objects in the scene selectively.

A GameObject will only be illuminated by a light if that light's cullingMask/ includes the layer chosen for the GameObject (ie, the mask bit for the layer must be set to 1 for the object to receive any light). See Layers for more information about layer masking. See Also: Light component.

	// Only light objects in the first layer (Default layer)
	light.cullingMask = 1 << 0;
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        light.cullingMask = 1 << 0;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		light.cullingMask = (1 << 0)