setAngularDamping.lua 797 B

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