setTag.lua 721 B

1234567891011121314151617181920212223242526272829303132
  1. return {
  2. summary = 'Set the Collider\'s tag.',
  3. description = 'Sets the Collider\'s tag.',
  4. arguments = {
  5. tag = {
  6. type = 'string',
  7. description = 'The Collider\'s collision tag.'
  8. }
  9. },
  10. returns = {},
  11. variants = {
  12. {
  13. arguments = { 'tag' },
  14. returns = {}
  15. },
  16. {
  17. description = 'Clear the Collider\'s tag.',
  18. arguments = {},
  19. returns = {}
  20. }
  21. },
  22. notes = [[
  23. Collision between tags can be enabled and disabled using `World:enableCollisionBetween` and
  24. `World:disableCollisionBetween`.
  25. ]],
  26. related = {
  27. 'World:disableCollisionBetween',
  28. 'World:enableCollisionBetween',
  29. 'World:isCollisionEnabledBetween',
  30. 'lovr.physics.newWorld'
  31. }
  32. }