Select your preferred scripting language. All code snippets will be displayed in this language.
struct in UnityEngine
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseLayerMask 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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information