setFriction.lua 580 B

12345678910111213141516171819202122232425
  1. return {
  2. summary = 'Set the friction of the Collider.',
  3. description = [[
  4. Sets 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. friction = {
  9. type = 'number',
  10. description = 'The new friction.'
  11. }
  12. },
  13. returns = {},
  14. variants = {
  15. {
  16. arguments = { 'friction' },
  17. returns = {}
  18. }
  19. },
  20. related = {
  21. 'Collider:getRestitution',
  22. 'Collider:setRestitution',
  23. 'World:collide'
  24. }
  25. }