diff options
| author | Uberi <azhang9@gmail.com> | 2013-12-10 01:47:32 -0500 |
|---|---|---|
| committer | Uberi <azhang9@gmail.com> | 2013-12-10 01:47:32 -0500 |
| commit | ac7430e02fe0d8dfcef08ab4eda4877241b332df (patch) | |
| tree | 2a109e707234322ad893266094bcde1a9c54cfe5 /WorldEdit API.md | |
| parent | b3ba6f2433c428af9c4068023a533341251686ec (diff) | |
Version information is now available via the API.
Diffstat (limited to 'WorldEdit API.md')
| -rw-r--r-- | WorldEdit API.md | 13 |
1 files changed, 12 insertions, 1 deletions
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.
|