Browse Source

Callbacks; Physics accessors;

bjorn 4 years ago
parent
commit
a65e3a3774

+ 400 - 2
api/init.lua

@@ -18785,6 +18785,56 @@ return {
                 }
               }
             },
+            {
+              name = "getResponseTime",
+              summary = "Get the response time of the joint.",
+              description = "Returns the response time of the joint.  See `World:setResponseTime` for more info.",
+              key = "BallJoint:getResponseTime",
+              module = "lovr.physics",
+              related = {
+                "DistanceJoint:getResponseTime",
+                "DistanceJoint:setResponseTime",
+                "World:getResponseTime",
+                "World:setResponseTime"
+              },
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "responseTime",
+                      type = "number",
+                      description = "The response time setting for the joint."
+                    }
+                  }
+                }
+              }
+            },
+            {
+              name = "getTightness",
+              summary = "Get the joint tightness.",
+              description = "Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.",
+              key = "BallJoint:getTightness",
+              module = "lovr.physics",
+              related = {
+                "DistanceJoint:getTightness",
+                "DistanceJoint:setTightness",
+                "World:getTightness",
+                "World:setTightness"
+              },
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The tightness of the joint."
+                    }
+                  }
+                }
+              }
+            },
             {
               name = "setAnchor",
               summary = "Set the anchor point of the BallJoint.",
@@ -18813,6 +18863,56 @@ return {
                   returns = {}
                 }
               }
+            },
+            {
+              name = "setResponseTime",
+              summary = "Set the response time of the joint.",
+              description = "Sets the response time of the joint.  See `World:setResponseTime` for more info.",
+              key = "BallJoint:setResponseTime",
+              module = "lovr.physics",
+              related = {
+                "DistanceJoint:getResponseTime",
+                "DistanceJoint:setResponseTime",
+                "World:getResponseTime",
+                "World:setResponseTime"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "responseTime",
+                      type = "number",
+                      description = "The new response time setting for the joint."
+                    }
+                  },
+                  returns = {}
+                }
+              }
+            },
+            {
+              name = "setTightness",
+              summary = "Set the joint tightness.",
+              description = "Sets the tightness of the joint.  See `World:setTightness` for how this affects the joint.",
+              key = "BallJoint:setTightness",
+              module = "lovr.physics",
+              related = {
+                "DistanceJoint:getTightness",
+                "DistanceJoint:setTightness",
+                "World:getTightness",
+                "World:setTightness"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The tightness of the joint."
+                    }
+                  },
+                  returns = {}
+                }
+              }
             }
           }
         },
@@ -20680,6 +20780,56 @@ return {
                 }
               }
             },
+            {
+              name = "getResponseTime",
+              summary = "Get the response time of the joint.",
+              description = "Returns the response time of the joint.  See `World:setResponseTime` for more info.",
+              key = "DistanceJoint:getResponseTime",
+              module = "lovr.physics",
+              related = {
+                "BallJoint:getResponseTime",
+                "BallJoint:setResponseTime",
+                "World:getResponseTime",
+                "World:setResponseTime"
+              },
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "responseTime",
+                      type = "number",
+                      description = "The response time setting for the joint."
+                    }
+                  }
+                }
+              }
+            },
+            {
+              name = "getTightness",
+              summary = "Get the joint tightness.",
+              description = "Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.",
+              key = "DistanceJoint:getTightness",
+              module = "lovr.physics",
+              related = {
+                "BallJoint:getTightness",
+                "BallJoint:setTightness",
+                "World:getTightness",
+                "World:setTightness"
+              },
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The tightness of the joint."
+                    }
+                  }
+                }
+              }
+            },
             {
               name = "setAnchors",
               summary = "Set the anchor points of the DistanceJoint.",
@@ -20742,6 +20892,56 @@ return {
                   returns = {}
                 }
               }
