Difference between revisions of "Body:isSleeping"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 +
Get the sleeping status of a body.
 +
 +
A sleeping body is much more efficient to simulate than when awake.
 +
 +
 +
If sleeping is allowed, a body that has come to rest will sleep.
  
 
== Function ==
 
== Function ==
Line 13: Line 19:
 
* [[parent::Body]]
 
* [[parent::Body]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the sleeping status of a body.
 +
}}

Revision as of 16:17, 14 February 2010

Get the sleeping status of a body.

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


If sleeping is allowed, a body that has come to rest will sleep.

Function

Synopsis

status = Body:isSleeping( )

Arguments

None.

Returns

boolean status
The sleeping status of the body.

See Also