getAngularDamping.lua 881 B

123456789101112131415161718192021222324252627282930313233
  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. damping = {
  11. type = 'number',
  12. description = 'The angular damping.'
  13. },
  14. threshold = {
  15. type = 'number',
  16. description = 'Velocity limit below which the damping is not applied.'
  17. }
  18. },
  19. variants = {
  20. {
  21. arguments = {},
  22. returns = { 'damping', 'threshold' }
  23. }
  24. },
  25. notes = [[
  26. This sets the default damping for newly-created colliders. Damping can also be set on a
  27. per-collider basis using `Collider:setAngularDamping`.
  28. ]],
  29. related = {
  30. 'Collider:getAngularDamping',
  31. 'Collider:setAngularDamping'
  32. }
  33. }