getRequirePath.lua 788 B

123456789101112131415161718192021222324
  1. return {
  2. tag = 'filesystem-lua',
  3. summary = 'Get the require path.',
  4. description = [[
  5. Returns the require path. The require path is a semicolon-separated list of patterns that LÖVR
  6. will use to search for files when they are `require`d. Any question marks in the pattern will
  7. be replaced with the module that is being required. It is similar to Lua\'s `package.path`
  8. variable, but the main difference is that the patterns are relative to the virtual filesystem.
  9. ]],
  10. arguments = {},
  11. returns = {
  12. path = {
  13. type = 'string',
  14. description = 'The semicolon separated list of search patterns.'
  15. }
  16. },
  17. variants = {
  18. {
  19. arguments = {},
  20. returns = { 'path' }
  21. }
  22. },
  23. notes = ' The default reqiure path is \'?.lua;?/init.lua\'.'
  24. }