getFriction.lua 595 B

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