unmount.lua 714 B

123456789101112131415161718192021222324252627282930
  1. return {
  2. tag = 'filesystem-virtual',
  3. summary = 'Unmount a mounted archive.',
  4. description = 'Unmounts a directory or archive previously mounted with `lovr.filesystem.mount`.',
  5. arguments = {
  6. path = {
  7. type = 'string',
  8. description = 'The path to unmount.'
  9. }
  10. },
  11. returns = {
  12. success = {
  13. type = 'boolean',
  14. description = 'Whether the archive was unmounted.'
  15. }
  16. },
  17. variants = {
  18. {
  19. arguments = { 'path' },
  20. returns = { 'success' }
  21. }
  22. },
  23. notes = [[
  24. This function is not thread safe. Mounting or unmounting an archive while other threads call
  25. lovr.filesystem functions is not supported.
  26. ]],
  27. related = {
  28. 'lovr.filesystem.mount'
  29. }
  30. }