Browse Source

Add note to MeshShape

xiejiangzhi 8 months ago
parent
commit
730ae29857
1 changed files with 3 additions and 0 deletions
  1. 3 0
      api/lovr/physics/MeshShape/init.lua

+ 3 - 0
api/lovr/physics/MeshShape/init.lua

@@ -2,6 +2,9 @@ return {
   summary = 'A mesh Shape.',
   summary = 'A mesh Shape.',
   description = 'A type of `Shape` that can be used for triangle meshes.',
   description = 'A type of `Shape` that can be used for triangle meshes.',
   extends = 'Shape',
   extends = 'Shape',
+  notes = [[
+    MeshShape is static. If the collider contains a MeshShape, it will be forced to become static.
+  ]],
   constructors = {
   constructors = {
     'lovr.physics.newMeshShape',
     'lovr.physics.newMeshShape',
     'World:newMeshCollider'
     'World:newMeshCollider'