Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Collision2D

Collision details returned by 2D physics callback functions.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule
public class Collision2D

Remarks

The collisions details are returned by
OnCollisionEnter2D
,
OnCollisionStay2D
and
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.

Properties

Property

Description

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 Collision2D.GetContact or Collision2D.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.

Methods

Method

Description

GetContactGets the contact point at the specified
index
.
GetContactsRetrieves all contact points for contacts between _collider and _otherCollider.