diff options
author | ShadowNinja <shadowninja@minetest.net> | 2014-10-29 22:47:08 -0400 |
---|---|---|
committer | ShadowNinja <shadowninja@minetest.net> | 2015-02-01 15:56:16 -0500 |
commit | bb8456b71119ca6303b9e9706829a84dc7f81ab3 (patch) | |
tree | 919026712fb25b847ef8d09626400bbf0fd556eb /WorldEdit API.md | |
parent | 1f277147ca03788b784ee13fb1dd4e07889b4b59 (diff) |
Cleanup and fixup
Non-stylistic changes:
* Add LuaDoc/LDoc support.
* Fix `clear_objects` area size calculation.
* Fix `clear_objects` removing player objects.
* Fix shadowing of marker entity name with player name.
* Make visualization functions use `swap_node`.
* Make hidden nodes unwalkable.
* Prevent `hide` from hiding air.
* Make deprecated functions log to deprecated stream when called.
* Fixed `replaceinverse` not using normalized node names.
* Added .gitignore.
* Bump version to 1.1.
Stylistic changes:
* Change `x = function` to `function x`.
* Change comment format.
* Make missing VoxelManip error less obnoxious.
* Move `sort_pos` into `common.lua`, which is a required module.
* Remove local copies of `minetest`.
* Remove `worldedit = worldedit or {}` from modules.
* Replace replaceinverse with an inverse argument to `replace`.
* Added `error()`s on on invalid axes.
* Change `wip` to `TODO`.
* Rename `clearobjects` to `clear_objects`.
* Remove `hollow_{sphere,dome,cylinder}` and replace them with a hollow parameter to each function.
* Add helpers to reduce code duplication.
* Renamed `Chat Commands.md` to `ChatCommands.md`.
Diffstat (limited to 'WorldEdit API.md')
-rw-r--r-- | WorldEdit API.md | 48 |
1 files changed, 15 insertions, 33 deletions
diff --git a/WorldEdit API.md b/WorldEdit API.md index af7138b..f50b506 100644 --- a/WorldEdit API.md +++ b/WorldEdit API.md @@ -21,9 +21,9 @@ Manipulations -------------
Contained in manipulations.lua, this module allows several node operations to be applied over a region.
-### count = worldedit.set(pos1, pos2, nodename)
+### count = worldedit.set(pos1, pos2, node_name)
-Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear a region, use "air" as the value of `nodename`.
+Sets a region defined by positions `pos1` and `pos2` to `node_name`. To clear a region, use "air" as the value of `node_name`.
Returns the number of nodes set.
@@ -109,51 +109,33 @@ Primitives ----------
Contained in primitives.lua, this module allows the creation of several geometric primitives.
-### count = worldedit.hollow_sphere(pos, radius, nodename)
+### count = worldedit.sphere(pos, radius, node_name, hollow)
-Adds a hollow sphere centered at `pos` with radius `radius`, composed of `nodename`.
+Adds a sphere centered at `pos` with radius `radius`, composed of `node_name`.
Returns the number of nodes added.
-### count = worldedit.sphere(pos, radius, nodename)
+### count = worldedit.dome(pos, radius, node_name, hollow)
-Adds a sphere centered at `pos` with radius `radius`, composed of `nodename`.
+Adds a dome centered at `pos` with radius `radius`, composed of `node_name`.
Returns the number of nodes added.
-### count = worldedit.hollow_dome(pos, radius, nodename)
+### count = worldedit.cylinder(pos, axis, length, radius, node_name, hollow)
-Adds a hollow dome centered at `pos` with radius `radius`, composed of `nodename`.
+Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `node_name`.
Returns the number of nodes added.
-### count = worldedit.dome(pos, radius, nodename)
-
-Adds a dome centered at `pos` with radius `radius`, composed of `nodename`.
-
-Returns the number of nodes added.
-
-### 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.
-
-### 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.
-
-### count = worldedit.pyramid(pos, axis, height, nodename)
+### count = worldedit.pyramid(pos, axis, height, node_name)
Adds a pyramid centered at `pos` along the `axis` axis ("x" or "y" or "z") with height `height`.
Returns the number of nodes added.
-### count = worldedit.spiral(pos, length, height, spacer, nodename)
+### count = worldedit.spiral(pos, length, height, spacer, node_name)
-Adds a spiral centered at `pos` with side length `length`, height `height`, space between walls `spacer`, composed of `nodename`.
+Adds a spiral centered at `pos` with side length `length`, height `height`, space between walls `spacer`, composed of `node_name`.
Returns the number of nodes added.
@@ -173,15 +155,15 @@ Hides all nodes in a region defined by positions `pos1` and `pos2` by non-destru Returns the number of nodes hidden.
-### count = worldedit.suppress(pos1, pos2, nodename)
+### count = worldedit.suppress(pos1, pos2, node_name)
-Suppresses all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.
+Suppresses all instances of `node_name` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.
Returns the number of nodes suppressed.
-### count = worldedit.highlight(pos1, pos2, nodename)
+### count = worldedit.highlight(pos1, pos2, node_name)
-Highlights all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes.
+Highlights all instances of `node_name` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes.
Returns the number of nodes found.
|