+            },
+            {
+              name = "setResponseTime",
+              summary = "Set the response time of the joint.",
+              description = "Sets the response time of the joint.  See `World:setResponseTime` for more info.",
+              key = "DistanceJoint:setResponseTime",
+              module = "lovr.physics",
+              related = {
+                "BallJoint:getResponseTime",
+                "BallJoint:setResponseTime",
+                "World:getResponseTime",
+                "World:setResponseTime"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "responseTime",
+                      type = "number",
+                      description = "The new response time setting for the joint."
+                    }
+                  },
+                  returns = {}
+                }
+              }
+            },
+            {
+              name = "setTightness",
+              summary = "Set the joint tightness.",
+              description = "Sets the tightness of the joint.  See `World:setTightness` for how this affects the joint.",
+              key = "DistanceJoint:setTightness",
+              module = "lovr.physics",
+              related = {
+                "BallJoint:getTightness",
+                "BallJoint:setTightness",
+                "World:getTightness",
+                "World:setTightness"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The tightness of the joint."
+                    }
+                  },
+                  returns = {}
+                }
+              }
             }
           }
         },
@@ -22180,6 +22380,42 @@ return {
                 }
               }
             },
+            {
+              name = "getColliders",
+              tag = "colliders",
+              summary = "Get a table of all Colliders in the World.",
+              description = "Returns a table of all Colliders in the World.",
+              key = "World:getColliders",
+              module = "lovr.physics",
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "colliders",
+                      type = "table",
+                      description = "A table of `Collider` objects."
+                    }
+                  }
+                },
+                {
+                  arguments = {
+                    {
+                      name = "t",
+                      type = "table",
+                      description = "A table to fill with Colliders and return."
+                    }
+                  },
+                  returns = {
+                    {
+                      name = "colliders",
+                      type = "table",
+                      description = "A table of `Collider` objects."
+                    }
+                  }
+                }
+              }
+            },
             {
               name = "getGravity",
               tag = "worldProperties",
@@ -22263,6 +22499,31 @@ return {
                 }
               }
             },
