summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2015-02-25 10:18:39 +0100
committerMattes D <github@xoft.cz>2015-02-25 10:18:39 +0100
commit81c49a0246f92e3e02879c2a7c0065673d539161 (patch)
tree116a3642dafc14520a1b121b155adb879e500790 /MCServer/Plugins/APIDump/APIDesc.lua
parent1.8 Protocol: Fixed a possible race condition. (diff)
parentAdded documentation for CompressStringZLIB (diff)
downloadcuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar.gz
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar.bz2
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar.lz
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar.xz
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.tar.zst
cuberite-81c49a0246f92e3e02879c2a7c0065673d539161.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua21
1 files changed, 21 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 61fc69d32..f2ec2546a 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2254,6 +2254,27 @@ end
ShouldAuthenticate = { Params = "", Return = "bool", Notes = "Returns true iff the server is set to authenticate players (\"online mode\")." },
},
}, -- cServer
+
+ cStringCompression =
+ {
+ Desc = [[
+ Provides functions to compress or decompress string
+ <p>
+ All functions in this class are static, so they should be called in the dot convention:
+<pre class="prettyprint lang-lua">
+local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress")
+</pre>
+ ]],
+
+ Functions =
+ {
+ CompressStringGZIP = {Params = "string", Return = "string", Notes = "Compress a string using GZIP"},
+ CompressStringZLIB = {Params = "string, factor", Return = "string", Notes = "Compresses a string using ZLIB. Factor 0 is no compression and factor 9 is maximum compression"},
+ InflateString = {Params = "string", Return = "string", Notes = "Uncompresses a string using Inflate"},
+ UncompressStringGZIP = {Params = "string", Return = "string", Notes = "Uncompress a string using GZIP"},
+ UncompressStringZLIB = {Params = "string, uncompressed length", Return = "string", Notes = "Uncompresses a string using ZLIB"},
+ },
+ },
cTeam =
{