Browse Source

Add some more deprecation notices;

bjorn 2 weeks ago
parent
commit
e11f587809

+ 8 - 8
api/init.lua

@@ -14571,7 +14571,7 @@ return {
               description = "Returns whether the Buffer is temporary.",
               description = "Returns whether the Buffer is temporary.",
               key = "Buffer:isTemporary",
               key = "Buffer:isTemporary",
               module = "lovr.graphics",
               module = "lovr.graphics",
-              deprecated = true,
+              deprecated = "Temporary buffers have been removed, this function always returns false.",
               related = {
               related = {
                 "lovr.graphics.getBuffer"
                 "lovr.graphics.getBuffer"
               },
               },
@@ -21893,7 +21893,7 @@ return {
               description = "Sets whether the front or back faces of triangles are culled.",
               description = "Sets whether the front or back faces of triangles are culled.",
               key = "Pass:setCullMode",
               key = "Pass:setCullMode",
               module = "lovr.graphics",
               module = "lovr.graphics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Pass:setFaceCull`.",
               notes = "By default, face culling is disabled.",
               notes = "By default, face culling is disabled.",
               related = {
               related = {
                 "Pass:setViewCull",
                 "Pass:setViewCull",
@@ -25725,7 +25725,7 @@ return {
           description = "Returns a table with all the refresh rates supported by the headset display, in Hz.",
           description = "Returns a table with all the refresh rates supported by the headset display, in Hz.",
           key = "lovr.headset.getDisplayFrequencies",
           key = "lovr.headset.getDisplayFrequencies",
           module = "lovr.headset",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.getRefreshRates`.",
           related = {
           related = {
             "lovr.headset.setDisplayFrequency"
             "lovr.headset.setDisplayFrequency"
           },
           },
@@ -25749,7 +25749,7 @@ return {
           description = "Returns the refresh rate of the headset display, in Hz.",
           description = "Returns the refresh rate of the headset display, in Hz.",
           key = "lovr.headset.getDisplayFrequency",
           key = "lovr.headset.getDisplayFrequency",
           module = "lovr.headset",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.getRefreshRate`.",
           variants = {
           variants = {
             {
             {
               arguments = {},
               arguments = {},
@@ -26143,7 +26143,7 @@ return {
           description = "Returns the type of origin used for the tracking volume.  The different types of origins are explained on the `HeadsetOrigin` page.",
           description = "Returns the type of origin used for the tracking volume.  The different types of origins are explained on the `HeadsetOrigin` page.",
           key = "lovr.headset.getOriginType",
           key = "lovr.headset.getOriginType",
           module = "lovr.headset",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.isSeated`.",
           related = {
           related = {
             "HeadsetOrigin"
             "HeadsetOrigin"
           },
           },
@@ -27066,7 +27066,7 @@ return {
           description = "Sets the display refresh rate, in Hz.",
           description = "Sets the display refresh rate, in Hz.",
           key = "lovr.headset.setDisplayFrequency",
           key = "lovr.headset.setDisplayFrequency",
           module = "lovr.headset",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.setRefreshRate`.",
           notes = "Changing the display refresh-rate also changes the frequency of lovr.update() and lovr.draw() as they depend on the display frequency.",
           notes = "Changing the display refresh-rate also changes the frequency of lovr.update() and lovr.draw() as they depend on the display frequency.",
           variants = {
           variants = {
             {
             {
@@ -37279,7 +37279,7 @@ return {
               description = "Returns whether the Collider is currently ignoring gravity.",
               description = "Returns whether the Collider is currently ignoring gravity.",
               key = "Collider:isGravityIgnored",
               key = "Collider:isGravityIgnored",
               module = "lovr.physics",
               module = "lovr.physics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Collider:getGravityScale`.",
               variants = {
               variants = {
                 {
                 {
                   arguments = {},
                   arguments = {},
@@ -37710,7 +37710,7 @@ return {
               description = "Sets whether the Collider should ignore gravity.",
               description = "Sets whether the Collider should ignore gravity.",
               key = "Collider:setGravityIgnored",
               key = "Collider:setGravityIgnored",
               module = "lovr.physics",
               module = "lovr.physics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Collider:setGravityScale`.",
               variants = {
               variants = {
                 {
                 {
                   arguments = {
                   arguments = {

+ 1 - 1
api/lovr/graphics/Buffer/isTemporary.lua

@@ -1,6 +1,6 @@
 return {
 return {
-  deprecated = true,
   tag = 'buffer-metadata',
   tag = 'buffer-metadata',
+  deprecated = 'Temporary buffers have been removed, this function always returns false.',
   summary = 'Check if the Buffer is temporary.',
   summary = 'Check if the Buffer is temporary.',
   description = 'Returns whether the Buffer is temporary.',
   description = 'Returns whether the Buffer is temporary.',
   arguments = {},
   arguments = {},

+ 1 - 1
api/lovr/graphics/Pass/setCullMode.lua

@@ -1,6 +1,6 @@
 return {
 return {
   tag = 'pipeline',
   tag = 'pipeline',
-  deprecated = true,
+  deprecated = 'This function has been replaced by `Pass:setFaceCull`.',
   summary = 'Control triangle face culling.',
   summary = 'Control triangle face culling.',
   description = 'Sets whether the front or back faces of triangles are culled.',
   description = 'Sets whether the front or back faces of triangles are culled.',
   arguments = {
   arguments = {

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

@@ -1,9 +1,9 @@
 return {
 return {
   tag = 'graphics-objects',
   tag = 'graphics-objects',
-  summary = 'Get a temporary Pass.',
   deprecated = [[
   deprecated = [[
     Temporary passes have been removed.  This function was replaced by `lovr.graphics.newPass`.
     Temporary passes have been removed.  This function was replaced by `lovr.graphics.newPass`.
   ]],
   ]],
+  summary = 'Get a temporary Pass.',
   description = 'Creates and returns a temporary Pass object.',
   description = 'Creates and returns a temporary Pass object.',
   arguments = {
   arguments = {
     type = {
     type = {

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

@@ -1,6 +1,6 @@
 return {
 return {
-  deprecated = true,
   tag = 'headset',
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.getRefreshRates`.',
   summary = 'Get the list of refresh rates supported by the display.',
   summary = 'Get the list of refresh rates supported by the display.',
   description = [[
   description = [[
     Returns a table with all the refresh rates supported by the headset display, in Hz.
     Returns a table with all the refresh rates supported by the headset display, in Hz.

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

@@ -1,6 +1,6 @@
 return {
 return {
-  deprecated = true,
   tag = 'headset',
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.getRefreshRate`.',
   summary = 'Get the refresh rate of the display.',
   summary = 'Get the refresh rate of the display.',
   description = 'Returns the refresh rate of the headset display, in Hz.',
   description = 'Returns the refresh rate of the headset display, in Hz.',
   arguments = {},
   arguments = {},

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

@@ -1,6 +1,6 @@
 return {
 return {
-  deprecated = true,
   tag = 'playArea',
   tag = 'playArea',
+  deprecated = 'Replaced by `lovr.headset.isSeated`.',
   summary = 'Get the type of tracking origin of the headset.',
   summary = 'Get the type of tracking origin of the headset.',
   description = [[
   description = [[
     Returns the type of origin used for the tracking volume.  The different types of origins are
     Returns the type of origin used for the tracking volume.  The different types of origins are

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

@@ -1,6 +1,6 @@
 return {
 return {
-  deprecated = true,
   tag = 'headset',
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.setRefreshRate`.',
   summary = 'Set the display refresh rate.',
   summary = 'Set the display refresh rate.',
   description = 'Sets the display refresh rate, in Hz.',
   description = 'Sets the display refresh rate, in Hz.',
   arguments = {
   arguments = {

+ 1 - 1
api/lovr/physics/Collider/isGravityIgnored.lua

@@ -1,5 +1,5 @@
 return {
 return {
-  deprecated = true,
+  deprecated = 'This function has been replaced by `Collider:getGravityScale`.',
   summary = 'Check if the Collider ignores gravity.',
   summary = 'Check if the Collider ignores gravity.',
   description = 'Returns whether the Collider is currently ignoring gravity.',
   description = 'Returns whether the Collider is currently ignoring gravity.',
   arguments = {},
   arguments = {},

+ 1 - 1
api/lovr/physics/Collider/setGravityIgnored.lua

@@ -1,5 +1,5 @@
 return {
 return {
-  deprecated = true,
+  deprecated = 'This function has been replaced by `Collider:setGravityScale`.',
   summary = 'Set whether the Collider ignores gravity.',
   summary = 'Set whether the Collider ignores gravity.',
   description = 'Sets whether the Collider should ignore gravity.',
   description = 'Sets whether the Collider should ignore gravity.',
   arguments = {
   arguments = {