Document lovr.headset.stop/isActive;

Author: bjornbytes

api/init.lua

@@ -26179,6 +26179,30 @@ return {
             }
           }
         },
+        {
+          name = "isActive",
+          tag = "headset-misc",
+          summary = "Check if the headset session is active.",
+          description = "Returns whether a headset session is active.  When true, there is an active connection to the VR hardware.  When false, most headset methods will not work properly until `lovr.headset.start` is used to start a session.",
+          key = "lovr.headset.isActive",
+          module = "lovr.headset",
+          related = {
+            "lovr.headset.start",
+            "lovr.headset.stop"
+          },
+          variants = {
+            {
+              arguments = {},
+              returns = {
+                {
+                  name = "active",
+                  type = "boolean",
+                  description = "Whether the headset session is active."
+                }
+              }
+            }
+          }
+        },
         {
           name = "isDown",
           tag = "input",
@@ -26749,6 +26773,25 @@ return {
             }
           }
         },
+        {
+          name = "stop",
+          tag = "headset-misc",
+          summary = "Stop the headset session.",
+          description = "Stops the headset session.  This tears down the connection to the VR runtime and hardware. `lovr.draw` will instead start rendering to the desktop window, as though the headset module was disabled.  However, certain information about the headset can still be queried, such as its name, supported passthrough modes, display size, etc.  A headset session can be started later using `lovr.headset.start`.",
+          key = "lovr.headset.stop",
+          module = "lovr.headset",
+          notes = "The headset module behaves in the following manner when there is no headset session:\n\n- `lovr.headset.isActive` returns `false`.\n- `lovr.headset.getPass` returns `nil`.\n- All devices will be untracked.",
+          related = {
+            "lovr.headset.start",
+            "lovr.headset.isActive"
+          },
+          variants = {
+            {
+              arguments = {},
+              returns = {}
+            }
+          }
+        },
         {
           name = "stopVibration",
           tag = "input",

api/lovr/headset/isActive.lua

@@ -0,0 +1,26 @@
+return {
+  tag = 'headset-misc',
+  summary = 'Check if the headset session is active.',
+  description = [[
+    Returns whether a headset session is active.  When true, there is an active connection to the VR
+    hardware.  When false, most headset methods will not work properly until `lovr.headset.start` is
+    used to start a session.
+  ]],
+  arguments = {},
+  returns = {
+    active = {
+      type = 'boolean',
+      description = 'Whether the headset session is active.'
+    }
+  },
+  variants = {
+    {
+      arguments = {},
+      returns = { 'active' }
+    }
+  },
+  related = {
+    'lovr.headset.start',
+    'lovr.headset.stop'
+  }
+}