Unity - Scripting API: Rigidbody.AddRelativeTorque
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.
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.
Parameters
| Parameter | Description |
|---|---|
| torque | Torque vector in local coordinates. |
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.
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: AddTorque, AddRelativeForce.
// Rotate an object around its Y (upward) axis in response to // left/right controls.using UnityEngine; using UnityEngine.InputSystem;
public class ExampleClass : MonoBehaviour { private float torque = 4; private Rigidbody rb; void Awake() { rb = GetComponent<Rigidbody>(); } void FixedUpdate() { float turnInput = Keyboard.current.spaceKey.isPressed ? 1f : 0f;
rb.AddRelativeTorque(Vector3.up * torque * turnInput); } }
Declaration
public void AddRelativeTorque(float x, float y, float z, ForceMode mode = ForceMode.Force);
Parameters
| Parameter | Description |
|---|---|
| x | Size of torque along the local x-axis. |
| y | Size of torque along the local y-axis. |
| z | Size 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.
Wakes up the Rigidbody by default. If the torque size is zero then the Rigidbody will not be woken up.