Unity Script Reference

LayerMask Struct

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.

JavaScripts

// 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 example : 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

class example(MonoBehaviour):

public mask as LayerMask = (-1)

def Update():
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.

Class Functions

operator LayerMask	implicitly converts an integer to a LayerMask
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