Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

Rigidbody.AddRelativeForce

Switch to Manual
public function AddRelativeForce(force: Vector3, mode: ForceMode = ForceMode.Force): void;

Parameters

forceIn local coordinate system.

Description

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

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeForce has no effect.

See Also: AddForce, AddForceAtPosition, AddRelativeTorque.

#pragma strict
// Add a thrust force to push an object in its current forward
// direction (to simulate a rocket motor, say).
public var thrust;
public var rb;
function Start() {
	rb = GetComponent.<Rigidbody>();
}
function FixedUpdate() {
	rb.AddRelativeForce(Vector3.forward * thrust);
}

public function AddRelativeForce(x: float, y: float, z: float, mode: ForceMode = ForceMode.Force): void;

Parameters

xSize of force along the local x-axis.
ySize of force along the local y-axis.
zSize of force along the local z-axis.

Description

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

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeForce has no effect.