Bläddra i källkod

Fix some notes related to lovr.headset.start;

bjorn 4 månader sedan
förälder
incheckning
1232d839cc
2 ändrade filer med 12 tillägg och 3 borttagningar
  1. 5 1
      api/init.lua
  2. 7 2
      api/lovr/headset/start.lua

+ 5 - 1
api/init.lua

@@ -27240,9 +27240,13 @@ return {
           name = "start",
           tag = "headset-misc",
           summary = "Starts the headset session.",
-          description = "Starts the headset session.  This must be called after the graphics module is initialized, and can only be called once.  Normally it is called automatically by `boot.lua`.",
+          description = "Starts the headset session.  This must be called after the graphics module is initialized. Normally it is called automatically by `boot.lua`, but this can be disabled by setting `t.headset.start` to false in `lovr.conf`.",
           key = "lovr.headset.start",
           module = "lovr.headset",
+          related = {
+            "lovr.headset.stop",
+            "lovr.headset.isActive"
+          },
           variants = {
             {
               arguments = {},

+ 7 - 2
api/lovr/headset/start.lua

@@ -2,8 +2,9 @@ return {
   tag = 'headset-misc',
   summary = 'Starts the headset session.',
   description = [[
-    Starts the headset session.  This must be called after the graphics module is initialized, and
-    can only be called once.  Normally it is called automatically by `boot.lua`.
+    Starts the headset session.  This must be called after the graphics module is initialized.
+    Normally it is called automatically by `boot.lua`, but this can be disabled by setting
+    `t.headset.start` to false in `lovr.conf`.
   ]],
   arguments = {},
   returns = {},
@@ -12,5 +13,9 @@ return {
       arguments = {},
       returns = {}
     }
+  },
+  related = {
+    'lovr.headset.stop',
+    'lovr.headset.isActive'
   }
 }