Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

Rigidbody2D.AddRelativeForce

Other Versions
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

Switch to Manual
public function AddRelativeForce(relativeForce: Vector2, mode: ForceMode2D = ForceMode2D.Force): void;
public void AddRelativeForce(Vector2 relativeForce, ForceMode2D mode = ForceMode2D.Force);

Parameters

relativeForce Components of the force in the X and Y axes.
mode The method used to apply the specified force.

Description

Adds a force to the rigidbody2D relative to its coordinate system.

The force is specified as two separate components in the X and Y directions (there is no Z direction in 2D physics). The object will be accelerated by the force according to the law force = mass x acceleration - the larger the mass, the greater the force required to accelerate to a given speed.

See Also: AddForceAtPosition, AddTorque, mass, velocity, AddForce, ForceMode2D.

Leave Feedback

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: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store