Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

sleep

sleep<Target>(authority, entity): BodyRefusal | null

Puts a dynamic body to sleep now, its velocity zeroed, until a force, a contact or wakeUp wakes it: a crate a level places at rest. Returns null, or in a deployed world the reason it refused.

Type Parameter
Target extends Entity
Parameter Type
authority EntityAuthority
entity BodyTarget<Target, Dynamic>

BodyRefusal | null