flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Documented cStringCompression

Browse Source
This commit is contained in:
STRWarrior 2015-02-23 12:53:34 +01:00
parent 54410bfe4d
commit 174f508021
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -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"},
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 =
{
@ -2900,7 +2921,6 @@ end
BlockStringToType = {Params = "BlockTypeString", Return = "BLOCKTYPE", Notes = "Returns the block type parsed from the given string"},
Clamp = {Params = "Number, Min, Max", Return = "number", Notes = "Clamp the number to the specified range."},
ClickActionToString = {Params = "{{Globals#ClickAction|ClickAction}}", Return = "string", Notes = "Returns a string description of the ClickAction enumerated value"},
CompressString = {Params = "string, length, factor", Return = "string", Notes = "Compresses a string using ZLIB"},
DamageTypeToString = {Params = "{{Globals#DamageType|DamageType}}", Return = "string", Notes = "Converts the {{Globals#DamageType|DamageType}} enumerated value to a string representation "},
EscapeString = {Params = "string", Return = "string", Notes = "Returns a copy of the string with all quotes and backslashes escaped by a backslash"},
GetChar = {Params = "String, Pos", Return = "string", Notes = "Returns one character from the string, specified by position "},
@ -2952,7 +2972,6 @@ end
StringToMobType = {Params = "string", Return = "{{Globals#MobType|MobType}}", Notes = "<b>DEPRECATED!</b> Please use cMonster:StringToMobType(). Converts a string representation to a {{Globals#MobType|MobType}} enumerated value"},
StripColorCodes = {Params = "string", Return = "string", Notes = "Removes all control codes used by MC for colors and styles"},
TrimString = {Params = "string", Return = "string", Notes = "Trims whitespace at both ends of the string"},
UncompressString = {Params = "string, length, uncompressed length", Return = "string", Notes = "Uncompresses a string using ZLIB"},
md5 = {Params = "string", Return = "string", Notes = "<b>OBSOLETE</b>, use the {{cCryptoHash}} functions instead.<br>Converts a string to a raw binary md5 hash."},
},
ConstantGroups =