Version: 2020.1
LanguageEnglish
  • C#

Collision2D

class in UnityEngine

/

Implemented in:UnityEngine.Physics2DModule

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Collision 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.

Properties

colliderThe incoming Collider2D involved in the collision with the otherCollider.
contactCountGets the number of contacts for this collision.
contactsThe specific points of contact with the incoming Collider2D. You should avoid using this as it produces memory garbage. Use GetContact or GetContacts instead.
enabledIndicates whether the collision response or reaction is enabled or disabled.
gameObjectThe incoming GameObject involved in the collision.
otherColliderThe other Collider2D involved in the collision with the collider.
otherRigidbodyThe other Rigidbody2D involved in the collision with the rigidbody.
relativeVelocityThe relative linear velocity of the two colliding objects (Read Only).
rigidbodyThe incoming Rigidbody2D involved in the collision with the otherRigidbody.
transformThe Transform of the incoming object involved in the collision.

Public Methods

GetContactGets the contact point at the specified index.
GetContactsRetrieves all contact points for contacts between collider and otherCollider.

Did you find this page useful? Please give it a rating: