]> git.lizzy.rs Git - worldedit.git/blobdiff - WorldEdit API.md
Cleanup and fixup
[worldedit.git] / WorldEdit API.md
index af7138bdc896d69f72c6560225cba77104803070..f50b5062c8dd192df55051758ee2eb83c24430c6 100644 (file)
@@ -21,9 +21,9 @@ Manipulations
 -------------\r
 Contained in manipulations.lua, this module allows several node operations to be applied over a region.\r
 \r
-### count = worldedit.set(pos1, pos2, nodename)\r
+### count = worldedit.set(pos1, pos2, node_name)\r
 \r
-Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear a region, use "air" as the value of `nodename`.\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
 \r
 Returns the number of nodes set.\r
 \r
@@ -109,51 +109,33 @@ Primitives
 ----------\r
 Contained in primitives.lua, this module allows the creation of several geometric primitives.\r
 \r
-### count = worldedit.hollow_sphere(pos, radius, nodename)\r
+### count = worldedit.sphere(pos, radius, node_name, hollow)\r
 \r
-Adds a hollow sphere centered at `pos` with radius `radius`, composed of `nodename`.\r
+Adds a sphere centered at `pos` with radius `radius`, composed of `node_name`.\r
 \r
 Returns the number of nodes added.\r
 \r
-### count = worldedit.sphere(pos, radius, nodename)\r
+### count = worldedit.dome(pos, radius, node_name, hollow)\r
 \r
-Adds a sphere centered at `pos` with radius `radius`, composed of `nodename`.\r
+Adds a dome centered at `pos` with radius `radius`, composed of `node_name`.\r
 \r
 Returns the number of nodes added.\r
 \r
-### count = worldedit.hollow_dome(pos, radius, nodename)\r
+### count = worldedit.cylinder(pos, axis, length, radius, node_name, hollow)\r
 \r
-Adds a hollow dome centered at `pos` with radius `radius`, composed of `nodename`.\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
 \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
-### count = worldedit.hollow_cylinder(pos, axis, length, radius, nodename)\r
-\r
-Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.\r
-\r
-Returns the number of nodes added.\r
-\r
-### count = worldedit.cylinder(pos, axis, length, radius, nodename)\r
-\r
-Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.\r
-\r
-Returns the number of nodes added.\r
-\r
-### count = worldedit.pyramid(pos, axis, height, nodename)\r
+### count = worldedit.pyramid(pos, axis, height, node_name)\r
 \r
 Adds a pyramid centered at `pos` along the `axis` axis ("x" or "y" or "z") with height `height`.\r
 \r
 Returns the number of nodes added.\r
 \r
-### count = worldedit.spiral(pos, length, height, spacer, nodename)\r
+### count = worldedit.spiral(pos, length, height, spacer, node_name)\r
 \r
-Adds a spiral centered at `pos` with side length `length`, height `height`, space between walls `spacer`, composed of `nodename`.\r
+Adds a spiral centered at `pos` with side length `length`, height `height`, space between walls `spacer`, composed of `node_name`.\r
 \r
 Returns the number of nodes added.\r
 \r
@@ -173,15 +155,15 @@ Hides all nodes in a region defined by positions `pos1` and `pos2` by non-destru
 \r
 Returns the number of nodes hidden.\r
 \r
-### count = worldedit.suppress(pos1, pos2, nodename)\r
+### count = worldedit.suppress(pos1, pos2, node_name)\r
 \r
-Suppresses all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.\r
+Suppresses all instances of `node_name` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.\r
 \r
 Returns the number of nodes suppressed.\r
 \r
-### count = worldedit.highlight(pos1, pos2, nodename)\r
+### count = worldedit.highlight(pos1, pos2, node_name)\r
 \r
-Highlights all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes.\r
+Highlights all instances of `node_name` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes.\r
 \r
 Returns the number of nodes found.\r
 \r