Browse Source

Mention 64 Source limit;

bjorn 4 years ago
parent
commit
ec233c4648
2 changed files with 19 additions and 2 deletions
  1. 8 1
      api/init.lua
  2. 11 1
      api/lovr/audio/Source/play.lua

+ 8 - 1
api/init.lua

@@ -1969,10 +1969,17 @@ return {
               description = "Plays the Source.  This doesn't do anything if the Source is already playing.",
               description = "Plays the Source.  This doesn't do anything if the Source is already playing.",
               key = "Source:play",
               key = "Source:play",
               module = "lovr.audio",
               module = "lovr.audio",
+              notes = "There is a maximum of 64 Sources that can be playing at once.  If 64 Sources are already playing, this function will return `false`.",
               variants = {
               variants = {
                 {
                 {
                   arguments = {},
                   arguments = {},
-                  returns = {}
+                  returns = {
+                    {
+                      name = "success",
+                      type = "boolean",
+                      description = "Whether the Source successfully started playing."
+                    }
+                  }
                 }
                 }
               }
               }
             },
             },

+ 11 - 1
api/lovr/audio/Source/play.lua

@@ -2,5 +2,15 @@ return {
   summary = 'Play the Source.',
   summary = 'Play the Source.',
   description = 'Plays the Source.  This doesn\'t do anything if the Source is already playing.',
   description = 'Plays the Source.  This doesn\'t do anything if the Source is already playing.',
   arguments = {},
   arguments = {},
-  returns = {}
+  returns = {
+    {
+      name = 'success',
+      type = 'boolean',
+      description = 'Whether the Source successfully started playing.'
+    }
+  },
+  notes = [[
+    There is a maximum of 64 Sources that can be playing at once.  If 64 Sources are already
+    playing, this function will return `false`.
+  ]]
 }
 }