Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

LayerMask.GetMask

Suggest a change

Success!

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function GetMask(params layerNames: string[]): int;
public static int GetMask(params string[] layerNames);

Parameters

layerNamesList of layer names to convert to a layer mask.

Returns

int The layer mask created from the layerNames.

Description

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.

	Debug.Log(LayerMask.GetMask("UserLayerA", "UserLayerB"));
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Example() { Debug.Log(LayerMask.GetMask("UserLayerA", "UserLayerB")); } }