Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Rigidbody2D.AddRelativeForce

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

Parameters

relativeForceComponents of the force in the X and Y axes.
modeThe 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.

Copyright © 2014 Unity Technologies
UnityGalleryAsset StoreBuyDownload