Browse Source

Slight clarification to Sound:getCapacity;

bjorn 2 weeks ago
parent
commit
411463ea1e
2 changed files with 3 additions and 3 deletions
  1. 1 1
      api/init.lua
  2. 2 2
      api/lovr/data/Sound/getCapacity.lua

+ 1 - 1
api/init.lua

@@ -7482,7 +7482,7 @@ return {
             {
               name = "getCapacity",
               summary = "Get the number of frames that can be written to the Sound.",
-              description = "Returns the number of frames that can be written to the Sound.  For stream sounds, this is the number of frames that can be written without overwriting existing data.  For normal sounds, this returns the same value as `Sound:getFrameCount`.",
+              description = "Returns the number of frames that can be written to the Sound.  For stream sounds, this is the number of frames that can currently be written without overwriting existing data.  For normal sounds, this returns the same value as `Sound:getFrameCount`.",
               key = "Sound:getCapacity",
               module = "lovr.data",
               related = {

+ 2 - 2
api/lovr/data/Sound/getCapacity.lua

@@ -2,8 +2,8 @@ return {
   summary = 'Get the number of frames that can be written to the Sound.',
   description = [[
     Returns the number of frames that can be written to the Sound.  For stream sounds, this is the
-    number of frames that can be written without overwriting existing data.  For normal sounds, this
-    returns the same value as `Sound:getFrameCount`.
+    number of frames that can currently be written without overwriting existing data.  For normal
+    sounds, this returns the same value as `Sound:getFrameCount`.
   ]],
   arguments = {},
   returns = {