Fix deserialization of schematics with node names table

[worldedit.git] / WorldEdit API.md

diff --git a/WorldEdit API.md b/WorldEdit API.md
index 7b99c8beffac37765054f39176b36c889982941a..fc9cf652e0bda75d020d8a9842d9431beefd8f61 100644 (file)
--- a/WorldEdit API.md
+++ b/WorldEdit API.md
@@ -24,6 +24,13 @@ Contained in manipulations.lua, this module allows several node operations to be
 ### count = worldedit.set(pos1, pos2, node_name)\r
 \r
 Sets a region defined by positions `pos1` and `pos2` to `node_name`. To clear a region, use "air" as the value of `node_name`.\r
+If `node_name` is a list of nodes, each set node is randomly picked from it.\r
+\r
+Returns the number of nodes set.\r
+\r
+### `count = worldedit.set_param2(pos1, pos2, param2)`\r
+\r
+Sets the param2 values of all nodes in a region defined by positions `pos1` and `pos2` to `param2`.\r
 \r
 Returns the number of nodes set.\r
 \r
@@ -48,6 +55,7 @@ Returns the number of nodes copied.
 ### count = worldedit.copy2(pos1, pos2, off)\r
 \r
 Copies the region defined by positions `pos1` and `pos2` by the offset vector `off`.\r
+Note that the offset needs to be big enough that there is no overlap.\r
 \r
 Returns the number of nodes copied.\r
 \r
@@ -66,6 +74,7 @@ Returns the number of nodes stacked.
 ### count = worldedit.stack2(pos1, pos2, direction, amount)\r
 \r
 Duplicates the region defined by positions `pos1` and `pos2` `amount` times with offset vector `direction`.\r
+Note that the offset vector needs to be big enough that there is no overlap.\r
 \r
 Returns the number of nodes stacked.\r
 \r
@@ -115,6 +124,12 @@ Primitives
 ----------\r
 Contained in primitives.lua, this module allows the creation of several geometric primitives.\r
 \r
+### count = worldedit.cube(pos, width, height, length, node_name, hollow)\r
+\r
+Adds a cube with its ground level centered at `pos`, the dimensions `width` x `height` x `length`, composed of `node_name`.\r
+\r
+Returns the number of nodes added.\r
+\r
 ### count = worldedit.sphere(pos, radius, node_name, hollow)\r
 \r
 Adds a sphere centered at `pos` with radius `radius`, composed of `node_name`.\r
@@ -127,15 +142,15 @@ Adds a dome centered at `pos` with radius `radius`, composed of `node_name`.
 \r
 Returns the number of nodes added.\r
 \r
-### count = worldedit.cylinder(pos, axis, length, radius, node_name, hollow)\r
+### count = worldedit.cylinder(pos, axis, length, radius1, radius2, node_name, hollow)\r
 \r
-Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `node_name`.\r
+Adds a cylinder-like at `pos` along the `axis` axis ("x" or "y" or "z") with length `length`, base radius `radius1` and top radius `radius2`, composed of `node_name`.\r
 \r
 Returns the number of nodes added.\r
 \r
-### count = worldedit.pyramid(pos, axis, height, node_name)\r
+### count = worldedit.pyramid(pos, axis, height, node_name, hollow)\r
 \r
-Adds a pyramid centered at `pos` along the `axis` axis ("x" or "y" or "z") with height `height`.\r
+Adds a pyramid centered at `pos` along the `axis` axis ("x" or "y" or "z") with height `height`, composed of `node_name`.\r
 \r
 Returns the number of nodes added.\r
 \r
@@ -181,7 +196,7 @@ Returns the number of nodes restored.
 \r
 Serialization\r
 -------------\r
-Contained in serialization.lua, this module allows regions of nodes to be serialized and deserialized to formats suitable for use outside MineTest.\r
+Contained in serialization.lua, this module allows regions of nodes to be serialized and deserialized to formats suitable for use outside Minetest.\r
 \r
 ### version, extra_fields, content = worldedit.read_header(value)\r
 \r