Version: Unity 6.4 (6000.4)
Language : English
Custom Collider 2D
Use a Custom Collider 2D

Custom Collider 2D component reference

The Custom ColliderAn invisible shape that is used to handle physical collisions for an object. A collider doesn’t need to be exactly the same shape as the object’s mesh - a rough approximation is often more efficient and indistinguishable in gameplay. More info
See in Glossary
2D is a Collider 2D that interacts with the 2D physics system. Unlike other colliders, you don’t configure this collider in the Unity Editor, instead you configure the collider by assigning PhysicsShape2D geometry to it via the PhysicsShapeGroup2D API.

You can define the collider’s shape by adding, removing, and modifying the PhysicsShape2D shapes. Refer to the PhysicsShape2D API documentation for more information. This also means that a Custom Collider 2D component can contain an unlimited number of low-level PhysicsShape2D and form any shape, or emulate other types of colliders.

Property Function
Material Select the Physics Material 2DUse this to adjust the friction and bounce that occurs between 2D physics objects when they collide More info
See in Glossary
that determines properties of collisionsA collision occurs when the physics engine detects that the colliders of two GameObjects make contact or overlap, when at least one has a Rigidbody component and is in motion. More info
See in Glossary
, such as friction and bounce.
Is Trigger Enable this if you want the collider to behave as a trigger. The physics system ignores the collider when you enable this option.
Used By Effector Enable this if you want an attached Effector 2D component to use the collider.
Offset Set the local offset values of the collider geometry.
Custom Shape Count (Read only) Indicates how many PhysicsShape2D shapes the collider is using.
Custom Vertex Count (Read only) Indicates the total number of vertices across all PhysicsShape2D shapes in the collider.
Layer Overrides Expand for the layer override settings.
    Layer Override Priority Sets the decision priority when this collision shape collides with another collision shape. Refer to its API documentation for more information.
    Include Layers Sets the layers this collision shape collides with. Refer to Collider2D-includeLayers.
    Exclude Layers Sets the layers this collision shape doesn’t collide with. Refer to Collider2D-excludeLayers.
    Force Send Layers Sets the layers this collision shape sends forces to during collisions. Refer to Collider2D-forceSendLayers.
    Force Receive Layers Sets the layers this collision shape can receive forces from during collisions. Refer to Collider2D-forceReceiveLayers.
    Contact Capture Layers Sets the layers of other Collider 2D components to capture during collisions. Refer to Collider2D-contactCaptureLayers.
    Callback Layers Sets the layers to report collisions or triggers with. Refer to Collider2D-callbackLayers.

Additional resources

CustomCollider2D

Custom Collider 2D
Use a Custom Collider 2D