setRequirePath.lua 748 B

1234567891011121314151617181920
  1. return {
  2. summary = 'Set the require path.',
  3. description = [[
  4. Sets 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 save directory and
  8. the project directory.
  9. ]],
  10. arguments = {
  11. {
  12. name = 'path',
  13. type = 'string',
  14. default = 'nil',
  15. description = 'An optional semicolon separated list of search patterns.'
  16. }
  17. },
  18. returns = {},
  19. notes = 'The default reqiure path is \'?.lua;?/init.lua\'.'
  20. }