Browse Source

Default enum values are quoted;

bjorn 4 years ago
parent
commit
d0c4d2e4cf

File diff suppressed because it is too large
+ 0 - 9222
api/init.lua


+ 1 - 1
api/lovr/graphics/Model/getNodePose.lua

@@ -12,7 +12,7 @@ return {
     },
     space = {
       type = 'CoordinateSpace',
-      default = 'global',
+      default = [['global']],
       description = [[
         Whether the pose sould be returned relative to the node's parent or relative to the root
         node of the Model.

+ 1 - 1
api/lovr/graphics/Shader/sendBlock.lua

@@ -19,7 +19,7 @@ return {
     {
       name = 'access',
       type = 'UniformAccess',
-      default = 'readwrite',
+      default = [['readwrite']],
       description = 'How the Shader will use this block (used as an optimization hint).'
     }
   },

+ 1 - 1
api/lovr/graphics/Shader/sendImage.lua

@@ -30,7 +30,7 @@ return {
     },
     access = {
       type = 'UniformAccess',
-      default = 'readwrite',
+      default = [['readwrite']],
       description = 'Whether the image will be read from, written to, or both.'
     }
   },

+ 1 - 1
api/lovr/graphics/newCanvas.lua

@@ -42,7 +42,7 @@ return {
         {
           name = 'depth',
           type = 'TextureFormat',
-          default = 'd16',
+          default = [['d16']],
           description = [[
             A depth TextureFormat to use for the Canvas depth buffer, or false for no depth buffer.
             Note that this can also be a table with `format` and `readable` keys.

+ 1 - 1
api/lovr/graphics/newShaderBlock.lua

@@ -28,7 +28,7 @@ return {
         {
           name = 'usage',
           type = 'BufferUsage',
-          default = 'dynamic',
+          default = [['dynamic']],
           description = 'How the data in the block will be updated.'
         },
         {

+ 1 - 1
api/lovr/graphics/newTexture.lua

@@ -61,7 +61,7 @@ return {
         {
           name = 'format',
           type = 'TextureFormat',
-          default = 'rgba',
+          default = [['rgba']],
           description = 'The format used for the Texture (when creating a blank texture).'
         },
         {

+ 1 - 1
api/lovr/headset/animate.lua

@@ -12,7 +12,7 @@ return {
     {
       name = 'device',
       type = 'Device',
-      default = 'head',
+      default = [['head']],
       description = 'The device to use for the animation data.'
     },
     {

+ 35 - 35
api/lovr/headset/getAngularVelocity.lua

@@ -1,35 +1,35 @@
-return {
-  tag = 'input',
-  summary = 'Get the angular velocity of a device.',
-  description = 'Returns the current angular velocity of a device.',
-  arguments = {
-    {
-      name = 'device',
-      type = 'Device',
-      default = 'head',
-      description = 'The device to get the velocity of.'
-    }
-  },
-  returns = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x component of the angular velocity.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y component of the angular velocity.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z component of the angular velocity.'
-    }
-  },
-  related = {
-    'lovr.headset.getVelocity',
-    'lovr.headset.getPosition',
-    'lovr.headset.getOrientation'
-  }
-}
+return {
+  tag = 'input',
+  summary = 'Get the angular velocity of a device.',
+  description = 'Returns the current angular velocity of a device.',
+  arguments = {
+    {
+      name = 'device',
+      type = 'Device',
+      default = [['head']],
+      description = 'The device to get the velocity of.'
+    }
+  },
+  returns = {
+    {
+      name = 'x',
+      type = 'number',
+      description = 'The x component of the angular velocity.'
+    },
+    {
+      name = 'y',
+      type = 'number',
+      description = 'The y component of the angular velocity.'
+    },
+    {
+      name = 'z',
+      type = 'number',
+      description = 'The z component of the angular velocity.'
+    }
+  },
+  related = {
+    'lovr.headset.getVelocity',
+    'lovr.headset.getPosition',
+    'lovr.headset.getOrientation'
+  }
+}

+ 44 - 44
api/lovr/headset/getOrientation.lua

@@ -1,44 +1,44 @@
-return {
-  tag = 'input',
-  summary = 'Get the orientation of a device.',
-  description = 'Returns the current orientation of a device, in angle/axis form.',
-  arguments = {
-    {
-      name = 'device',
-      type = 'Device',
-      default = 'head',
-      description = 'The device to get the orientation of.'
-    }
-  },
-  returns = {
-    {
-      name = 'angle',
-      type = 'number',
-      description = 'The amount of rotation around the axis of rotation, in radians.'
-    },
-    {
-      name = 'ax',
-      type = 'number',
-      description = 'The x component of the axis of rotation.'
-    },
-    {
-      name = 'ay',
-      type = 'number',
-      description = 'The y component of the axis of rotation.'
-    },
-    {
-      name = 'az',
-      type = 'number',
-      description = 'The z component of the axis of rotation.'
-    }
-  },
-  notes = ' If the device isn\'t tracked, all zeroes will be returned.',
-  related = {
-    'lovr.headset.getPose',
-    'lovr.headset.getPosition',
-    'lovr.headset.getVelocity',
-    'lovr.headset.getAngularVelocity',
-    'lovr.headset.isTracked',
-    'lovr.headset.getDriver'
-  }
-}
+return {
+  tag = 'input',
+  summary = 'Get the orientation of a device.',
+  description = 'Returns the current orientation of a device, in angle/axis form.',
+  arguments = {
+    {
+      name = 'device',
+      type = 'Device',
+      default = [['head']],
+      description = 'The device to get the orientation of.'
+    }
+  },
+  returns = {
+    {
+      name = 'angle',
+      type = 'number',
+      description = 'The amount of rotation around the axis of rotation, in radians.'
+    },
+    {
+      name = 'ax',
+      type = 'number',
+      description = 'The x component of the axis of rotation.'
+    },
+    {
+      name = 'ay',
+      type = 'number',
+      description = 'The y component of the axis of rotation.'
+    },
+    {
+      name = 'az',
+      type = 'number',
+      description = 'The z component of the axis of rotation.'
+    }
+  },
+  notes = ' If the device isn\'t tracked, all zeroes will be returned.',
+  related = {
+    'lovr.headset.getPose',
+    'lovr.headset.getPosition',
+    'lovr.headset.getVelocity',
+    'lovr.headset.getAngularVelocity',
+    'lovr.headset.isTracked',
+    'lovr.headset.getDriver'
+  }
+}

+ 1 - 1
api/lovr/headset/getPose.lua

@@ -6,7 +6,7 @@ return {
     {
       name = 'device',
       type = 'Device',
-      default = 'head',
+      default = [['head']],
       description = 'The device to get the pose of.'
     }
   },

+ 39 - 39
api/lovr/headset/getPosition.lua

@@ -1,39 +1,39 @@
-return {
-  tag = 'input',
-  summary = 'Get the position of a device.',
-  description = 'Returns the current position of a device, in meters, relative to the play area.',
-  arguments = {
-    {
-      name = 'device',
-      type = 'Device',
-      default = 'head',
-      description = 'The device to get the position of.'
-    }
-  },
-  returns = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x position of the device.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y position of the device.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z position of the device.'
-    }
-  },
-  notes = ' If the device isn\'t tracked, all zeroes will be returned.',
-  related = {
-    'lovr.headset.getPose',
-    'lovr.headset.getOrientation',
-    'lovr.headset.getVelocity',
-    'lovr.headset.getAngularVelocity',
-    'lovr.headset.isTracked',
-    'lovr.headset.getDriver'
-  }
-}
+return {
+  tag = 'input',
+  summary = 'Get the position of a device.',
+  description = 'Returns the current position of a device, in meters, relative to the play area.',
+  arguments = {
+    {
+      name = 'device',
+      type = 'Device',
+      default = [['head']],
+      description = 'The device to get the position of.'
+    }
+  },
+  returns = {
+    {
+      name = 'x',
+      type = 'number',
+      description = 'The x position of the device.'
+    },
+    {
+      name = 'y',
+      type = 'number',
+      description = 'The y position of the device.'
+    },
+    {
+      name = 'z',
+      type = 'number',
+      description = 'The z position of the device.'
+    }
+  },
+  notes = ' If the device isn\'t tracked, all zeroes will be returned.',
+  related = {
+    'lovr.headset.getPose',
+    'lovr.headset.getOrientation',
+    'lovr.headset.getVelocity',
+    'lovr.headset.getAngularVelocity',
+    'lovr.headset.isTracked',
+    'lovr.headset.getDriver'
+  }
+}

+ 36 - 36
api/lovr/headset/getVelocity.lua

@@ -1,36 +1,36 @@
-return {
-  tag = 'input',
-  summary = 'Get the linear velocity of a device.',
-  description = 'Returns the current linear velocity of a device, in meters per second.',
-  arguments = {
-    {
-      name = 'device',
-      type = 'Device',
-      default = 'head',
-      description = 'The device to get the velocity of.'
-    }
-  },
-  returns = {
-    {
-      name = 'vx',
-      type = 'number',
-      description = 'The x component of the linear velocity.'
-    },
-    {
-      name = 'vy',
-      type = 'number',
-      description = 'The y component of the linear velocity.'
-    },
-    {
-      name = 'vz',
-      type = 'number',
-      description = 'The z component of the linear velocity.'
-    }
-  },
-  related = {
-    'lovr.headset.getAngularVelocity',
-    'lovr.headset.getPose',
-    'lovr.headset.getPosition',
-    'lovr.headset.getOrientation'
-  }
-}
+return {
+  tag = 'input',
+  summary = 'Get the linear velocity of a device.',
+  description = 'Returns the current linear velocity of a device, in meters per second.',
+  arguments = {
+    {
+      name = 'device',
+      type = 'Device',
+      default = [['head']],
+      description = 'The device to get the velocity of.'
+    }
+  },
+  returns = {
+    {
+      name = 'vx',
+      type = 'number',
+      description = 'The x component of the linear velocity.'
+    },
+    {
+      name = 'vy',
+      type = 'number',
+      description = 'The y component of the linear velocity.'
+    },
+    {
+      name = 'vz',
+      type = 'number',
+      description = 'The z component of the linear velocity.'
+    }
+  },
+  related = {
+    'lovr.headset.getAngularVelocity',
+    'lovr.headset.getPose',
+    'lovr.headset.getPosition',
+    'lovr.headset.getOrientation'
+  }
+}

+ 26 - 26
api/lovr/headset/isTracked.lua

@@ -1,26 +1,26 @@
-return {
-  tag = 'input',
-  summary = 'Check if a device is currently tracked.',
-  description = [[
-    Returns whether any active headset driver is currently returning pose information for a device.
-  ]],
-  arguments = {
-    {
-      name = 'device',
-      type = 'Device',
-      default = 'head',
-      description = 'The device to get the pose of.'
-    }
-  },
-  returns = {
-    {
-      name = 'tracked',
-      type = 'boolean',
-      description = 'Whether the device is currently tracked.'
-    }
-  },
-  notes = [[
-    If a device is tracked, it is guaranteed to return a valid pose until the next call to
-    `lovr.headset.update`.
-  ]]
-}
+return {
+  tag = 'input',
+  summary = 'Check if a device is currently tracked.',
+  description = [[
+    Returns whether any active headset driver is currently returning pose information for a device.
+  ]],
+  arguments = {
+    {
+      name = 'device',
+      type = 'Device',
+      default = [['head']],
+      description = 'The device to get the pose of.'
+    }
+  },
+  returns = {
+    {
+      name = 'tracked',
+      type = 'boolean',
+      description = 'Whether the device is currently tracked.'
+    }
+  },
+  notes = [[
+    If a device is tracked, it is guaranteed to return a valid pose until the next call to
+    `lovr.headset.update`.
+  ]]
+}

+ 1 - 1
api/lovr/headset/newModel.lua

@@ -6,7 +6,7 @@ return {
     {
       name = 'device',
       type = 'Device',
-      default = 'head',
+      default = [['head']],
       description = 'The device to load a model for.'
     },
     {

+ 1 - 1
api/lovr/headset/vibrate.lua

@@ -8,7 +8,7 @@ return {
     {
       name = 'device',
       type = 'Device',
-      default = 'head',
+      default = [['head']],
       description = 'The device to vibrate.'
     },
     {

Some files were not shown because too many files changed in this diff