Browse Source

Clarify lovr.headset.getHands;

bjorn 6 years ago
parent
commit
19e6649961
2 changed files with 2 additions and 0 deletions
  1. 1 0
      api/init.lua
  2. 1 0
      api/lovr/headset/getHands.lua

+ 1 - 0
api/init.lua

@@ -13413,6 +13413,7 @@ return {
           description = "Returns a table with all of the currently tracked hand devices.",
           description = "Returns a table with all of the currently tracked hand devices.",
           key = "lovr.headset.getHands",
           key = "lovr.headset.getHands",
           module = "lovr.headset",
           module = "lovr.headset",
+          notes = "The hand paths *always* be either `hand/left` or `hand/right`.",
           variants = {
           variants = {
             {
             {
               arguments = {},
               arguments = {},

+ 1 - 0
api/lovr/headset/getHands.lua

@@ -12,6 +12,7 @@ return {
       description = 'The currently tracked hand devices.'
       description = 'The currently tracked hand devices.'
     }
     }
   },
   },
+  notes = 'The hand paths *always* be either `hand/left` or `hand/right`.',
   example = [[
   example = [[
     function lovr.update(dt)
     function lovr.update(dt)
       for i, hand in ipairs(lovr.headset.getHands()) do
       for i, hand in ipairs(lovr.headset.getHands()) do