Version: 2022.3
LanguageEnglish
  • C#

Collider2D.includeLayers

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 includeLayers;

Description

The additional Layers that this Collider2D should include 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 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.

See Also: Collider2D.excludeLayers, Rigidbody2D.includeLayers & Rigidbody2D.excludeLayers.

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961