PhysicsEvents.ContactBeginEvent
An event produced by a pair of Shapes, neither of which are a trigger, began touching. The shapes provided may have been destroyed so they should always be validated with PhysicsShape.isValid. See PhysicsWorld.contactBeginEvents.
Read time 1 minuteLast updated 3 days ago
Definition
- Type: Struct
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
- Implements: IEquatable<ContactBeginEvent>
public readonly struct PhysicsEvents.ContactBeginEvent : IEquatable<PhysicsEvents.ContactBeginEvent>
Properties
Property | Description |
|---|---|
| contactId | The unique Id of the contact. This contact is volatile and may be destroyed automatically when the world is modified or simulated therefore it should always be checked for validity with PhysicsShape.ContactId.isValid. |
| firstGroup | Whether this is the first contact event between the two groups the shapes belong to. Always true when either shape has no group or the world has event grouping disallowed. This is only reliable when each group's shapes all belong to one body. |
| shapeA | One of the shapes involved in the event. |
| shapeB | The other shape involved in the event. |