Difference between revisions of "Body:putToSleep"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 +
Put the body to sleep.
 +
 +
A sleeping body is much more efficient to simulate than when awake.
 +
 +
 +
The body will wakeup if another body collides with it, if a joint or contact attached to it is destroyed, or if [[Body:wakeUp]] is called.
  
 
== Function ==
 
== Function ==
Line 13: Line 19:
 
* [[parent::Body]]
 
* [[parent::Body]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Put the body to sleep.
 +
}}

Revision as of 16:17, 14 February 2010

Put the body to sleep.

A sleeping body is much more efficient to simulate than when awake.


The body will wakeup if another body collides with it, if a joint or contact attached to it is destroyed, or if Body:wakeUp is called.

Function

Synopsis

Body:putToSleep( )

Arguments

None.

Returns

Nothing.

See Also