Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

LayerMask.GetMask

static function GetMask(params layerNames: string[]): int;
static int GetMask(params string[] layerNames);
static def GetMask(*layerNames as string[]) as int

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"));
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		Debug.Log(LayerMask.GetMask('UserLayerA', 'UserLayerB'))