GetLayerMask(params string[])
Get a PhysicsMask for the specified layer name(s).
Read time 1 minuteLast updated 14 days ago
Definition
- Type: Method
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
GetLayerMask(string[])
public static PhysicsMask GetLayerMask(params string[] layerNames)
Parameters
The layer names (case sensitive) to find a combined physics mask for.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
Use this method to build the category and contact masks for a PhysicsShape.ContactFilter so a shape only collides with the layers it needs to. Create the layers in a PhysicsCoreSettings2D asset first.
Examples
// 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"); }}