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.AddRelativeTorque

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

Parameters

torqueIn local coordinate system.

Description

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

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

See Also: AddTorque, AddRelativeForce.

// Rotate an object around its Y (upward) axis in response to
// left/right controls.
var torque: float;
var rb: Rigidbody;

function Start() { rb = GetComponent.<Rigidbody>(); }

function FixedUpdate() { var turn = Input.GetAxis("Horizontal"); rb.AddRelativeTorque(Vector3.up * torque * turn); }

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

Parameters

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

Description

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

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