Version: 2023.2
LanguageEnglish
  • C#

Physics.ContactModifyEvent

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

Parameters

value A delegate to call.

Description

Subscribe to this event to be able to customize the collision response for contact pairs.

Each subscriber to this event gets invoked with a physics scene and a native array of contact pairs to process. Each contact pair has modifiable data, like impulses and contact normals that can be changed in order to customize the bounce behavior.

Only pairs containing Colliders that had Collider.hasModifiableContacts enabled will be passed in the buffer.

Note that this event is called from any thread, so it's advisable to keep copies of all necessary for handling data because only a portion of Unity API is available off the main thread.

Additionally, an event handler can be invoked multiple times per frame, because the physics system distributes all contacts among threads, and only sends a particular amount of contacts per call.

Note: to get contact pairs that have been generated by the CCD solver, subscribe to the Physics.ContactModifyEventCCD event. They are not included in this event.

using Unity.Collections;
using UnityEngine;

public class Test : MonoBehaviour { public float IgnoredRadius = 0.5f; public Vector3 SpawnAt = Vector3.up * 5f;

public void OnEnable() { var ball = GameObject.CreatePrimitive(PrimitiveType.Sphere); GameObject.CreatePrimitive(PrimitiveType.Plane);

ball.transform.position = SpawnAt; ball.AddComponent<Rigidbody>(); ball.GetComponent<SphereCollider>().hasModifiableContacts = true;

Physics.ContactModifyEvent += ModificationEvent; }

public void OnDisable() { Physics.ContactModifyEvent -= ModificationEvent; }

public void ModificationEvent(PhysicsScene scene, NativeArray<ModifiableContactPair> pairs) { // For each contact pair, ignore the contact points that are close to origin foreach (var pair in pairs) { for (int i = 0; i < pair.contactCount; ++i) if (Vector3.Distance(pair.GetPoint(i), Vector3.zero) < IgnoredRadius) pair.IgnoreContact(i); } } }