+            {
+              name = "getTightness",
+              summary = "Get the joint tightness.",
+              description = "Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.",
+              key = "World:getTightness",
+              module = "lovr.physics",
+              related = {
+                "DistanceJoint:getTightness",
+                "DistanceJoint:setTightness",
+                "World:getTightness",
+                "World:setTightness"
+              },
+              variants = {
+                {
+                  arguments = {},
+                  returns = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The tightness of the joint."
+                    }
+                  }
+                }
+              }
+            },
             {
               name = "isCollisionEnabledBetween",
               tag = "worldCollision",
@@ -22340,6 +22601,7 @@ return {
                 "World:newCollider",
                 "World:newCapsuleCollider",
                 "World:newCylinderCollider",
+                "World:newMeshCollider",
                 "World:newSphereCollider"
               },
               variants = {
@@ -22405,6 +22667,7 @@ return {
                 "World:newCollider",
                 "World:newBoxCollider",
                 "World:newCylinderCollider",
+                "World:newMeshCollider",
                 "World:newSphereCollider"
               },
               variants = {
@@ -22462,6 +22725,7 @@ return {
                 "World:newBoxCollider",
                 "World:newCapsuleCollider",
                 "World:newCylinderCollider",
+                "World:newMeshCollider",
                 "World:newSphereCollider",
                 "Collider",
                 "Shape"
@@ -22518,6 +22782,7 @@ return {
                 "World:newCollider",
                 "World:newBoxCollider",
                 "World:newCapsuleCollider",
+                "World:newMeshCollider",
                 "World:newSphereCollider"
               },
               variants = {
@@ -22564,6 +22829,45 @@ return {
                 }
               }
             },
+            {
+              name = "newMeshCollider",
+              tag = "colliders",
+              summary = "Add a Collider with a MeshShape to the World.",
+              description = "Adds a new Collider to the World with a MeshShape already attached.",
+              key = "World:newMeshCollider",
+              module = "lovr.physics",
+              related = {
+                "Collider",
+                "World:newCollider",
+                "World:newBoxCollider",
+                "World:newCapsuleCollider",
+                "World:newCylinderCollider",
+                "World:newSphereCollider"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "vertices",
+                      type = "table",
+                      description = "The table of vertices in the mesh.  Each vertex is a table with 3 numbers."
+                    },
+                    {
+                      name = "indices",
+                      type = "table",
+                      description = "A table of triangle indices representing how the vertices are connected in the Mesh."
+                    }
+                  },
+                  returns = {
+                    {
+                      name = "collider",
+                      type = "Collider",
+                      description = "The new Collider."
+                    }
+                  }
+                }
+              }
+            },
             {
               name = "newSphereCollider",
               tag = "colliders",
@@ -22577,7 +22881,8 @@ return {
                 "World:newCollider",
                 "World:newBoxCollider",
                 "World:newCapsuleCollider",
-                "World:newCylinderCollider"
+                "World:newCylinderCollider",
+                "World:newMeshCollider"
               },
               variants = {
                 {
@@ -22871,6 +23176,34 @@ return {
                 }
               }
             },
+            {
+              name = "setTightness",
+              tag = "worldProperties",
+              summary = "Set the tightness of joints in the World.",
+              description = "Sets the tightness of joints in the World.\n\nThe tightness controls how much force is applied to colliders connected by joints.  With a value of 0, no force will be applied and joints won't have any effect.  With a tightness of 1, a strong force will be used to try to keep the Colliders constrained.  A tightness larger than 1 will overcorrect the joints, which can sometimes be desirable.  Negative tightness values are not supported.",
+              key = "World:setTightness",
+              module = "lovr.physics",
+              related = {
+                "BallJoint:getTightness",
+                "BallJoint:setTightness",
+                "DistanceJoint:getTightness",
+                "DistanceJoint:setTightness",
+                "World:getResponseTime",
+                "World:setResponseTime"
+              },
+              variants = {
+                {
+                  arguments = {
+                    {
+                      name = "tightness",
+                      type = "number",
+                      description = "The new tightness for the World."
+                    }
+                  },
+                  returns = {}
+                }
+              }
+            },
             {
               name = "update",
               tag = "worldBasics",
@@ -24300,6 +24633,39 @@ return {
         }
       }
     },
+    {
+      name = "log",
+      tag = "callbacks",
+      summary = "Called when a message is logged.",
+      description = "This callback is called when a message is logged.  The default implementation of this callback prints the message to the console using `print`, but it's possible to override this callback to render messages in VR, write them to a file, filter messages, and more.\n\nThe message can have a \"tag\" that is a short string representing the sender, and a \"level\" indicating how severe the message is.\n\nThe `t.graphics.debug` flag in `lovr.conf` can be used to get log messages from the GPU driver (tagged as `GL`).  It is also possible to emit your own log messages using `lovr.event.push`.",
+      key = "lovr.log",
+      module = "lovr",
+      related = {
+        "lovr.graphics.print"
+      },
+      variants = {
+        {
+          arguments = {
+            {
+              name = "message",
+              type = "string",
+              description = "The log message.  It may end in a newline."
+            },
+            {
+              name = "level",
+              type = "string",
+              description = "The log level (`debug`, `info`, `warn`, or `error`)."
+            },
+            {
+              name = "tag",
+              type = "string",
+              description = "The log tag."
+            }
+          },
+          returns = {}
+        }
+      }
+    },
     {
       name = "mirror",
       tag = "callbacks",
@@ -24357,6 +24723,38 @@ return {
         }
       }
     },
