Clarify the documentation regarding the the positioning of WorldEdit primitives relat...

[worldedit.git] / WorldEdit API.md

diff --git a/WorldEdit API.md b/WorldEdit API.md
index a69062f04e5e482e34fa2a0288e8148884e842bf..12320f6c7488df7db4d98ae3eed1880eeb0fc4cd 100644 (file)
--- a/WorldEdit API.md
+++ b/WorldEdit API.md
@@ -46,11 +46,17 @@ Duplicates the region defined by positions `pos1` and `pos2` along the `axis` ax
 \r
 Returns the number of nodes stacked.\r
 \r
+### count, newpos1, newpos2 = worldedit.scale(pos1, pos2, factor)\r
+\r
+Scales the region defined by positions `pos1` and `pos2` by an factor of positive integer `factor` with `pos1` as the origin.\r
+\r
+Returns the number of nodes scaled, the new scaled position 1, and the new scaled position 2.\r
+\r
 ### count, newpos1, newpos2 = worldedit.transpose(pos1, pos2, axis1, axis2)\r
 \r
 Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").\r
 \r
-Returns the number of nodes transposed, the new position 1, and the new position 2.\r
+Returns the number of nodes transposed, the new transposed position 1, and the new transposed position 2.\r
 \r
 ### count = worldedit.flip(pos1, pos2, axis)\r
 \r
@@ -82,13 +88,25 @@ Contained in primitives.lua, this module allows the creation of several geometri
 \r
 ### count = worldedit.hollow_sphere(pos, radius, nodename)\r
 \r
-Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`.\r
+Adds a hollow sphere centered at `pos` with radius `radius`, composed of `nodename`.\r
 \r
 Returns the number of nodes added.\r
 \r
 ### count = worldedit.sphere(pos, radius, nodename)\r
 \r
-Adds a sphere at `pos` with radius `radius`, composed of `nodename`.\r
+Adds a sphere centered at `pos` with radius `radius`, composed of `nodename`.\r
+\r
+Returns the number of nodes added.\r
+\r
+### count = worldedit.hollow_dome(pos, radius, nodename)\r
+\r
+Adds a hollow dome centered at `pos` with radius `radius`, composed of `nodename`.\r
+\r
+Returns the number of nodes added.\r
+\r
+### count = worldedit.dome(pos, radius, nodename)\r
+\r
+Adds a dome centered at `pos` with radius `radius`, composed of `nodename`.\r
 \r
 Returns the number of nodes added.\r
 \r
@@ -106,13 +124,13 @@ Returns the number of nodes added.
 \r
 ### count = worldedit.pyramid(pos, height, nodename)\r
 \r
-Adds a pyramid at `pos` with height `height`.\r
+Adds a pyramid centered at `pos` with height `height`.\r
 \r
 Returns the number of nodes added.\r
 \r
 ### count = worldedit.spiral(pos, width, height, spacer, nodename)\r
 \r
-Adds a spiral at `pos` with width `width`, height `height`, space between walls `spacer`, composed of `nodename`.\r
+Adds a spiral centered at `pos` with width `width`, height `height`, space between walls `spacer`, composed of `nodename`.\r
 \r
 Returns the number of nodes added.\r
 \r