Documentation
Resources
Community
Premium Support
Manual     Reference     Scripting  
  
Scripting > Runtime Classes > Rigidbody Switch to Component   

Rigidbody.Sleep  

function Sleep () : 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 Rigidbody Sleeping for more information.

JavaScripts
rigidbody.Sleep();

using UnityEngine;
using System.Collections;

public class example : MonoBehaviour {
void Awake() {
rigidbody.Sleep();
}
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

def Awake():
rigidbody.Sleep()