lovr.headset.animate example;

api/init.lua

@@ -22627,6 +22627,11 @@ return {
           description = "Animates a model to match its input state.  The buttons and joysticks on a controller will move as they're pressed/moved and hand models will move to match hand tracking joints.\n\nThe model must have been created using `lovr.headset.newModel` with the `animated` flag set to `true`.",
           key = "lovr.headset.animate",
           module = "lovr.headset",
+          examples = {
+            {
+              code = "function lovr.load()\n  models = {\n    left = lovr.headset.newModel('hand/left'),\n    right = lovr.headset.newModel('hand/right')\n  }\nend\n\nfunction lovr.draw(pass)\n  for hand, model in pairs(models) do\n    if lovr.headset.isTracked(hand) then\n      lovr.headset.animate(model)\n      pass:draw(model, mat4(lovr.headset.getPose(hand)))\n    end\n  end\n\n  if not next(models) then\n    pass:text('No models loaded', 0, 1.7, -1, .1)\n  end\nend"
+            }
+          },
           notes = "It's possible to animate a custom hand model by retargeting joint poses, see the `Interaction/Custom_Hand_Rig` example.",
           related = {
             "lovr.headset.newModel",

api/lovr/headset/animate.lua

@@ -42,6 +42,27 @@ return {
     It's possible to animate a custom hand model by retargeting joint poses, see the
     `Interaction/Custom_Hand_Rig` example.
   ]],
+  example = [[
+    function lovr.load()
+      models = {
+        left = lovr.headset.newModel('hand/left'),
+        right = lovr.headset.newModel('hand/right')
+      }
+    end
+
+    function lovr.draw(pass)
+      for hand, model in pairs(models) do
+        if lovr.headset.isTracked(hand) then
+          lovr.headset.animate(model)
+          pass:draw(model, mat4(lovr.headset.getPose(hand)))
+        end
+      end
+
+      if not next(models) then
+        pass:text('No models loaded', 0, 1.7, -1, .1)
+      end
+    end
+  ]],
   related = {
     'lovr.headset.newModel',
     'Model:animate'