getFriction.lua 524 B

1234567891011121314151617181920
  1. return {
  2. summary = 'Get the friction of the Collider.',
  3. description = [[
  4. Returns the friction of the Collider. By default, the friction of two Colliders is combined
  5. (multiplied) when they collide to generate a friction force. The initial friction is 0.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. {
  10. name = 'friction',
  11. type = 'number',
  12. description = 'The friction of the Collider.'
  13. }
  14. },
  15. related = {
  16. 'Collider:getRestitution',
  17. 'Collider:setRestitution',
  18. 'World:collide'
  19. }
  20. }