getAngularDamping.lua 673 B

12345678910111213141516171819202122232425
  1. return {
  2. summary = 'Get the angular damping of the Collider.',
  3. description = [[
  4. Returns the angular damping parameters of the Collider. Angular damping makes things less
  5. "spinny", making them slow down their angular velocity over time.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. {
  10. name = 'damping',
  11. type = 'number',
  12. description = 'The angular damping.'
  13. },
  14. {
  15. name = 'threshold',
  16. type = 'number',
  17. description = 'Velocity limit below which the damping is not applied.'
  18. }
  19. },
  20. notes = 'Angular damping can also be set on the World.',
  21. related = {
  22. 'World:getAngularDamping',
  23. 'World:setAngularDamping'
  24. }
  25. }