Przeglądaj źródła

Add some more deprecation notices;

bjorn 1 tydzień temu
rodzic
commit
e11f587809

+ 8 - 8
api/init.lua

@@ -14571,7 +14571,7 @@ return {
               description = "Returns whether the Buffer is temporary.",
               key = "Buffer:isTemporary",
               module = "lovr.graphics",
-              deprecated = true,
+              deprecated = "Temporary buffers have been removed, this function always returns false.",
               related = {
                 "lovr.graphics.getBuffer"
               },
@@ -21893,7 +21893,7 @@ return {
               description = "Sets whether the front or back faces of triangles are culled.",
               key = "Pass:setCullMode",
               module = "lovr.graphics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Pass:setFaceCull`.",
               notes = "By default, face culling is disabled.",
               related = {
                 "Pass:setViewCull",
@@ -25725,7 +25725,7 @@ return {
           description = "Returns a table with all the refresh rates supported by the headset display, in Hz.",
           key = "lovr.headset.getDisplayFrequencies",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.getRefreshRates`.",
           related = {
             "lovr.headset.setDisplayFrequency"
           },
@@ -25749,7 +25749,7 @@ return {
           description = "Returns the refresh rate of the headset display, in Hz.",
           key = "lovr.headset.getDisplayFrequency",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.getRefreshRate`.",
           variants = {
             {
               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.",
           key = "lovr.headset.getOriginType",
           module = "lovr.headset",
-          deprecated = true,
+          deprecated = "Replaced by `lovr.headset.isSeated`.",
           related = {
             "HeadsetOrigin"
           },
@@ -27066,7 +27066,7 @@ return {
           description = "Sets the display refresh rate, in Hz.",
           key = "lovr.headset.setDisplayFrequency",
           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.",
           variants = {
             {
@@ -37279,7 +37279,7 @@ return {
               description = "Returns whether the Collider is currently ignoring gravity.",
               key = "Collider:isGravityIgnored",
               module = "lovr.physics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Collider:getGravityScale`.",
               variants = {
                 {
                   arguments = {},
@@ -37710,7 +37710,7 @@ return {
               description = "Sets whether the Collider should ignore gravity.",
               key = "Collider:setGravityIgnored",
               module = "lovr.physics",
-              deprecated = true,
+              deprecated = "This function has been replaced by `Collider:setGravityScale`.",
               variants = {
                 {
                   arguments = {

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

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

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

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

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

@@ -1,9 +1,9 @@
 return {
   tag = 'graphics-objects',
-  summary = 'Get a temporary Pass.',
   deprecated = [[
     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.',
   arguments = {
     type = {

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

@@ -1,6 +1,6 @@
 return {
-  deprecated = true,
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.getRefreshRates`.',
   summary = 'Get the list of refresh rates supported by the display.',
   description = [[
     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 {
-  deprecated = true,
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.getRefreshRate`.',
   summary = 'Get the refresh rate of the display.',
   description = 'Returns the refresh rate of the headset display, in Hz.',
   arguments = {},

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

@@ -1,6 +1,6 @@
 return {
-  deprecated = true,
   tag = 'playArea',
+  deprecated = 'Replaced by `lovr.headset.isSeated`.',
   summary = 'Get the type of tracking origin of the headset.',
   description = [[
     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 {
-  deprecated = true,
   tag = 'headset',
+  deprecated = 'Replaced by `lovr.headset.setRefreshRate`.',
   summary = 'Set the display refresh rate.',
   description = 'Sets the display refresh rate, in Hz.',
   arguments = {

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

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

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

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