From aa4a70d237db22b587d46a50a21d1a71a445874e Mon Sep 17 00:00:00 2001 From: Anthony Zhang Date: Sun, 21 Oct 2012 17:49:43 -0400 Subject: Rename //find to //highlight and worldedit.find to worldedit.highlight, add //allocate and worldedit.allocate as well as related documentation. Improve documentation by fixing a few mistakes and adding return signatures. --- WorldEdit API.md | 70 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 33 deletions(-) (limited to 'WorldEdit API.md') diff --git a/WorldEdit API.md b/WorldEdit API.md index 30e4437..ddf9a1e 100644 --- a/WorldEdit API.md +++ b/WorldEdit API.md @@ -8,63 +8,55 @@ Manipulations ------------- Contained in manipulations.lua, this module allows several node operations to be applied over a region. -### worldedit.volume(pos1, pos2) - -Determines the volume of the region defined by positions `pos1` and `pos2`. - -Returns the volume. - -### worldedit.set(pos1, pos2, nodename) +### count = worldedit.set(pos1, pos2, nodename) Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`. Returns the number of nodes set. -### worldedit.replace(pos1, pos2, searchnode, replacenode) +### count = worldedit.replace(pos1, pos2, searchnode, replacenode) Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`. Returns the number of nodes replaced. -Returns the number of nodes added. - -### worldedit.copy(pos1, pos2, axis, amount) +### count = worldedit.copy(pos1, pos2, axis, amount) Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes. Returns the number of nodes copied. -### worldedit.move(pos1, pos2, axis, amount) +### count = worldedit.move(pos1, pos2, axis, amount) Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes. Returns the number of nodes moved. -### worldedit.stack(pos1, pos2, axis, count) +### count = worldedit.stack(pos1, pos2, axis, count) Duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times. Returns the number of nodes stacked. -### worldedit.transpose(pos1, pos2, axis1, axis2) +### count = worldedit.transpose(pos1, pos2, axis1, axis2) Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z"). Returns the number of nodes transposed. -### worldedit.flip(pos1, pos2, axis) +### count = worldedit.flip(pos1, pos2, axis) Flips a region defined by the positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z"). Returns the number of nodes flipped. -### worldedit.rotate(pos1, pos2, angle) +### count = worldedit.rotate(pos1, pos2, angle) Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only). Returns the number of nodes rotated. -### worldedit.dig(pos1, pos2) +### count = worldedit.dig(pos1, pos2) Digs a region defined by positions `pos1` and `pos2`. @@ -74,37 +66,37 @@ Primitives ---------- Contained in primitives.lua, this module allows the creation of several geometric primitives. -### worldedit.hollow_sphere = function(pos, radius, nodename) +### count = worldedit.hollow_sphere(pos, radius, nodename) Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`. Returns the number of nodes added. -### worldedit.sphere = function(pos, radius, nodename) +### count = worldedit.sphere(pos, radius, nodename) Adds a sphere at `pos` with radius `radius`, composed of `nodename`. Returns the number of nodes added. -### worldedit.hollow_cylinder(pos, axis, length, radius, nodename) +### count = worldedit.hollow_cylinder(pos, axis, length, radius, nodename) Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`. Returns the number of nodes added. -### worldedit.cylinder(pos, axis, length, radius, nodename) +### count = worldedit.cylinder(pos, axis, length, radius, nodename) Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`. Returns the number of nodes added. -### worldedit.pyramid(pos, height, nodename) +### count = worldedit.pyramid(pos, height, nodename) Adds a pyramid at `pos` with height `height`. Returns the number of nodes added. -### worldedit.spiral(pos, width, height, spacer, nodename) +### count = worldedit.spiral(pos, width, height, spacer, nodename) Adds a spiral at `pos` with width `width`, height `height`, space between walls `spacer`, composed of `nodename`. @@ -112,25 +104,31 @@ Visualization ------------- Contained in visualization.lua, this module allows nodes to be visualized in different ways. -### worldedit.hide(pos1, pos2) +### volume = worldedit.volume(pos1, pos2) + +Determines the volume of the region defined by positions `pos1` and `pos2`. + +Returns the volume. + +### count = worldedit.hide(pos1, pos2) Hides all nodes in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes. Returns the number of nodes hidden. -### worldedit.suppress(pos1, pos2, nodename) +### count = worldedit.suppress(pos1, pos2, nodename) Suppresses all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes. Returns the number of nodes suppressed. -### worldedit.find(pos1, pos2, nodename) +### count = worldedit.highlight(pos1, pos2, nodename) -Finds all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes. +Highlights all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes. Returns the number of nodes found. -### worldedit.restore(pos1, pos2) +### count = worldedit.restore(pos1, pos2) Restores all nodes hidden with WorldEdit functions in a region defined by positions `pos1` and `pos2`. @@ -140,19 +138,25 @@ Serialization ------------- Contained in serialization.lua, this module allows regions of nodes to be serialized and deserialized to formats suitable for use outside MineTest. -### worldedit.serialize(pos1, pos2) +### data, count = worldedit.serialize(pos1, pos2) Converts the region defined by positions `pos1` and `pos2` into a single string. Returns the serialized data and the number of nodes serialized. -### worldedit.deserialize(originpos, value) +### pos1, pos2, count = worldedit.allocate(originpos, value) + +Determines the volume the nodes represented by string `value` would occupy if deserialized at `originpos`. + +Returns the two corner positions and the number of nodes. + +### count = worldedit.deserialize(originpos, value) Loads the nodes represented by string `value` at position `originpos`. Returns the number of nodes deserialized. -### worldedit.deserialize_old(originpos, value) +### count = worldedit.deserialize_old(originpos, value) Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format. @@ -160,13 +164,13 @@ This function is deprecated, and should not be used unless there is a need to su Returns the number of nodes deserialized. -### worldedit.metasave(pos1, pos2, file) +### count = worldedit.metasave(pos1, pos2, file) Saves the nodes and meta defined by positions `pos1` and `pos2` into a file. Returns the number of nodes saved. -### worldedit.metaload(pos1, file) +### count = worldedit.metaload(pos1, file) Loads the nodes and meta from `file` to position `pos1`. -- cgit v1.2.3