Add missing docs for t.headset.start;

api/init.lua

@@ -10,7 +10,7 @@ return {
       examples = {
         {
           description = "A noop conf.lua that sets all configuration settings to their defaults:",
-          code = "function lovr.conf(t)\n\n  -- Set the project version and identity\n  t.version = '0.18.0'\n  t.identity = 'default'\n\n  -- Set save directory precedence\n  t.saveprecedence = true\n\n  -- Enable or disable different modules\n  t.modules.audio = true\n  t.modules.data = true\n  t.modules.event = true\n  t.modules.graphics = true\n  t.modules.headset = true\n  t.modules.math = true\n  t.modules.physics = true\n  t.modules.system = true\n  t.modules.thread = true\n  t.modules.timer = true\n\n  -- Audio\n  t.audio.spatializer = nil\n  t.audio.samplerate = 48000\n  t.audio.start = true\n\n  -- Graphics\n  t.graphics.debug = false\n  t.graphics.vsync = true\n  t.graphics.stencil = false\n  t.graphics.antialias = true\n  t.graphics.shadercache = true\n\n  -- Headset settings\n  t.headset.drivers = { 'openxr', 'simulator' }\n  t.headset.supersample = false\n  t.headset.seated = false\n  t.headset.antialias = true\n  t.headset.stencil = false\n  t.headset.submitdepth = true\n  t.headset.overlay = false\n\n  -- Math settings\n  t.math.globals = true\n\n  -- Thread settings\n  t.thread.workers = -1\n\n  -- Configure the desktop window\n  t.window.width = 1080\n  t.window.height = 600\n  t.window.fullscreen = false\n  t.window.resizable = false\n  t.window.title = 'LÖVR'\n  t.window.icon = nil\nend"
+          code = "function lovr.conf(t)\n\n  -- Set the project version and identity\n  t.version = '0.18.0'\n  t.identity = 'default'\n\n  -- Set save directory precedence\n  t.saveprecedence = true\n\n  -- Enable or disable different modules\n  t.modules.audio = true\n  t.modules.data = true\n  t.modules.event = true\n  t.modules.graphics = true\n  t.modules.headset = true\n  t.modules.math = true\n  t.modules.physics = true\n  t.modules.system = true\n  t.modules.thread = true\n  t.modules.timer = true\n\n  -- Audio\n  t.audio.spatializer = nil\n  t.audio.samplerate = 48000\n  t.audio.start = true\n\n  -- Graphics\n  t.graphics.debug = false\n  t.graphics.vsync = true\n  t.graphics.stencil = false\n  t.graphics.antialias = true\n  t.graphics.shadercache = true\n\n  -- Headset settings\n  t.headset.drivers = { 'openxr', 'simulator' }\n  t.headset.start = true\n  t.headset.supersample = false\n  t.headset.seated = false\n  t.headset.antialias = true\n  t.headset.stencil = false\n  t.headset.submitdepth = true\n  t.headset.overlay = false\n\n  -- Math settings\n  t.math.globals = true\n\n  -- Thread settings\n  t.thread.workers = -1\n\n  -- Configure the desktop window\n  t.window.width = 1080\n  t.window.height = 600\n  t.window.fullscreen = false\n  t.window.resizable = false\n  t.window.title = 'LÖVR'\n  t.window.icon = nil\nend"
         }
       },
       notes = "Disabling unused modules can improve startup time.\n\n`t.window` can be set to nil to avoid creating the window.  The window can later be opened manually using `lovr.system.openWindow`.\n\nEnabling the `t.graphics.debug` flag will add additional error checks and will send messages from the GPU driver to the `lovr.log` callback.  This will decrease performance but can help provide information on performance problems or other bugs.  It will also cause `lovr.graphics.newShader` to embed debugging information in shaders which allows inspecting variables and stepping through shaders line-by-line in tools like RenderDoc.\n\n`t.graphics.debug` can also be enabled using the `--graphics-debug` command line option.",
@@ -166,6 +166,11 @@ return {
                       type = "table",
                       description = "An ordered list of preferred headset drivers."
                     },
+                    {
+                      name = "start",
+                      type = "boolean",
+                      description = "Whether a VR session should begin at startup."
+                    },
                     {
                       name = "supersample",
                       type = "number",
@@ -34317,9 +34322,11 @@ return {
           module = "lovr.physics",
           notes = "A ball joint is like a ball and socket between the two colliders.  It tries to keep the distance between the colliders and the anchor position the same, but does not constrain the angle between them.\n\nIf the anchor is nil, the position of the first Collider is the anchor.  If the first collider is nil, then the position of the second Collider is the anchor.",
           related = {
+            "lovr.physics.newConeJoint",
             "lovr.physics.newDistanceJoint",
             "lovr.physics.newHingeJoint",
-            "lovr.physics.newSliderJoint"
+            "lovr.physics.newSliderJoint",
+            "lovr.physics.newWeldJoint"
           },
           variants = {
             {
@@ -34755,8 +34762,10 @@ return {
           notes = "A distance joint tries to keep the two colliders a fixed distance apart.  The distance is determined by the initial distance between the anchor points.  The joint allows for rotation on the anchor points.\n\nIf no anchors are given, they default to the positions of the Colliders.",
           related = {
             "lovr.physics.newBallJoint",
+            "lovr.physics.newConeJoint",
             "lovr.physics.newHingeJoint",
-            "lovr.physics.newSliderJoint"
+            "lovr.physics.newSliderJoint",
+            "lovr.physics.newWeldJoint"
           },
           variants = {
             {
@@ -34852,8 +34861,10 @@ return {
           notes = "A hinge joint constrains two colliders to allow rotation only around the hinge's axis.\n\nIf the anchor is nil, the position of the first Collider is the anchor.  If the first Collider is nil, the position of the second collider is the anchor.\n\nIf the axis is nil, it defaults to the direction between the anchor and the second Collider.",
           related = {
             "lovr.physics.newBallJoint",
+            "lovr.physics.newConeJoint",
             "lovr.physics.newDistanceJoint",
-            "lovr.physics.newSliderJoint"
+            "lovr.physics.newSliderJoint",
+            "lovr.physics.newWeldJoint"
           },
           variants = {
             {
@@ -35084,8 +35095,10 @@ return {
           notes = "A slider joint constrains two colliders to only allow movement along the slider's axis.",
           related = {
             "lovr.physics.newBallJoint",
+            "lovr.physics.newConeJoint",
             "lovr.physics.newDistanceJoint",
-            "lovr.physics.newHingeJoint"
+            "lovr.physics.newHingeJoint",
+            "lovr.physics.newWeldJoint"
           },
           variants = {
             {

api/lovr/callbacks/conf.lua

@@ -161,6 +161,11 @@ return {
               type = 'table',
               description = 'An ordered list of preferred headset drivers.'
             },
+            {
+              name = 'start',
+              type = 'boolean',
+              description = 'Whether a VR session should begin at startup.'
+            },
             {
               name = 'supersample',
               type = 'number',
@@ -333,6 +338,7 @@ return {
 
           -- Headset settings
           t.headset.drivers = { 'openxr', 'simulator' }
+          t.headset.start = true
           t.headset.supersample = false
           t.headset.seated = false
           t.headset.antialias = true