getRequirePath.lua 695 B

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