Skip to content
Permalink
Browse files

Mark multiply and divide with two vectors as deprecated (Schur produc…

…t and quotient) (#10329)
  • Loading branch information
Desour committed Sep 1, 2020
1 parent f5df707 commit 9ed84cfa85fe9a03803f2f2aba041363db65672d
Showing with 8 additions and 5 deletions.
  1. +8 −5 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

1 comment on commit 9ed84cf

@FreeLikeGNU

This comment has been minimized.

Copy link

@FreeLikeGNU FreeLikeGNU commented on 9ed84cf Sep 1, 2020

Why?

Please sign in to comment.
You can’t perform that action at this time.