minetest
/
minetest
mirror of https://github.com/minetest/minetest.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Lua_api.txt: Warn of errors possible with VoxelArea:index()/indexp() (#7422)

This commit is contained in:
Paramat 2018-06-08 00:46:10 +01:00 committed by GitHub
parent 9f8582dcdf
commit 9ca37d86a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/lua_api.txt
View File

@ -4736,9 +4736,14 @@ The coordinates are *inclusive*, like most other things in Minetest.
`MaxEdge`.
* `index(x, y, z)`: returns the index of an absolute position in a flat array
starting at `1`.
* useful for things like `VoxelManip`, raw Schematic specifiers,
* `x`, `y` and `z` must be integers to avoid an incorrect index result.
* The position (x, y, z) is not checked for being inside the area volume,
being outside can cause an incorrect index result.
* Useful for things like `VoxelManip`, raw Schematic specifiers,
`PerlinNoiseMap:get2d`/`3dMap`, and so on.
* `indexp(p)`: same as above, except takes a vector
* `indexp(p)`: same functionality as `index(x, y, z)` but takes a vector.
* As with `index(x, y, z)`, the components of `p` must be integers, and `p`
is not checked for being inside the area volume.
* `position(i)`: returns the absolute position vector corresponding to index
`i`.
* `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by