Skip to main content

Collisions & Overlaps

Collision and overlap events, their state, and contact points.

Commonly used

Guides

All APIs in this topic

Event data

APIDescription
CollisionEnterEventArgsArgs used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins.
CollisionExitEventArgsArgs used for ColliderComponent.onCollisionExit, which is triggered when a collision ends.
CollisionStayEventArgsArgs used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.
OverlapEnterEventArgsArgs used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object.
OverlapExitEventArgsArgs used for ColliderComponent.onOverlapExit, which is triggered when the collider stops overlapping another object.
OverlapStayEventArgsArgs used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object.

Objects and data

APIDescription
CollisionA state generated for ColliderComponent collision events.
ContactContact point between two colliding objects.
OverlapExposes state generated for ColliderComponent overlap events.