Difference between revisions of "R3d.Body:setIsAllowedToSleep"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
 
r3d.Body:setIsAllowedToSleep(allowed)
 
r3d.Body:setIsAllowedToSleep(allowed)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
The sleeping technique is used to disable the simulation of resting bodies. By default, the bodies are allowed to sleep when they come to rest.
  
 
=== Parameters ===
 
=== Parameters ===
'''allowed''': (boolean) either true or false (default is '''true''')<br/>
+
'''allowed''': (boolean) either true or false, '''default true'''<br/>
  
 
=== Example ===
 
=== Example ===
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 +
// This rigid body cannot sleep
 
ship.body:setIsAllowedToSleep(false)
 
ship.body:setIsAllowedToSleep(false)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
{{R3d.Body}}
 
{{R3d.Body}}

Latest revision as of 10:58, 18 December 2025

Available since: Gideros 2019.10
Class: R3d.Body

Description

Allows or disallows a body to sleep.

r3d.Body:setIsAllowedToSleep(allowed)

The sleeping technique is used to disable the simulation of resting bodies. By default, the bodies are allowed to sleep when they come to rest.

Parameters

allowed: (boolean) either true or false, default true

Example

// This rigid body cannot sleep
ship.body:setIsAllowedToSleep(false)