19.4.31 sleep

self = physics.Body:sleep()

Parameter

Type

Description

self

in physics.Body

The input Body

bool

out physics.Body

The input Body is returned as the output

Puts the Body to sleep.

Info

See http://chipmunk-physics.net/release/Chipmunk-5.x/Chipmunk-5.3.4-Docs/ for an explanation of sleeping bodies.

Note

The body must be added to a Space before it can be put to sleep.

Calling this function within a query or callback is not allowed.

Introduced in platform.apiLevel = '2.0'