Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

Rigidbody2D.sleepMode

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 var sleepMode: RigidbodySleepMode2D;
public RigidbodySleepMode2D sleepMode;
public sleepMode as RigidbodySleepMode2D

Description

The sleep state that the rigidbody will initially be in.

Sleeping is an optimisation that is used to temporarily remove an object from physics simulation when it is at rest. This property chooses whether the rigidbody should start off asleep, awake or have sleeping turned off altogether.

See the Physics Overview in the manual for more information about Rigidbody sleeping.

See Also: Sleep, IsSleeping, WakeUp, Rigidbody.Sleep.