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"); } }
Note: LayerMask is a bitmask. Use LayerMask.GetMask and LayerMask.LayerToName to generate the bitmask.
| value | Converts a layer mask value to an integer value. |
| GetMask | Given 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. |
| LayerToName | Given 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. |
| NameToLayer | Given a layer name, returns the layer index as defined by either a Builtin or a User Layer in the Tags and Layers manager. |
| LayerMask | Implicitly converts an integer to a LayerMask. |