Browse Source

Mention sleeping Colliders;

bjorn 5 years ago
parent
commit
1822317e59

+ 4 - 2
api/init.lua

@@ -18999,7 +18999,8 @@ return {
                   },
                   returns = {}
                 }
-              }
+              },
+              notes = "If the Collider is asleep, it will need to be woken up with `Collider:setAwake` for this function to have any affect."
             },
             {
               name = "applyTorque",
@@ -19031,7 +19032,8 @@ return {
                   },
                   returns = {}
                 }
-              }
+              },
+              notes = "If the Collider is asleep, it will need to be woken up with `Collider:setAwake` for this function to have any affect."
             },
             {
               name = "destroy",

+ 4 - 0
api/lovr/physics/Collider/applyForce.lua

@@ -38,6 +38,10 @@ return {
       returns = {}
     }
   },
+  notes = [[
+    If the Collider is asleep, it will need to be woken up with `Collider:setAwake` for this
+    function to have any affect.
+  ]],
   related = {
     'Collider:applyTorque'
   }

+ 4 - 0
api/lovr/physics/Collider/applyTorque.lua

@@ -19,6 +19,10 @@ return {
     }
   },
   returns = {},
+  notes = [[
+    If the Collider is asleep, it will need to be woken up with `Collider:setAwake` for this
+    function to have any affect.
+  ]],
   related = {
     'Collider:applyForce'
   }