Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


includeLayers

The additional Layers that this Collider2D should include when deciding if a contact with another Collider2D should happen or not.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public LayerMask includeLayers { get; set; }

Remarks

The Layer Collision Matrix defines which Layers can and cannot contact other Layers. This property allows you to specify additional Layers that this specific Collider2D instance can contact.
NOTE: Because Layers can be included or excluded differently depending on the settings of each Collider2D instance, there is the potential for a conflicting decision for whether contact should happen or not when two Collider2D instances come into contact with each other. You can find the detailed rules for how Unity arbitrates this decision in the Collider2D.layerOverridePriority documentation.