Browse Source

Clarify getRealDirectory;

bjorn 5 years ago
parent
commit
846f51ade8
2 changed files with 5 additions and 5 deletions
  1. 2 2
      api/init.lua
  2. 3 3
      api/lovr/filesystem/getRealDirectory.lua

+ 2 - 2
api/init.lua

@@ -4201,7 +4201,7 @@ return {
         {
           name = "getRealDirectory",
           summary = "Get the absolute path to a file.",
-          description = "Get the absolute path of a directory containing a path in the virtual filesystem.  This can be used to determine if a file is in the game's source directory or the save directory.",
+          description = "Get the absolute path of the mounted archive containing a path in the virtual filesystem.  This can be used to determine if a file is in the game's source directory or the save directory.",
           key = "lovr.filesystem.getRealDirectory",
           module = "lovr.filesystem",
           variants = {
@@ -4217,7 +4217,7 @@ return {
                 {
                   name = "realpath",
                   type = "string",
-                  description = "The absolute path of the directory containing `path`."
+                  description = "The absolute path of the mounted archive containing `path`."
                 }
               }
             }

+ 3 - 3
api/lovr/filesystem/getRealDirectory.lua

@@ -1,8 +1,8 @@
 return {
   summary = 'Get the absolute path to a file.',
   description = [[
-    Get the absolute path of a directory containing a path in the virtual filesystem.  This can be
-    used to determine if a file is in the game's source directory or the save directory.
+    Get the absolute path of the mounted archive containing a path in the virtual filesystem.  This
+    can be used to determine if a file is in the game's source directory or the save directory.
   ]],
   arguments = {
     {
@@ -15,7 +15,7 @@ return {
     {
       name = 'realpath',
       type = 'string',
-      description = 'The absolute path of the directory containing `path`.'
+      description = 'The absolute path of the mounted archive containing `path`.'
     }
   }
 }