aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDS <vorunbekannt75@web.de>2020-09-01 20:18:10 +0200
committerGitHub <noreply@github.com>2020-09-01 20:18:10 +0200
commit9ed84cfa85fe9a03803f2f2aba041363db65672d (patch)
tree5a9e7d4bc6499155e8518f7b3b169931651f0b90 /doc
parentf5df70764d560addf747c707c8f9db7f5b0aea4e (diff)
downloadminetest-9ed84cfa85fe9a03803f2f2aba041363db65672d.tar.gz
minetest-9ed84cfa85fe9a03803f2f2aba041363db65672d.tar.bz2
minetest-9ed84cfa85fe9a03803f2f2aba041363db65672d.zip
Mark multiply and divide with two vectors as deprecated (Schur product and quotient) (#10329)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 6341571c7..cc4af970c 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -3080,7 +3080,8 @@ Internally, it is implemented as a table with the 3 fields
`x`, `y` and `z`. Example: `{x = 0, y = 1, z = 0}`.
For the following functions, `v`, `v1`, `v2` are vectors,
-`p1`, `p2` are positions:
+`p1`, `p2` are positions,
+`s` is a scalar (a number):
* `vector.new(a[, b, c])`:
* Returns a vector.
@@ -3126,10 +3127,12 @@ For the following functions `x` can be either a vector or a number:
* Returns a vector.
* If `x` is a vector: Returns the difference of `v` subtracted by `x`.
* If `x` is a number: Subtracts `x` from each component of `v`.
-* `vector.multiply(v, x)`:
- * Returns a scaled vector or Schur product.
-* `vector.divide(v, x)`:
- * Returns a scaled vector or Schur quotient.
+* `vector.multiply(v, s)`:
+ * Returns a scaled vector.
+ * Deprecated: If `s` is a vector: Returns the Schur product.
+* `vector.divide(v, s)`:
+ * Returns a scaled vector.
+ * Deprecated: If `s` is a vector: Returns the Schur quotient.
For the following functions `a` is an angle in radians and `r` is a rotation
vector ({x = <pitch>, y = <yaw>, z = <roll>}) where pitch, yaw and roll are