moparisthebest/minetest
1
0
Fork 0
mirror of https://github.com/moparisthebest/minetest synced 2024-11-05 17:05:05 -05:00
Code Issues Releases Wiki Activity

lua_api.txt: improve vector documentation

Browse Source 
Before it rendered very badly in HTML.
Also point out what vector.round does.
This commit is contained in:
est31 2016-03-19 09:18:22 +01:00
parent 3132bcb373
commit d915ca1124
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/lua_api.txt
View File

@ -1688,16 +1688,15 @@ or string form, a ColorString (defined above):
`colorspec = "green"`
Spatial Vectors
--------------
* `vector.new([x[, y, z]])`: returns a vector.
* `x` is a table or the `x` position.
---------------
* `vector.new(a[, b, c])`: returns a vector:
* A copy of `a` if `a` is a vector.
* `{x = a, y = b, z = c}`, if all `a, b, c` are defined
* `vector.direction(p1, p2)`: returns a vector
* `vector.distance(p1, p2)`: returns a number
* `vector.length(v)`: returns a number
* `vector.normalize(v)`: returns a vector
* `vector.round(v)`: returns a vector
* `vector.round(v)`: returns a vector, each dimension rounded to floor
* `vector.apply(v, func)`: returns a vector
* `vector.equals(v1, v2)`: returns a boolean
@ -1709,7 +1708,7 @@ For the following functions `x` can be either a vector or a number:
* `vector.divide(v, x)`: returns a scaled vector or Schur quotient
Helper functions
-----------------
----------------
* `dump2(obj, name="_", dumped={})`
* Return object serialized as a string, handles reference loops
* `dump(obj, dumped={})`