Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

AddRelativeTorque

Adds a torque to the rigidbody relative to its coordinate system.
Read time 1 minuteLast updated 13 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule

AddRelativeTorque(Vector3, ForceMode)

Adds a torque to the rigidbody relative to its coordinate system.
public void AddRelativeTorque(Vector3 torque, ForceMode mode)

Parameters

torque

Vector3
Torque vector in local coordinates.

mode

ForceMode

Remarks

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeTorque has no effect.
Wakes up the Rigidbody by default. If the torque size is zero then the Rigidbody will not be woken up.
For more information on how ForceMode affects angular velocity, see Rigidbody.AddTorque.
Additional Resources: Rigidbody.AddTorque, Rigidbody.AddRelativeForce.

Examples

// Rotate an object around its Y (upward) axis in response to// left/right controls.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{    public float torque;    public Rigidbody rb;    void Start()    {        rb = GetComponent<Rigidbody>();    }    void FixedUpdate()    {        float turn = Input.GetAxis("Horizontal");        rb.AddRelativeTorque(Vector3.up * torque * turn);    }}

AddRelativeTorque(float, float, float, ForceMode)

Adds a torque to the rigidbody relative to its coordinate system.
public void AddRelativeTorque(float x, float y, float z, ForceMode mode)

Parameters

x

float
Size of torque along the local x-axis.

y

float
Size of torque along the local y-axis.

z

float
Size of torque along the local z-axis.

mode

ForceMode

Remarks

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeTorque has no effect.
Wakes up the Rigidbody by default. If the torque size is zero then the Rigidbody will not be woken up.