Version: 2023.1
LanguageEnglish
  • C#

RigidbodyConstraints.FreezePosition

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

Description

Freeze motion along all axes.

//Attach this script to a GameObject with a Rigidbody. Press the up and down keys to move the Rigidbody up and down.
//Press the space key to freeze all positions.

using UnityEngine;

public class Example : MonoBehaviour { Rigidbody m_Rigidbody; Vector3 m_YAxis;

void Start() { m_Rigidbody = GetComponent<Rigidbody>(); //Set up vector for moving the Rigidbody in the y axis m_YAxis = new Vector3(0, 5, 0); }

void Update() { //Press space to add constraints on the RigidBody (Freezing the position) if (Input.GetKeyDown(KeyCode.Space)) { //Freeze all positions m_Rigidbody.constraints = RigidbodyConstraints.FreezePosition; }

//Press the up arrow key to move positively in the y axis if the constraints are removed if (Input.GetKeyDown(KeyCode.UpArrow)) { //If the constraints are removed, the Rigidbody moves along the y axis //If the constraints are there, no movement occurs m_Rigidbody.velocity = m_YAxis; }

//Press the down arrow key to move negatively in the y axis if the constraints are removed if (Input.GetKeyDown(KeyCode.DownArrow)) { m_Rigidbody.velocity = -m_YAxis; } } }