mtcontrib
/
Minetest-WorldEdit
mirror of https://github.com/Uberi/Minetest-WorldEdit.git
1
0
Fork 1
Code Issues Releases Wiki Activity
Minetest-WorldEdit/WorldEdit API.md

193 lines
6.7 KiB
Markdown
Raw Normal View History

Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
WorldEdit API
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
=============
The WorldEdit API is composed of multiple modules, each of which is independent and can be used without the other. Each module is contained within a single file.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
For more information, see the [README](README.md).
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Manipulations
-------------
Contained in manipulations.lua, this module allows several node operations to be applied over a region.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.set(pos1, pos2, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.replace(pos1, pos2, searchnode, replacenode)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
Returns the number of nodes replaced.
Replace //homogenize with //replaceinverse (//homogenize x is equivalent to //replaceinverse air x), add documentation for it.
2013-01-13 00:29:57 +01:00
### count = worldedit.replaceinverse(pos1, pos2, searchnode, replacenode)
Replaces all nodes other than `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
Returns the number of nodes replaced.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.copy(pos1, pos2, axis, amount)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
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.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.move(pos1, pos2, axis, amount)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
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.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.stack(pos1, pos2, axis, count)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
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.
Many thanks to Smitje for providing a working example of roations. Changes: fixed rotation and transposition of non-sqaure regions, makers are now moved to the new region boundaries after rotation/transposition, small consistency fixes, finally fix the /hide command.
2012-12-12 23:17:56 +01:00
### count, newpos1, newpos2 = worldedit.transpose(pos1, pos2, axis1, axis2)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").
Many thanks to Smitje for providing a working example of roations. Changes: fixed rotation and transposition of non-sqaure regions, makers are now moved to the new region boundaries after rotation/transposition, small consistency fixes, finally fix the /hide command.
2012-12-12 23:17:56 +01:00
Returns the number of nodes transposed, the new position 1, and the new position 2.
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.flip(pos1, pos2, axis)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
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.
Many thanks to Smitje for providing a working example of roations. Changes: fixed rotation and transposition of non-sqaure regions, makers are now moved to the new region boundaries after rotation/transposition, small consistency fixes, finally fix the /hide command.
2012-12-12 23:17:56 +01:00
### count, newpos2, newpos2 = worldedit.rotate(pos1, pos2, angle)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only).
Many thanks to Smitje for providing a working example of roations. Changes: fixed rotation and transposition of non-sqaure regions, makers are now moved to the new region boundaries after rotation/transposition, small consistency fixes, finally fix the /hide command.
2012-12-12 23:17:56 +01:00
Returns the number of nodes rotated, the new position 1, and the new position 2.
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
New command: //orient, that rotates oriented nodes such as furnaces around the Y-axis by a specified angle.
2013-01-12 22:46:40 +01:00
### count = worldedit.orient(pos1, pos2, angle)
Rotates all oriented nodes in a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise (90 degree increment) around the Y axis.
Returns the number of nodes oriented.
Change all references of //dig to //fixlight, document the changes, fix a small typo.
2013-01-12 22:02:23 +01:00
### count = worldedit.fixlight(pos1, pos2)
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Change all references of //dig to //fixlight, document the changes, fix a small typo.
2013-01-12 22:02:23 +01:00
Fixes the lighting in a region defined by positions `pos1` and `pos2`.
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Change all references of //dig to //fixlight, document the changes, fix a small typo.
2013-01-12 22:02:23 +01:00
Returns the number of nodes updated.
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Primitives
----------
Contained in primitives.lua, this module allows the creation of several geometric primitives.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.hollow_sphere(pos, radius, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`.
Returns the number of nodes added.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.sphere(pos, radius, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Adds a sphere at `pos` with radius `radius`, composed of `nodename`.
Returns the number of nodes added.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.hollow_cylinder(pos, axis, length, radius, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.cylinder(pos, axis, length, radius, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.pyramid(pos, height, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Adds a pyramid at `pos` with height `height`.
Returns the number of nodes added.
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.spiral(pos, width, height, spacer, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Adds a spiral at `pos` with width `width`, height `height`, space between walls `spacer`, composed of `nodename`.
Many thanks to Smitje for providing a working example of roations. Changes: fixed rotation and transposition of non-sqaure regions, makers are now moved to the new region boundaries after rotation/transposition, small consistency fixes, finally fix the /hide command.
2012-12-12 23:17:56 +01:00
Returns the number of nodes added.
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Visualization
-------------
Contained in visualization.lua, this module allows nodes to be visualized in different ways.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
2012-10-21 23:49:43 +02:00
### 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)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Hides all nodes in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Returns the number of nodes hidden.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.suppress(pos1, pos2, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Suppresses all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Returns the number of nodes suppressed.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.highlight(pos1, pos2, nodename)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
2012-10-21 23:49:43 +02:00
Highlights all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Returns the number of nodes found.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
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.
2012-10-21 23:49:43 +02:00
### count = worldedit.restore(pos1, pos2)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Restores all nodes hidden with WorldEdit functions in a region defined by positions `pos1` and `pos2`.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Returns the number of nodes restored.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Separate components into separate mods, add visualization API with hide(), suppress(), find(), and restore() for nondestructive node visualization. Corresponding chat commands are //hide, //suppress, //find, and //restore. Commands and functions documented.
2012-10-14 03:45:50 +02:00
Serialization
-------------
Contained in serialization.lua, this module allows regions of nodes to be serialized and deserialized to formats suitable for use outside MineTest.
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
//metasave and //metaload are now superceded by //save and //load's new functionality. worldedit.deserialize now supports every version of the WorldEdit format that has ever existed, and the new worldedit.valueversion uses file characteristics to determine which type of file format a given file uses. The new WorldEdit file format is the same as the one used by MineTest for serializing data, and is capable of storing arbitrary data, as well as leaving fields for future improvements. In other words, this is the last forward-compatibility breaking change that will be made to the file format.
2013-03-20 22:12:48 +01:00
### version = worldedit.valueversion(value)
Determines the version of serialized data `value`.
Returns the version as a positive integer or 0 for unknown versions.
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.
2012-10-21 23:49:43 +02:00
### data, count = worldedit.serialize(pos1, pos2)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Converts the region defined by positions `pos1` and `pos2` into a single string.
Returns the serialized data and the number of nodes serialized.
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.
2012-10-21 23:49:43 +02:00
### 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)
Use modpack for easier installation (idea is taken from cornernote's mod format), fix some grammar in API reference, move chat command reference and API reference to separate files.
2012-10-01 22:19:09 +02:00
Loads the nodes represented by string `value` at position `originpos`.
Returns the number of nodes deserialized.
Add //homogenize, //lua, and //luatransform commands, as well as their documentation.
2013-01-13 00:20:41 +01:00
Code
----
Contained in code.lua, this module allows arbitrary Lua code to be used with WorldEdit.
### error = worldedit.lua(code)
Executes `code` as a Lua chunk in the global namespace.
Returns an error if the code fails or nil otherwise.
### error = worldedit.luatransform(pos1, pos2, code)
Executes `code` as a Lua chunk in the global namespace with the variable pos available, for each node in a region defined by positions `pos1` and `pos2`.
Returns an error if the code fails or nil otherwise.