getRestitution.lua 647 B

1234567891011121314151617181920212223242526
  1. return {
  2. summary = 'Get the bounciness of the Collider.',
  3. description = [[
  4. Returns the restitution (bounciness) of the Collider. By default, the restitution of two
  5. Colliders is combined (the max is used) when they collide to cause them to bounce away from each
  6. other. The initial restitution is 0.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. restitution = {
  11. type = 'number',
  12. description = 'The restitution of the Collider.'
  13. }
  14. },
  15. variants = {
  16. {
  17. arguments = {},
  18. returns = { 'restitution' }
  19. }
  20. },
  21. related = {
  22. 'Collider:getFriction',
  23. 'Collider:setFriction',
  24. 'World:collide'
  25. }
  26. }