Box Collider 2D
Switch to ScriptingThe Box 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 that interacts with the 2D physics system. It’s a rectangle in shape with a defined position, width, and height in the local coordinate space of a spriteA 2D graphic objects. If you are used to working in 3D, Sprites are essentially just standard textures but there are special techniques for combining and managing sprite textures for efficiency and convenience during development. More info
See in Glossary. Note: The selection rectangle is axis-aligned, with its edges parallel to the x or y axes of local space.
Box Collider 2D properties
| Property | Function | |
|---|---|---|
| Material | Select the Physics Material 2DUse 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 this Collider 2D to behave as a trigger. The physics system ignores this Collider when this is enabled. | |
| Used by Effector | Enable this if you want the Collider 2D to be used by an attached Effector 2D. | |
| Composite Operations | Select the composite operation used by an attached Composite Collider 2D component. Note: When you select any operation besides None, the following properties—Material, Is Trigger, Used By Effector, and Edge Radius—become controlled by the attached Composite Collider 2D component and are no longer available in this collider’s properties. |
|
| None | Select this to have no composite operation take place. | |
| Merge | Select this to have this composite operation compose geometry using a Boolean OR operation. | |
| Intersect | Select this to have this composite operation compose geometry using a Boolean AND operation. | |
| Difference | Select this to have this composite operation compose geometry using a Boolean NOT operation. | |
| Flip | Select this to have this composite operation compose geometry using a Boolean XOR operation. | |
| Auto Tiling | Enable this if the Sprite RendererA component that lets you display images as Sprites for use in both 2D and 3D scenes. More info See in Glossary component for the selected Sprite has the Draw Mode set to Tiled. This enables automatic updates to the shape of the Collider 2D, allowing the shape to automatically readjust when the Sprite’s dimensions change. If you don’t enable Auto Tiling, the Collider 2D geometry doesn’t automatically repeat. |
|
| Offset | Set the local offset values of the Collider 2D geometry. | |
| Size | Set the size of the box in local space units. | |
| Edge Radius | Set a value that forms a radius around the edge of the Collider. This results in a larger Collider 2D with rounded convex corners. The default value is 0 (no radius). | |
| Layer Overrides | Expand for the Layer override settings. | |
| Layer Override Priority | Assign the decision priority that this Collider2D uses when resolving conflicting decisions on whether a contact between itself and another Collision2D should happen or not. Refer to its API page for more information. | |
| Include Layers | Select the additional Layers that this Collider 2D should include when deciding if a contact with another Collider2D should happen or not. Refer to its API documentation for more information. | |
| Exclude Layers | Select the additional Layers that this Collider 2D should exclude when deciding if a contact with another Collider2D should happen or not. Refer to its API documentation for more information. | |
| Force Send Layers | Select the Layers that this Collider 2D is allowed to send forces to during a Collision contact with another Collider2D. Refer to its API documentation for more information. | |
| Force Receive Layers | Select the Layers that this Collider 2D can receive forces from during a Collision contact with another Collider2D. Refer to its API documentation for more information. | |
| Contract Capture Layers | Select the Layers of other Collider 2D, involved in contacts with this Collider2D, that will be captured. Refer to its API documentation for more information. | |
| Callback Layers | Select the Layers that this Collider 2D, during a contact with another Collider2D, will report collision or trigger callbacks for. Refer to its API documentation for more information. | |
Additional resources
BoxCollider2D