class in UnityEngine
/
Implemented in:UnityEngine.Physics2DModule
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.
CloseFor 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.
CloseCollision details returned by 2D physics callback functions.
The collisions details are returned by MonoBehaviour.OnCollisionEnter2D, MonoBehaviour.OnCollisionStay2D and MonoBehaviour.OnCollisionExit2D 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 OnCollisionExit2D
event, there are no contacts to be retrieved.
collider | The incoming Collider2D involved in the collision with the 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 GetContact or 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 collider. |
otherRigidbody | The other Rigidbody2D involved in the collision with the rigidbody. |
relativeVelocity | The relative linear velocity of the two colliding objects (Read Only). |
rigidbody | The incoming Rigidbody2D involved in the collision with the otherRigidbody. |
transform | The Transform of the incoming object involved in the collision. |
GetContact | Gets the contact point at the specified index. |
GetContacts | Retrieves all contact points for contacts between collider and otherCollider. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.