getLinearDamping.lua 807 B

123456789101112131415161718192021222324252627282930
  1. return {
  2. tag = 'worldProperties',
  3. summary = 'Get the linear damping of the World.',
  4. description = [[
  5. Returns the linear damping parameters of the World. Linear damping is similar to drag or air
  6. resistance, slowing down colliders over time as they move.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. {
  11. name = 'damping',
  12. type = 'number',
  13. description = 'The linear damping.'
  14. },
  15. {
  16. name = 'threshold',
  17. type = 'number',
  18. description = 'Velocity limit below which the damping is not applied.'
  19. }
  20. },
  21. notes = [[
  22. A linear damping of 0 means colliders won't slow down over time. This is the default.
  23. Linear damping can also be set on individual colliders.
  24. ]],
  25. related = {
  26. 'Collider:getLinearDamping',
  27. 'Collider:setLinearDamping'
  28. }
  29. }