+    {
+      name = "resize",
+      tag = "callbacks",
+      summary = "Called when the window is resized.",
+      description = "This callback is called when the desktop window is resized.",
+      key = "lovr.resize",
+      module = "lovr",
+      related = {
+        "lovr.graphics.getDimensions",
+        "lovr.graphics.getWidth",
+        "lovr.graphics.getHeight",
+        "lovr.headset.getDisplayDimensions",
+        "lovr.conf"
+      },
+      variants = {
+        {
+          arguments = {
+            {
+              name = "width",
+              type = "number",
+              description = "The new width of the window."
+            },
+            {
+              name = "height",
+              type = "number",
+              description = "The new height of the window."
+            }
+          },
+          returns = {}
+        }
+      }
+    },
     {
       name = "restart",
       tag = "callbacks",
@@ -24382,7 +24780,7 @@ return {
             {
               name = "abort",
               type = "*",
-              description = "Whether quitting should be aborted."
+              description = "The value to send to the next `lovr.load`."
             }
           }
         }

+ 36 - 0
api/lovr/callbacks/log.lua

@@ -0,0 +1,36 @@
+return {
+  tag = 'callbacks',
+  summary = 'Called when a message is logged.',
+  description = [[
+    This callback is called when a message is logged.  The default implementation of this callback
+    prints the message to the console using `print`, but it's possible to override this callback to
+    render messages in VR, write them to a file, filter messages, and more.
+
+    The message can have a "tag" that is a short string representing the sender, and a "level"
+    indicating how severe the message is.
+
+    The `t.graphics.debug` flag in `lovr.conf` can be used to get log messages from the GPU driver
+    (tagged as `GL`).  It is also possible to emit your own log messages using `lovr.event.push`.
+  ]],
+  arguments = {
+    {
+      name = 'message',
+      type = 'string',
+      description = 'The log message.  It may end in a newline.'
+    },
+    {
+      name = 'level',
+      type = 'string',
+      description = 'The log level (`debug`, `info`, `warn`, or `error`).'
+    },
+    {
+      name = 'tag',
+      type = 'string',
+      description = 'The log tag.'
+    }
+  },
+  returns = {},
+  related = {
+    'lovr.graphics.print'
+  }
+}

+ 25 - 0
api/lovr/callbacks/resize.lua

@@ -0,0 +1,25 @@
+return {
+  tag = 'callbacks',
+  summary = 'Called when the window is resized.',
+  description = 'This callback is called when the desktop window is resized.',
+  arguments = {
+    {
+      name = 'width',
+      type = 'number',
+      description = 'The new width of the window.'
+    },
+    {
+      name = 'height',
+      type = 'number',
+      description = 'The new height of the window.'
+    }
+  },
+  returns = {},
+  related = {
+    'lovr.graphics.getDimensions',
+    'lovr.graphics.getWidth',
+    'lovr.graphics.getHeight',
+    'lovr.headset.getDisplayDimensions',
+    'lovr.conf'
+  }
+}

+ 1 - 1
api/lovr/callbacks/restart.lua

@@ -12,7 +12,7 @@ return {
     {
       type = '*',
       name = 'abort',
-      description = 'Whether quitting should be aborted.'
+      description = 'The value to send to the next `lovr.load`.'
     }
   },
   notes = [[

+ 20 - 0
api/lovr/physics/BallJoint/getResponseTime.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Get the response time of the joint.',
+  description = [[
+    Returns the response time of the joint.  See `World:setResponseTime` for more info.
+  ]],
+  arguments = {},
+  returns = {
+    {
+      name = 'responseTime',
+      type = 'number',
+      description = 'The response time setting for the joint.'
+    }
+  },
+  related = {
+    'DistanceJoint:getResponseTime',
+    'DistanceJoint:setResponseTime',
+    'World:getResponseTime',
+    'World:setResponseTime'
+  }
+}

+ 20 - 0
api/lovr/physics/BallJoint/getTightness.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Get the joint tightness.',
+  description = [[
+    Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.
+  ]],
+  arguments = {},
+  returns = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The tightness of the joint.'
+    }
+  },
+  related = {
+    'DistanceJoint:getTightness',
+    'DistanceJoint:setTightness',
+    'World:getTightness',
+    'World:setTightness'
+  }
+}

+ 18 - 0
api/lovr/physics/BallJoint/setResponseTime.lua

