Script language:

  • JS
  • C#
  • Boo
Script language

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

Suggest a change

LayerMask

Description

LayerMask allow you to display the LayerMask popup menu in the inspector.

Similar to those in the camera.cullingMask. Layer masks can be used selectively filter game objects for example when casting rays.

// Casts a ray using the layer mask,
// which can be modified in the inspector.

var mask : LayerMask = -1; function Update () { if (Physics.Raycast (transform.position, transform.forward, 100, mask.value)) { Debug.Log("Hit something"); } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public LayerMask mask = -1;
    void Update() {
        if (Physics.Raycast(transform.position, transform.forward, 100, mask.value))
            Debug.Log("Hit something");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public mask as LayerMask = (-1)

	def Update() as void:
		if Physics.Raycast(transform.position, transform.forward, 100, mask.value):
			Debug.Log('Hit something')

Variables

value Converts a layer mask value to an integer value.

Static Functions

GetMask Given a set of layer names as defined by either a Builtin or a User Layer in the Tag Manager, returns the equivalent layer mask for all of them.
LayerToName Given a layer number, returns the name of the layer as defined in either a Builtin or a User Layer in the Tag Manager.
NameToLayer Given a layer name, returns the layer index as defined by either a Builtin or a User Layer in the Tag Manager.

Operators

LayerMask Implicitly converts an integer to a LayerMask.
Your name (optional):
Your email (optional):
Please write your suggestion here: