Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

Rigidbody2D.Sleep

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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
public function Sleep(): void;
public void Sleep();

Description

Make the rigidbody "sleep".

Sleeping is an optimisation that is used to temporarily remove an object from physics simulation when it is at rest. This function makes the rigidbody sleep - it is sometimes desirable to enable this manually rather than allowing automatic sleeping with the sleepMode property.

See Also: IsSleeping, WakeUp, sleepMode.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information