summaryrefslogtreecommitdiffstats
path: root/MCServer
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua2
1 files changed, 1 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index c214434b5..f2ec2546a 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2269,7 +2269,7 @@ local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress")
Functions =
{
CompressStringGZIP = {Params = "string", Return = "string", Notes = "Compress a string using GZIP"},
- CompressStringZLIB = {Params = "string, factor", Return = "string", Notes = "Compresses a string using ZLIB"},
+ 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"},