setAngularDamping.lua 923 B

12345678910111213141516171819202122232425262728293031323334
  1. return {
  2. summary = 'Set the angular damping of the Collider.',
  3. description = [[
  4. Sets the angular damping of the Collider. Angular damping makes things less "spinny", causing
  5. them to slow down their angular velocity over time. Damping is only applied when angular
  6. velocity is over the threshold value.
  7. ]],
  8. arguments = {
  9. damping = {
  10. type = 'number',
  11. description = 'The angular damping.'
  12. },
  13. threshold = {
  14. type = 'number',
  15. default = '0',
  16. description = 'Velocity limit below which the damping is not applied.'
  17. }
  18. },
  19. returns = {},
  20. variants = {
  21. {
  22. arguments = { 'damping', 'threshold' },
  23. returns = {}
  24. }
  25. },
  26. notes = [[
  27. When the Collider is created, it will use the world's angular damping value, which is set using
  28. `World:setAngularDamping`.
  29. ]],
  30. related = {
  31. 'World:getAngularDamping',
  32. 'World:setAngularDamping'
  33. }
  34. }