Browse Source

Update default require path;

bjorn 7 years ago
parent
commit
c527859e72
3 changed files with 14 additions and 4 deletions
  1. 10 2
      api/init.lua
  2. 2 1
      api/lovr/filesystem/getRequirePath.lua
  3. 2 1
      api/lovr/filesystem/setRequirePath.lua

+ 10 - 2
api/init.lua

@@ -2581,6 +2581,7 @@ return {
           module = "lovr.data",
           module = "lovr.data",
           variants = {
           variants = {
             {
             {
+              description = "Load image data from a file.",
               arguments = {
               arguments = {
                 {
                 {
                   name = "filename",
                   name = "filename",
@@ -2608,6 +2609,12 @@ return {
                   name = "height",
                   name = "height",
                   type = "number",
                   type = "number",
                   description = "The height of the texture data."
                   description = "The height of the texture data."
+                },
+                {
+                  name = "format",
+                  type = "TextureFormat",
+                  description = "The format of the texture's pixels.",
+                  default = "rgba"
                 }
                 }
               },
               },
               returns = {
               returns = {
@@ -2619,6 +2626,7 @@ return {
               }
               }
             },
             },
             {
             {
+              description = "Decode image data from a Blob.",
               arguments = {
               arguments = {
                 {
                 {
                   name = "blob",
                   name = "blob",
@@ -4858,7 +4866,7 @@ return {
           description = "Returns the require path.  The require path is a semicolon-separated list of patterns that LÖVR will use to search for files when they are `require`d.  Any question marks in the pattern will be replaced with the module that is being required.  It is similar to Lua\\'s `package.path` variable, but the main difference is that the patterns are relative to the save directory and the project directory.\n\nFor the C require path, double question marks will be replaced by the name of the module with the operating system's native extension for shared libraries.  For example, if you do `require('lib')` and the C require path is `??`, LÖVR will try to load `lib.dll` if you're on Windows or `lib.so` if you're on Linux.",
           description = "Returns the require path.  The require path is a semicolon-separated list of patterns that LÖVR will use to search for files when they are `require`d.  Any question marks in the pattern will be replaced with the module that is being required.  It is similar to Lua\\'s `package.path` variable, but the main difference is that the patterns are relative to the save directory and the project directory.\n\nFor the C require path, double question marks will be replaced by the name of the module with the operating system's native extension for shared libraries.  For example, if you do `require('lib')` and the C require path is `??`, LÖVR will try to load `lib.dll` if you're on Windows or `lib.so` if you're on Linux.",
           key = "lovr.filesystem.getRequirePath",
           key = "lovr.filesystem.getRequirePath",
           module = "lovr.filesystem",
           module = "lovr.filesystem",
-          notes = "The default reqiure path is '?.lua;?/init.lua'.  The default C require path is '??'.",
+          notes = "The default reqiure path is '?.lua;?/init.lua;lua_modules/?.lua;lua_modules/?/init.lua'.  The default C require path is '??'.",
           variants = {
           variants = {
             {
             {
               arguments = {},
               arguments = {},
@@ -5244,7 +5252,7 @@ return {
           description = "Sets the require path.  The require path is a semicolon-separated list of patterns that LÖVR will use to search for files when they are `require`d.  Any question marks in the pattern will be replaced with the module that is being required.  It is similar to Lua\\'s `package.path` variable, but the main difference is that the patterns are relative to the save directory and the project directory.\n\nFor the C require path, double question marks will be replaced by the name of the module with the operating system's native extension for shared libraries.  For example, if you do `require('lib')` and the C require path is `??`, LÖVR will try to load `lib.dll` if you're on Windows or `lib.so` if you're on Linux.",
           description = "Sets the require path.  The require path is a semicolon-separated list of patterns that LÖVR will use to search for files when they are `require`d.  Any question marks in the pattern will be replaced with the module that is being required.  It is similar to Lua\\'s `package.path` variable, but the main difference is that the patterns are relative to the save directory and the project directory.\n\nFor the C require path, double question marks will be replaced by the name of the module with the operating system's native extension for shared libraries.  For example, if you do `require('lib')` and the C require path is `??`, LÖVR will try to load `lib.dll` if you're on Windows or `lib.so` if you're on Linux.",
           key = "lovr.filesystem.setRequirePath",
           key = "lovr.filesystem.setRequirePath",
           module = "lovr.filesystem",
           module = "lovr.filesystem",
-          notes = "The default reqiure path is '?.lua;?/init.lua'.  The default C require path is '??'.",
+          notes = "The default reqiure path is '?.lua;?/init.lua;lua_modules/?.lua;lua_modules/?/init.lua'.  The default C require path is '??'.",
           variants = {
           variants = {
             {
             {
               arguments = {
               arguments = {

+ 2 - 1
api/lovr/filesystem/getRequirePath.lua

@@ -26,6 +26,7 @@ return {
     }
     }
   },
   },
   notes = [[
   notes = [[
-    The default reqiure path is '?.lua;?/init.lua'.  The default C require path is '??'.
+    The default reqiure path is '?.lua;?/init.lua;lua_modules/?.lua;lua_modules/?/init.lua'.  The
+    default C require path is '??'.
   ]]
   ]]
 }
 }

+ 2 - 1
api/lovr/filesystem/setRequirePath.lua

@@ -28,6 +28,7 @@ return {
   },
   },
   returns = {},
   returns = {},
   notes = [[
   notes = [[
-    The default reqiure path is '?.lua;?/init.lua'.  The default C require path is '??'.
+    The default reqiure path is '?.lua;?/init.lua;lua_modules/?.lua;lua_modules/?/init.lua'.  The
+    default C require path is '??'.
   ]]
   ]]
 }
 }