Difference between revisions of "R3d.Body:setLinearDamping"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
=== Description ===
 
=== Description ===
Sets the rate at which the body linear velocity comes to a stop. Represents the body linear velocity lost per second.
+
Sets the rate at which the body linear velocity comes to a stop (linear damping is the body linear velocity lost per second).
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
r3d.Body:setLinearDamping(number)
 
r3d.Body:setLinearDamping(number)
</source>
+
</syntaxhighlight>
 +
 
 +
'''warnings''': setting ''number'' a negative value will crash your app!
  
 
=== Parameters ===
 
=== Parameters ===
'''number''': (number) body linear damping, usually between 0 and 1. 0 = no damping, 1 = full damping
+
'''number''': (number) body linear damping, between 0 and 1 (default = 0, no damping)
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
</source>
+
self.body = xworld:createBody(view:getMatrix())
 +
self.body:setLinearDamping(0.5)
 +
</syntaxhighlight>
  
 
{{R3d.Body}}
 
{{R3d.Body}}

Latest revision as of 15:32, 13 July 2023

Available since: Gideros 2020.2
Class: R3d.Body

Description

Sets the rate at which the body linear velocity comes to a stop (linear damping is the body linear velocity lost per second).

r3d.Body:setLinearDamping(number)
warnings: setting number a negative value will crash your app!

Parameters

number: (number) body linear damping, between 0 and 1 (default = 0, no damping)

Example

self.body = xworld:createBody(view:getMatrix())
self.body:setLinearDamping(0.5)