getSaveDirectory.lua 742 B

123456789101112131415161718192021222324252627282930
  1. return {
  2. tag = 'filesystem-paths',
  3. summary = 'Get the location of the save directory.',
  4. description = 'Returns the absolute path to the save directory.',
  5. arguments = {},
  6. returns = {
  7. path = {
  8. type = 'string',
  9. description = 'The absolute path to the save directory.'
  10. }
  11. },
  12. variants = {
  13. {
  14. arguments = {},
  15. returns = { 'path' }
  16. }
  17. },
  18. notes = [[
  19. The save directory takes the following form:
  20. <appdata>/LOVR/<identity>
  21. Where `<appdata>` is `lovr.filesystem.getAppdataDirectory` and `<identity>` is
  22. `lovr.filesystem.getIdentity` and can be customized using `lovr.conf`.
  23. ]],
  24. related = {
  25. 'lovr.filesystem.getIdentity',
  26. 'lovr.filesystem.getAppdataDirectory'
  27. }
  28. }