Version: 2023.2
LanguageEnglish
  • C#

Joint2D.breakAction

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

public JointBreakAction2D breakAction;

Description

The action to take when the joint breaks the breakForce or breakTorque.

A joint breaks when the force a joint exerts exceeds breakForce or when the torque a joint exerts exceeds breakTorque. The joint action happens after the call to Joint2D.OnJointBreak2D has completed. If the breakAction is changed during the Joint2D.OnJointBreak2D callback then that updated action happens.

Additional resources: JointBreakAction2D.