Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Joint2D.GetReactionForce

Other Versions
Leave feedback
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 method GetReactionForce(timeStep: float): Vector2;
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.

See Also: reactionForce, breakForce.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 2017.2-001U. Built: 2017-12-08.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information