Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Joint2D.GetReactionForce

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

Declaration

public Vector2 GetReactionForce(float timeStep);

Parameters

timeStep The time to calculate the reaction force for.

Returns

Vector2 The reaction force of the joint in the specified timeStep.

Description

Gets the reaction force of the joint given the specified timeStep.

When a joint tries to constrain a Rigidbody2D it may need to apply a force to do so. This is known as the reaction force.

Additional resources: reactionForce, breakForce.