@@ -0,0 +1,18 @@
+return {
+  summary = 'Set the response time of the joint.',
+  description = 'Sets the response time of the joint.  See `World:setResponseTime` for more info.',
+  arguments = {
+    {
+      name = 'responseTime',
+      type = 'number',
+      description = 'The new response time setting for the joint.'
+    }
+  },
+  returns = {},
+  related = {
+    'DistanceJoint:getResponseTime',
+    'DistanceJoint:setResponseTime',
+    'World:getResponseTime',
+    'World:setResponseTime'
+  }
+}

+ 20 - 0
api/lovr/physics/BallJoint/setTightness.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Set the joint tightness.',
+  description = [[
+    Sets the tightness of the joint.  See `World:setTightness` for how this affects the joint.
+  ]],
+  arguments = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The tightness of the joint.'
+    }
+  },
+  returns = {},
+  related = {
+    'DistanceJoint:getTightness',
+    'DistanceJoint:setTightness',
+    'World:getTightness',
+    'World:setTightness'
+  }
+}

+ 20 - 0
api/lovr/physics/DistanceJoint/getResponseTime.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Get the response time of the joint.',
+  description = [[
+    Returns the response time of the joint.  See `World:setResponseTime` for more info.
+  ]],
+  arguments = {},
+  returns = {
+    {
+      name = 'responseTime',
+      type = 'number',
+      description = 'The response time setting for the joint.'
+    }
+  },
+  related = {
+    'BallJoint:getResponseTime',
+    'BallJoint:setResponseTime',
+    'World:getResponseTime',
+    'World:setResponseTime'
+  }
+}

+ 20 - 0
api/lovr/physics/DistanceJoint/getTightness.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Get the joint tightness.',
+  description = [[
+    Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.
+  ]],
+  arguments = {},
+  returns = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The tightness of the joint.'
+    }
+  },
+  related = {
+    'BallJoint:getTightness',
+    'BallJoint:setTightness',
+    'World:getTightness',
+    'World:setTightness'
+  }
+}

+ 18 - 0
api/lovr/physics/DistanceJoint/setResponseTime.lua

@@ -0,0 +1,18 @@
+return {
+  summary = 'Set the response time of the joint.',
+  description = 'Sets the response time of the joint.  See `World:setResponseTime` for more info.',
+  arguments = {
+    {
+      name = 'responseTime',
+      type = 'number',
+      description = 'The new response time setting for the joint.'
+    }
+  },
+  returns = {},
+  related = {
+    'BallJoint:getResponseTime',
+    'BallJoint:setResponseTime',
+    'World:getResponseTime',
+    'World:setResponseTime'
+  }
+}

+ 20 - 0
api/lovr/physics/DistanceJoint/setTightness.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Set the joint tightness.',
+  description = [[
+    Sets the tightness of the joint.  See `World:setTightness` for how this affects the joint.
+  ]],
+  arguments = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The tightness of the joint.'
+    }
+  },
+  returns = {},
+  related = {
+    'BallJoint:getTightness',
+    'BallJoint:setTightness',
+    'World:getTightness',
+    'World:setTightness'
+  }
+}

+ 27 - 0
api/lovr/physics/World/getColliders.lua

@@ -0,0 +1,27 @@
+return {
+  tag = 'colliders',
+  summary = 'Get a table of all Colliders in the World.',
+  description = 'Returns a table of all Colliders in the World.',
+  arguments = {
+    t = {
+      type = 'table',
+      description = 'A table to fill with Colliders and return.'
+    }
+  },
+  returns = {
+    colliders = {
+      type = 'table',
+      description = 'A table of `Collider` objects.'
+    }
+  },
+  variants = {
+    {
+      arguments = {},
+      returns = { 'colliders' }
+    },
+    {
+      arguments = { 't' },
+      returns = { 'colliders' }
+    }
+  }
+}

+ 20 - 0
api/lovr/physics/World/getTightness.lua

