Browse Source

Note vectors;

bjorn 3 years ago
parent
commit
750e29e829
2 changed files with 5 additions and 3 deletions
  1. 2 1
      api/lovr/Object/init.lua
  2. 3 2
      api/lovr/math/Vectors/init.lua

+ 2 - 1
api/lovr/Object/init.lua

@@ -7,5 +7,6 @@ return {
     In addition to the methods here, all objects have a `__tostring` metamethod that returns the
     In addition to the methods here, all objects have a `__tostring` metamethod that returns the
     name of the object's type.  So to check if a LÖVR object is an instance of "Blob", you can do
     name of the object's type.  So to check if a LÖVR object is an instance of "Blob", you can do
     `tostring(object) == 'Blob'`.
     `tostring(object) == 'Blob'`.
-  ]]
+  ]],
+  notes = 'Note that the functions here don\'t apply to any vector objects, see `Vectors`.'
 }
 }

+ 3 - 2
api/lovr/math/Vectors/init.lua

@@ -30,8 +30,9 @@ return {
 
 
     Vectors can be created in two different ways: **permanent** and **temporary**.
     Vectors can be created in two different ways: **permanent** and **temporary**.
 
 
-    **Permanent** vectors behave like normal LÖVR objects.  They are individual objects that are garbage
-    collected when no longer needed.  They're created using the usual `lovr.math.new<Type>` syntax:
+    **Permanent** vectors behave like normal Lua values.  They are individual objects that are
+    garbage collected when no longer needed.  They're created using the usual `lovr.math.new<Type>`
+    syntax:
 
 
         self.position = lovr.math.newVec3(x, y, z)
         self.position = lovr.math.newVec3(x, y, z)