Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

PhysicsLayers.GetLayerMask

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

Submission failed

For 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.

Close

Cancel

Declaration

public static PhysicsMask GetLayerMask(params string[] layerNames);

Parameters

Parameter Description
layerNames The layer names (case sensitive) to find a combined physics mask for.

Returns

PhysicsMask The combined physics mask associated with the specified layer names. If a layer name isn't found, Unity produces a console warning and returns PhysicsMask.None.

Description

Get a PhysicsMask for the specified layer name(s).

Use this method to build the category and contact masks for a ContactFilter so a shape only collides with the layers it needs to. Create the layers in a PhysicsCoreSettings2D asset first.

 // Get a physics mask for a single layer, and another for a group of layers
 // that the object should collide with.
 using UnityEngine;
 using Unity.U2D.Physics;

public class GetLayerMaskExample : MonoBehaviour { void Start() { PhysicsMask objectLayer = PhysicsLayers.GetLayerMask("Car"); PhysicsMask contactLayer = PhysicsLayers.GetLayerMask("Walls"); } }