Version: 2017.2

LayerMask

struct in UnityEngine

Switch to Manual

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.

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"); } }

Note: LayerMask is a bitmask. Use LayerMask.GetMask and LayerMask.LayerToName to generate the bitmask.

Variables

valueConverts a layer mask value to an integer value.

Static Functions

GetMaskGiven a set of layer names as defined by either a Builtin or a User Layer in the Tags and Layers manager, returns the equivalent layer mask for all of them.
LayerToNameGiven a layer number, returns the name of the layer as defined in either a Builtin or a User Layer in the Tags and Layers manager.
NameToLayerGiven a layer name, returns the layer index as defined by either a Builtin or a User Layer in the Tags and Layers manager.

Operators

LayerMaskImplicitly converts an integer to a LayerMask.