summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-09-11 16:57:57 +0200
committermadmaxoft <github@xoft.cz>2013-09-11 16:57:57 +0200
commit8012b8be6eb667ed018470e08d2b657b62afcd59 (patch)
tree14fec69f205f95d9a484b51cbf4757863203bd71 /MCServer/Plugins/APIDump/APIDesc.lua
parentFixed codepage conversion (diff)
downloadcuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar.gz
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar.bz2
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar.lz
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar.xz
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.tar.zst
cuberite-8012b8be6eb667ed018470e08d2b657b62afcd59.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua68
1 files changed, 68 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
new file mode 100644
index 000000000..44981fdd7
--- /dev/null
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -0,0 +1,68 @@
+
+-- APIDesc.lua
+
+-- Contains the API objects' descriptions
+
+
+
+
+g_APIDesc =
+{
+ Classes =
+ {
+ cBlockArea =
+ {
+ Desc = [[
+ This class is used when multiple adjacent blocks are to be manipulated. Because of chunking
+ and multithreading, manipulating single blocks using {{api:cWorld|cWorld:SetBlock}}() is a rather
+ time-consuming operation (locks for exclusive access need to be obtained, chunk lookup is done
+ for each block), so whenever you need to manipulate multiple adjacent blocks, it's better to wrap
+ the operation into a cBlockArea access. cBlockArea is capable of reading / writing across chunk
+ boundaries, has no chunk lookups for get and set operations and is not subject to multithreading
+ locking (because it is not shared among threads).</p>
+ <p>
+ cBlockArea remembers its origin (MinX, MinY, MinZ coords in the Read() call) and therefore supports
+ absolute as well as relative get / set operations. Despite that, the contents of a cBlockArea can
+ be written back into the world at any coords.</p>
+ <p>
+ cBlockArea can hold any combination of the following datatypes:<ul>
+ <li>block types</li>
+ <li>block metas</li>
+ <li>blocklight</li>
+ <li>skylight</li>
+ </ul>
+ Read() and Write() functions have parameters that tell the class which datatypes to read / write.
+ Note that a datatype that has not been read cannot be written (FIXME).</p>
+ <p>
+ Typical usage:<ul>
+ <li>Create cBlockArea object</li>
+ <li>Read an area from the world</li>
+ <li>Modify blocks inside cBlockArea</li>
+ <li>Write the area back to a world</li>
+ </ul></p>
+ ]],
+ Functions =
+ {
+ Clear = { Notes = "Clears the object, resets it to zero size" },
+ CopyFrom = { Params = "{{cBlockArea|BlockAreaSrc}}", Notes = "Copies contents from BlockAreaSrc into self"},
+ CopyTo = { Params = "{{cBlockArea|BlockAreaDst}}", Notes = "Copies contents from self into BlockAreaDst"},
+ GetBlockLight = { Params = "BlockX, BlockY, BlockZ", Return = "NIBBLETYPE", Notes = "Returns the blocklight at the specified absolute coords"},
+ },
+ },
+
+ cBlockEntity =
+ {
+ }
+ },
+
+ IgnoreFunctions =
+ {
+ "globals.assert",
+ "globals.collectgarbage",
+ "globals.xpcall",
+ }
+} ;
+
+
+
+