Version: 2023.2
LanguageEnglish
  • C#

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

Switch to Manual
public LayerMask excludeLayers;

Description

The additional layers that all Colliders attached to this Rigidbody should exclude when deciding if the Collider can come into contact with another Collider.

The Layer Collision Matrix defines which layers can and cannot contact other layers. Use this property to specify additional layers that all Colliders attached to this Rigidbody instance can't contact.

When deciding which layers can contact each other, the Layer Collision Matrix first includes layers, then excludes layers. If a layer is set to be included and excluded, it is excluded.

NOTE: Layers can be included or excluded differently depending on the settings of each Collider instance. As such, there could be a conflicting decision for whether two Collider instances can come into contact with each other. To learn how Unity decides this, see Collider.layerOverridePriority.

Additional resources: Collider.includeLayers, Rigidbody.includeLayers, ArticulationBody.includeLayers, ArticulationBody.excludeLayers.