Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Rigidbody2D.SetRotation

Suggest a change

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.

Close

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.

Close

Cancel

Switch to Manual

Declaration

public void SetRotation(float angle);

Parameters

angle The rotation of the Rigidbody (in degrees).

Description

Sets the rotation of the Rigidbody2D to angle (given in degrees).

Additional resources: Rigidbody2D.rotation and Rigidbody2D.MoveRotation.

using UnityEngine;

// Rotate rigidBody2D every frame. public class ExampleScript : MonoBehaviour { public Rigidbody2D rigidBody2D; public float rotation = 0.0f;

void Start() { rigidBody2D = GetComponent<Rigidbody2D>(); }

void Update() { rigidBody2D.SetRotation(rotation);

rotation += 1.0f; } }

Declaration

public void SetRotation(Quaternion rotation);

Parameters

rotation Full 3D rotation used to extract only the z-axis rotation.

Description

Sets the rotation of the Rigidbody2D to the z-axis rotation extracted from the full 3D rotation.

The z-axis rotation is extracted from the given Quaternion rotation and used as the rotation for Rigidbody2D. It is important to understand that the full 3D rotation isn't used because the Rigidbody2D only has a single degree of rotational freedom around the z-axis.

using UnityEngine;

// Rotate rigidBody2D every frame. public class ExampleScript : MonoBehaviour { public Rigidbody2D rigidBody2D; public float rotation = 0.0f;

void Start() { rigidBody2D = GetComponent<Rigidbody2D>(); }

void Update() { var quaternionRotation = Quaternion.Euler(0f, 0f, rotation); rigidBody2D.SetRotation(rotation);

rotation += 1.0f; } }