Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Collider2D.excludeLayers

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

public LayerMask excludeLayers;

Description

The additional Layers that this Collider2D should exclude when deciding if a contact with another Collider2D should happen or not.

The Layer Collision Matrix defines which Layers can and cannot contact other Layers. This property allows you to exclude Layers that this specific Collider2D instance should not contact.

When excluding Layers, all Layers that should be included are first included before finally excluding Layers. In other words, both including and excluding a Layer results in the Layer always being excluded.

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.

Additional resources: Collider2D.includeLayers, Rigidbody2D.includeLayers & Rigidbody2D.excludeLayers.