WorldEdit API.md

   1 WorldEdit API\r
   2 -------------\r
   3 For more information, see the [README](README.md).\r
   4 \r
   5 ### worldedit.volume(pos1, pos2)\r
   6 \r
   7 Determines the volume of the region defined by positions `pos1` and `pos2`.\r
   8 \r
   9 Returns the volume.\r
  10 \r
  11 ### worldedit.set(pos1, pos2, nodename)\r
  12 \r
  13 Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.\r
  14 \r
  15 Returns the number of nodes set.\r
  16 \r
  17 ### worldedit.replace(pos1, pos2, searchnode, replacenode)\r
  18 \r
  19 Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.\r
  20 \r
  21 Returns the number of nodes replaced.\r
  22 \r
  23 ### worldedit.hollow_sphere = function(pos, radius, nodename)\r
  24 \r
  25 Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`.\r
  26 \r
  27 Returns the number of nodes added.\r
  28 \r
  29 ### worldedit.sphere = function(pos, radius, nodename)\r
  30 \r
  31 Adds a sphere at `pos` with radius `radius`, composed of `nodename`.\r
  32 \r
  33 Returns the number of nodes added.\r
  34 \r
  35 ### worldedit.hollow_cylinder(pos, axis, length, radius, nodename)\r
  36 \r
  37 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
  38 \r
  39 Returns the number of nodes added.\r
  40 \r
  41 ### worldedit.cylinder(pos, axis, length, radius, nodename)\r
  42 \r
  43 Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.\r
  44 \r
  45 Returns the number of nodes added.\r
  46 \r
  47 ### worldedit.pyramid(pos, height, nodename)\r
  48 \r
  49 Adds a pyramid at `pos` with height `height`.\r
  50 \r
  51 Returns the number of nodes added.\r
  52 \r
  53 ### worldedit.spiral(pos, width, height, spacer, nodename)\r
  54 \r
  55 Adds a spiral at `pos` with width `width`, height `height`, space between walls `spacer`, composed of `nodename`.\r
  56 \r
  57 Returns the number of nodes added.\r
  58 \r
  59 ### worldedit.copy(pos1, pos2, axis, amount)\r
  60 \r
  61 Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.\r
  62 \r
  63 Returns the number of nodes copied.\r
  64 \r
  65 ### worldedit.move(pos1, pos2, axis, amount)\r
  66 \r
  67 Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.\r
  68 \r
  69 Returns the number of nodes moved.\r
  70 \r
  71 ### worldedit.stack(pos1, pos2, axis, count)\r
  72 \r
  73 Duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.\r
  74 \r
  75 Returns the number of nodes stacked.\r
  76 \r
  77 ### worldedit.transpose(pos1, pos2, axis1, axis2)\r
  78 \r
  79 Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").\r
  80 \r
  81 Returns the number of nodes transposed.\r
  82 \r
  83 ### worldedit.flip(pos1, pos2, axis)\r
  84 \r
  85 Flips a region defined by the positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z").\r
  86 \r
  87 Returns the number of nodes flipped.\r
  88 \r
  89 ### worldedit.rotate(pos1, pos2, angle)\r
  90 \r
  91 Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only).\r
  92 \r
  93 Returns the number of nodes rotated.\r
  94 \r
  95 ### worldedit.dig(pos1, pos2)\r
  96 \r
  97 Digs a region defined by positions `pos1` and `pos2`.\r
  98 \r
  99 Returns the number of nodes dug.\r
 100 \r
 101 ### worldedit.serialize(pos1, pos2)\r
 102 \r
 103 Converts the region defined by positions `pos1` and `pos2` into a single string.\r
 104 \r
 105 Returns the serialized data and the number of nodes serialized.\r
 106 \r
 107 ### worldedit.deserialize(originpos, value)\r
 108 \r
 109 Loads the nodes represented by string `value` at position `originpos`.\r
 110 \r
 111 Returns the number of nodes deserialized.\r
 112 \r
 113 ### worldedit.deserialize_old(originpos, value)\r
 114 \r
 115 Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.\r
 116 \r
 117 This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.\r
 118 \r
 119 Returns the number of nodes deserialized.\r
 120 \r
 121 ### worldedit.metasave(pos1, pos2, file)\r
 122 \r
 123 Saves the nodes and meta defined by positions `pos1` and `pos2` into a file.\r
 124 \r
 125 Returns the number of nodes saved.\r
 126 \r
 127 ### worldedit.metaload(pos1, file)\r
 128 \r
 129 Loads the nodes and meta from `file` to position `pos1`.\r
 130 \r
 131 Returns the number of nodes loaded.