Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Sleep(): void;
void Sleep();
def Sleep() as void

Description

Forces a rigidbody to sleep at least one frame.

A common use is to call this from Awake in order to make a rigidbody sleep at startup. See the Physics Overview in the manual for more information about Rigidbody sleeping.

	rigidbody.Sleep();
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        rigidbody.Sleep();
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		rigidbody.Sleep()