Difference between revisions of "love.math.decompress"

(the compression format is a required argument)
m (0.11.0 -> 11.0)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{newin|[[0.10.0]]|100|type=function}}
 
{{newin|[[0.10.0]]|100|type=function}}
 +
{{deprecatedin|[[11.0]]|110|type=function|text=This function is deprecated and is replaced by [[love.data.decompress]]}}
 
Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object.
 
Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object.
 
== Function ==
 
== Function ==
Line 13: Line 14:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
compressedData = love.math.decompress( compressedstring, format )
+
rawstring = love.math.decompress( compressedString, format )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
Line 23: Line 24:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
compressedData = love.math.decompress( data, format )
+
rawstring = love.math.decompress( data, format )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===

Latest revision as of 18:15, 7 May 2019

Available since LÖVE 0.10.0
This function is not supported in earlier versions.
Deprecated in LÖVE 11.0
This function is deprecated and is replaced by love.data.decompress.

Decompresses a CompressedData or previously compressed string or Data object.

Function

Synopsis

rawstring = love.math.decompress( compressedData )

Arguments

CompressedData compressedData
The compressed data to decompress.

Returns

string rawstring
A string containing the raw decompressed data.

Function

Synopsis

rawstring = love.math.decompress( compressedString, format )

Arguments

string compressedstring
A string containing data previously compressed with love.math.compress.
CompressedDataFormat format
The format that was used to compress the given string.

Returns

string rawstring
A string containing the raw decompressed data.

Function

Synopsis

rawstring = love.math.decompress( data, format )

Arguments

Data data
A Data object containing data previously compressed with love.math.compress.
CompressedDataFormat format
The format that was used to compress the given data.

Returns

string rawstring
A string containing the raw decompressed data.

See Also

Other Languages