Replace worldedit.spiral with worldedit.pyramid, as well as related chat commands.

[worldedit.git] / README.md

diff --git a/README.md b/README.md
index f76b9bd3b2430d76e806560ccc72dbed80040b28..5324efb0284c1fc3493f53a3790c97c20b67a3c5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -91,6 +91,22 @@ Replace all instances of <search node> with <place node> in the current WorldEdi
     //replace dirt flowers:flower_waterlily
     //replace flowers:flower_rose flowers:flower_tulip
 
+### //hollowsphere <radius> <node>
+
+Add hollow sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
+
+    //hollowsphere 5 dirt
+    //hollowsphere 12 default:glass
+    //hollowsphere 17 mesecons:mesecon
+
+### //sphere <radius> <node>
+
+Add sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
+
+    //sphere 5 dirt
+    //sphere 12 default:glass
+    //sphere 17 mesecons:mesecon
+
 ### //hollowcylinder x/y/z/? <length> <radius> <node>
 
 Add hollow cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length> and radius <radius>, composed of <node>.
@@ -109,13 +125,13 @@ Add cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length>
     //cylinder z -12 3 mesecons:mesecon
     //cylinder ? 2 4 stone
     
-### //spiral <size> <node>
+### //pyramid <height> <node>
 
-Add spiral at WorldEdit position 1 with size <size>, composed of <node>.
+Add pyramid at WorldEdit position 1 with height <height>, composed of <node>.
 
-    //spiral 8 dirt
-    //spiral 5 default:glass
-    //spiral 2 stone
+    //pyramid 8 dirt
+    //pyramid 5 default:glass
+    //pyramid 2 stone
 
 
 ### //copy x/y/z/? <amount>
@@ -163,9 +179,9 @@ Flip the current WorldEdit region along the x/y/z/? axis.
    //flip z
    //flip ?
 
-### //rotate
+### //rotate x/y/z/? <angle>
 
-Rotate the current WorldEdit region around the axis <axis> by angle <angle> (90 degree increment).
+Rotate the current WorldEdit region along the x/y/z/? axis by angle <angle> (90 degree increment).
 
     //rotate x 90
     //rotate y 180
@@ -192,6 +208,20 @@ Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current
     //load some random filename
     //load huge_base
 
+### //metasave <file>
+
+Save the current WorldEdit region including metadata to "(world folder)/schems/<file>.wem".
+
+    //metasave some random filename
+    //metasave huge_base
+
+### //metaload <file>
+
+Load nodes and metadata from "(world folder)/schems/<file>.wem" with position 1 of the current WorldEdit region as the origin.
+
+    //metaload some random filename
+    //metaload huge_base
+
 WorldEdit API
 -------------
 WorldEdit exposes all significant functionality in a simple interface. Adding WorldEdit to the file "depends.txt" in your mod gives you access to all of the `worldedit` functions. These are useful if you're looking for high-performance node manipulation without all the hassle of writing tons of code.
@@ -214,23 +244,35 @@ Replaces all instances of `searchnode` with `replacenode` in a region defined by
 
 Returns the number of nodes replaced.
 
+### worldedit.hollow_sphere = function(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)
+
+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)
 
-Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
+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)
 
-Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
+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.spiral(pos, size, nodename)
+### worldedit.pyramid(pos, height, nodename)
 
-Adds a spiral at `pos` with size `size`.
+Adds a pyramid at `pos` with height `height`.
 
-Returns the number of nodes changed.
+Returns the number of nodes added.
 
 ### worldedit.copy(pos1, pos2, axis, amount)
 
@@ -294,6 +336,18 @@ 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)
+
+Saves the nodes and meta defined by positions `pos1` and `pos2` into a file
+
+Returns the number of nodes saved
+
+### worldedit.metaload(pos1, file)
+
+Loads the nodes and meta from `file` to position `pos1`
+
+Returns the number of nodes loaded
+
 License
 -------
 Copyright 2012 sfan5 and Anthony Zhang (Temperest)