Browse Source

Improve Collider tag docs;

bjorn 1 year ago
parent
commit
c1e93030f9
2 changed files with 6 additions and 1 deletions
  1. 1 1
      api/lovr/physics/Collider/getTag.lua
  2. 5 0
      api/lovr/physics/Collider/setTag.lua

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

@@ -5,7 +5,7 @@ return {
   returns = {
     tag = {
       type = 'string',
-      description = 'The Collider\'s collision tag.'
+      description = 'The Collider\'s collision tag, or `nil` if the Collider doesn\'t have a tag.'
     }
   },
   variants = {

+ 5 - 0
api/lovr/physics/Collider/setTag.lua

@@ -12,6 +12,11 @@ return {
     {
       arguments = { 'tag' },
       returns = {}
+    },
+    {
+      description = 'Clear the Collider\'s tag.'
+      arguments = {},
+      returns = {}
     }
   },
   notes = [[