Difference between revisions of "Body:getLinearDamping"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 +
Gets the linear damping of the Body.
 +
 +
The linear damping is the ''rate of decrease of the linear velocity over time''. A moving body with no damping and no external forces will continue moving indefinitely, as is the case in space. A moving body with damping will gradually stop moving.
 +
 +
 +
Damping is not the same as friction - they can be modelled together. However, only damping is provided by Box2D (and LOVE).
  
 
== Function ==
 
== Function ==
Line 13: Line 19:
 
* [[parent::Body]]
 
* [[parent::Body]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Gets the linear damping of the Body.
 +
}}

Revision as of 16:17, 14 February 2010

Gets the linear damping of the Body.

The linear damping is the rate of decrease of the linear velocity over time. A moving body with no damping and no external forces will continue moving indefinitely, as is the case in space. A moving body with damping will gradually stop moving.


Damping is not the same as friction - they can be modelled together. However, only damping is provided by Box2D (and LOVE).

Function

Synopsis

damping = Body:getLinearDamping( )

Arguments

None.

Returns

number damping
The value of the linear damping.

See Also