Custom Collider 2D component reference
Refer to the Custom Collider 2D properties to create customizable collision geometry.
Read time 2 minutesLast updated 20 days ago
The Custom Collider 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 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 and form any shape, or emulate other types of colliders.
PhysicsShape2DPhysicsShape2DProperty | Function |
|---|---|
| Material | Select the Physics Material 2D that determines properties of collisions, 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 |
| Custom Vertex Count (Read only) | Indicates the total number of vertices across all |
| 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 |
| Exclude Layers | Sets the layers this collision shape doesn't collide with. Refer to |
| Force Send Layers | Sets the layers this collision shape sends forces to during collisions. Refer to |
| Force Receive Layers | Sets the layers this collision shape can receive forces from during collisions. Refer to |
| Contact Capture Layers | Sets the layers of other Collider 2D components to capture during collisions. Refer to |
| Callback Layers | Sets the layers to report collisions or triggers with. Refer to |