@@ -0,0 +1,20 @@
+return {
+  summary = 'Get the joint tightness.',
+  description = [[
+    Returns the tightness of the joint.  See `World:setTightness` for how this affects the joint.
+  ]],
+  arguments = {},
+  returns = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The tightness of the joint.'
+    }
+  },
+  related = {
+    'DistanceJoint:getTightness',
+    'DistanceJoint:setTightness',
+    'World:getTightness',
+    'World:setTightness'
+  }
+}

+ 1 - 0
api/lovr/physics/World/newBoxCollider.lua

@@ -53,6 +53,7 @@ return {
     'World:newCollider',
     'World:newCapsuleCollider',
     'World:newCylinderCollider',
+    'World:newMeshCollider',
     'World:newSphereCollider'
   }
 }

+ 1 - 0
api/lovr/physics/World/newCapsuleCollider.lua

@@ -47,6 +47,7 @@ return {
     'World:newCollider',
     'World:newBoxCollider',
     'World:newCylinderCollider',
+    'World:newMeshCollider',
     'World:newSphereCollider'
   }
 }

+ 1 - 0
api/lovr/physics/World/newCollider.lua

@@ -60,6 +60,7 @@ return {
     'World:newBoxCollider',
     'World:newCapsuleCollider',
     'World:newCylinderCollider',
+    'World:newMeshCollider',
     'World:newSphereCollider',
     'Collider',
     'Shape'

+ 1 - 0
api/lovr/physics/World/newCylinderCollider.lua

@@ -47,6 +47,7 @@ return {
     'World:newCollider',
     'World:newBoxCollider',
     'World:newCapsuleCollider',
+    'World:newMeshCollider',
     'World:newSphereCollider'
   }
 }

+ 34 - 0
api/lovr/physics/World/newMeshCollider.lua

@@ -0,0 +1,34 @@
+return {
+  tag = 'colliders',
+  summary = 'Add a Collider with a MeshShape to the World.',
+  description = 'Adds a new Collider to the World with a MeshShape already attached.',
+  arguments = {
+    {
+      name = 'vertices',
+      type = 'table',
+      description = 'The table of vertices in the mesh.  Each vertex is a table with 3 numbers.'
+    },
+    {
+      name = 'indices',
+      type = 'table',
+      description = [[
+        A table of triangle indices representing how the vertices are connected in the Mesh.
+      ]]
+    }
+  },
+  returns = {
+    {
+      name = 'collider',
+      type = 'Collider',
+      description = 'The new Collider.'
+    }
+  },
+  related = {
+    'Collider',
+    'World:newCollider',
+    'World:newBoxCollider',
+    'World:newCapsuleCollider',
+    'World:newCylinderCollider',
+    'World:newSphereCollider'
+  }
+}

+ 2 - 1
api/lovr/physics/World/newSphereCollider.lua

@@ -41,6 +41,7 @@ return {
     'World:newCollider',
     'World:newBoxCollider',
     'World:newCapsuleCollider',
-    'World:newCylinderCollider'
+    'World:newCylinderCollider',
+    'World:newMeshCollider'
   }
 }

+ 29 - 0
api/lovr/physics/World/setTightness.lua

@@ -0,0 +1,29 @@
+return {
+  tag = 'worldProperties',
+  summary = 'Set the tightness of joints in the World.',
+  description = [[
+    Sets the tightness of joints in the World.
+
+    The tightness controls how much force is applied to colliders connected by joints.  With a value
+    of 0, no force will be applied and joints won't have any effect.  With a tightness of 1, a
+    strong force will be used to try to keep the Colliders constrained.  A tightness larger than 1
+    will overcorrect the joints, which can sometimes be desirable.  Negative tightness values are
+    not supported.
+  ]],
+  arguments = {
+    {
+      name = 'tightness',
+      type = 'number',
+      description = 'The new tightness for the World.'
+    }
+  },
+  returns = {},
+  related = {
+    'BallJoint:getTightness',
+    'BallJoint:setTightness',
+    'DistanceJoint:getTightness',
+    'DistanceJoint:setTightness',
+    'World:getResponseTime',
+    'World:setResponseTime'
+  }
+}