From 3f13dc790caeda7ca8f5e429f6f94458bda5826c Mon Sep 17 00:00:00 2001 From: kwolekr Date: Fri, 28 Jun 2013 10:28:15 -0400 Subject: Add voxelarea.lua helper to builtin --- doc/lua_api.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc') diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 5920b97a0..c39098a7a 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -1572,6 +1572,16 @@ methods: ^ will be ignored - update_liquids(): Update liquid flow +VoxelArea: A helper class for voxel areas +- Can be created via VoxelArea:new{MinEdge=pmin, MaxEdge=pmax} +- Coordinates are *inclusive*, like most other things in Minetest +methods: +- getExtent(): returns a 3d vector containing the size of the area formed by MinEdge and MaxEdge +- getVolume(): returns the volume of the area formed by MinEdge and 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, PerlinNoiseMap:get2d/3dMap, and so on +- indexp(p): same as above, except takes a vector + Mapgen objects --------------- A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate -- cgit v1.2.3