Browse Source

Mention looping streams;

bjorn 4 years ago
parent
commit
45033ab13f
2 changed files with 3 additions and 1 deletions
  1. 1 0
      api/init.lua
  2. 2 1
      api/lovr/audio/Source/setLooping.lua

+ 1 - 0
api/init.lua

@@ -2040,6 +2040,7 @@ return {
               description = "Sets whether or not the Source loops.",
               description = "Sets whether or not the Source loops.",
               key = "Source:setLooping",
               key = "Source:setLooping",
               module = "lovr.audio",
               module = "lovr.audio",
+              notes = "Attempting to loop a Source backed by a stream `Sound` will cause an error.",
               variants = {
               variants = {
                 {
                 {
                   arguments = {
                   arguments = {

+ 2 - 1
api/lovr/audio/Source/setLooping.lua

@@ -8,5 +8,6 @@ return {
       description = 'Whether or not the Source will loop.'
       description = 'Whether or not the Source will loop.'
     }
     }
   },
   },
-  returns = {}
+  returns = {},
+  notes = 'Attempting to loop a Source backed by a stream `Sound` will cause an error.'
 }
 }