getTag.lua 666 B

123456789101112131415161718192021222324252627
  1. return {
  2. summary = 'Get the Collider\'s tag.',
  3. description = 'Returns the Collider\'s tag.',
  4. arguments = {},
  5. returns = {
  6. tag = {
  7. type = 'string',
  8. description = 'The Collider\'s collision tag, or `nil` if the Collider doesn\'t have a tag.'
  9. }
  10. },
  11. variants = {
  12. {
  13. arguments = {},
  14. returns = { 'tag' }
  15. }
  16. },
  17. notes = [[
  18. Collision between tags can be enabled and disabled using `World:enableCollisionBetween` and
  19. `World:disableCollisionBetween`.
  20. ]],
  21. related = {
  22. 'World:disableCollisionBetween',
  23. 'World:enableCollisionBetween',
  24. 'World:isCollisionEnabledBetween',
  25. 'lovr.physics.newWorld'
  26. }
  27. }