Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

IPreContactCallback

interface in Unity.U2D.Physics

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

An interface that when implemented, is called as a contact between a pair of shapes is updated, before the contact is solved. The callback receives the full contact manifold and may modify it, or cancel the contact by calling Cancel on the event.

This is only called if the PhysicsWorld and one of the PhysicsShape both have their preContactCallbacks set to true. It takes priority over the deprecated Unity.U2D.Physics.PhysicsCallbacks.IPreSolveCallback, which is only used when this interface is not implemented on the same target.

Public Methods

Method Description
OnPreContact2D Called when a contact between a pair of shapes is updated, giving the opportunity to modify the contact manifold before it is solved. Any change written to the manifold is used by the solver this step, and calling Cancel on the event cancels the contact. Modifying the world-space contact points or the point identifiers has no effect, as the solver does not read them.