Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

Collider2D.usedByComposite

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 bool usedByComposite;

Description

Sets whether the Collider will be used or not used by a CompositeCollider2D.

When a CompositeCollider2D is used, the Collider geometry is merged together with any other Colliders using the same Composite Collider.

When a Collider is used by a Composite Collider, the Editor will ignore and not show the Collider2D.sharedMaterial, Collider2D.isTrigger & Collider2D.usedByEffector properties. The same properties on the CompositeCollider2D will be used instead. You should set these properties on the Composite Collider instead to merge all colliders into the composite Collider.

This usedByComposite property is only available in BoxCollider2D and PolygonCollider2D.

Did you find this page useful? Please give it a rating: