getSaveDirectory.lua 659 B

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