getAngularDamping.lua 833 B

1234567891011121314151617181920212223242526272829303132
  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. damping = {
  10. type = 'number',
  11. description = 'The angular damping.'
  12. },
  13. threshold = {
  14. type = 'number',
  15. description = 'Velocity limit below which the damping is not applied.'
  16. }
  17. },
  18. variants = {
  19. {
  20. arguments = {},
  21. returns = { 'damping', 'threshold' }
  22. }
  23. },
  24. notes = [[
  25. When the Collider is created, it will use the world's angular damping value, which is set using
  26. `World:setAngularDamping`.
  27. ]],
  28. related = {
  29. 'World:getAngularDamping',
  30. 'World:setAngularDamping'
  31. }
  32. }