X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=WorldEdit%20API.md;fp=WorldEdit%20API.md;h=4169cbe5d91e745b31e64d15aa454c34297e6aa0;hb=ac7430e02fe0d8dfcef08ab4eda4877241b332df;hp=22441d297cdb16a424c9823557888ea3b68fec3d;hpb=b3ba6f2433c428af9c4068023a533341251686ec;p=worldedit.git diff --git a/WorldEdit API.md b/WorldEdit API.md index 22441d2..4169cbe 100644 --- a/WorldEdit API.md +++ b/WorldEdit API.md @@ -6,13 +6,24 @@ If needed, individual modules such as visualization.lua can be removed without a For more information, see the [README](README.md). +General +------- + +### value = worldedit.version + +Contains the current version of WorldEdit in a table of the form `{major=MAJOR_INTEGER, minor=MINOR_INTEGER}`, where `MAJOR_INTEGER` is the major version (the number before the period) as an integer, and `MINOR_INTEGER` is the minor version (the number after the period) as an integer. This is intended for version checking purposes. + +### value = worldedit.version_string + +Contains the current version of WorldEdit in the form of a string `"MAJOR_INTEGER.MINOR_INTEGER"`, where `MAJOR_INTEGER` is the major version (the number before the period) as an integer, and `MINOR_INTEGER` is the minor version (the number after the period) as an integer. This is intended for display purposes. + Manipulations ------------- Contained in manipulations.lua, this module allows several node operations to be applied over a region. ### 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`. +Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear a region, use "air" as the value of `nodename`. Returns the number of nodes set.