aboutsummaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorparamat <mat.gregory@virginmedia.com>2016-10-29 15:22:18 +0100
committerparamat <mat.gregory@virginmedia.com>2016-10-31 10:59:38 +0000
commit70e2df4f86cf4101a10c7e1f7a6ac5cc03992793 (patch)
tree43ebeb027beda84fe29047cff64edf4ef4754931 /doc/lua_api.txt
parent380a4b6d60c3269d1d9c79c122ff5259989decd7 (diff)
downloadminetest-70e2df4f86cf4101a10c7e1f7a6ac5cc03992793.tar.gz
minetest-70e2df4f86cf4101a10c7e1f7a6ac5cc03992793.tar.bz2
minetest-70e2df4f86cf4101a10c7e1f7a6ac5cc03992793.zip
Lua voxelmanip: Add optional buffer param for 'get param2 data'
Update lua_api.txt.
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 43ff66bb9..da90f93d2 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -3263,7 +3263,9 @@ will place the schematic inside of the VoxelManip.
* `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
in the `VoxelManip`
* expects lighting data in the same format that `get_light_data()` returns
-* `get_param2_data()`: Gets the raw `param2` data read into the `VoxelManip` object
+* `get_param2_data([buffer])`: Gets the raw `param2` data read into the `VoxelManip` object
+ * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
+ * If the param `buffer` is present, this table will be used to store the result instead
* `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
* `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
* To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`