getAngularDamping.lua 711 B

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