Collision2D
Collision details returned by 2D physics callback functions.
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
public class Collision2D
Remarks
The collisions details are returned by MonoBehaviour.OnCollisionEnter2D(Collision2D), MonoBehaviour.OnCollisionStay2D(Collision2D) and MonoBehaviour.OnCollisionExit2D(Collision2D) callbacks. It details which Collider2D and Rigidbody2D pairs are involved in the collision as well as contact points where the Collider2D meet. Note: During the event, there are no contacts to be retrieved.
OnCollisionExit2DProperties
Property | Description |
|---|---|
| collider | The incoming Collider2D involved in the collision with the Collision2D.otherCollider. |
| contactCount | Gets the number of contacts for this collision. |
| contacts | The specific points of contact with the incoming Collider2D. You should avoid using this as it produces memory garbage. Use Collision2D.GetContact or Collision2D.GetContacts instead. |
| enabled | Indicates whether the collision response or reaction is enabled or disabled. |
| gameObject | The incoming GameObject involved in the collision. |
| otherCollider | The other Collider2D involved in the collision with the Collision2D.collider. |
| otherRigidbody | The other Rigidbody2D involved in the collision with the Collision2D.rigidbody. |
| relativeVelocity | The relative linear velocity of the two colliding objects (Read Only). |
| rigidbody | The incoming Rigidbody2D involved in the collision with the Collision2D.otherRigidbody. |
| transform | The Transform of the incoming object involved in the collision. |
Methods
Method | Description |
|---|---|
| GetContact | Gets the contact point at the specified index. |
| GetContacts | Retrieves all contact points for contacts between Collision2D.collider and Collision2D.otherCollider. |