Difference between revisions of "love.data.decompress"

m (Added ContainerType param)
m (use value for return type)
Line 1: Line 1:
 
{{newin|[[0.11.0]]|110|type=function|text=Deprecates [[love.math.decompress]]}}
 
{{newin|[[0.11.0]]|110|type=function|text=Deprecates [[love.math.decompress]]}}
 
Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object.
 
Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object.
{{notice|This is unofficial documentation. This might be not accurate!}}
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 11: Line 10:
 
{{param|CompressedData|compressedData|The compressed data to decompress.}}
 
{{param|CompressedData|compressedData|The compressed data to decompress.}}
 
=== Returns ===
 
=== Returns ===
{{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}}
+
{{param|value|decompressedData|[[Data]]/[[string]] containing the raw decompressed data.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 22: Line 21:
 
{{param|string|compressedString|A string containing data previously compressed with [[love.data.compress]].}}
 
{{param|string|compressedString|A string containing data previously compressed with [[love.data.compress]].}}
 
=== Returns ===
 
=== Returns ===
{{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}}
+
{{param|value|decompressedData|[[Data]]/[[string]] containing the raw decompressed data.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 33: Line 32:
 
{{param|Data|data|A Data object containing data previously compressed with [[love.data.compress]].}}
 
{{param|Data|data|A Data object containing data previously compressed with [[love.data.compress]].}}
 
=== Returns ===
 
=== Returns ===
{{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}}
+
{{param|value|decompressedData|[[Data]]/[[string]] containing the raw decompressed data.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.data]]
 
* [[parent::love.data]]

Revision as of 13:05, 22 January 2018

Available since LÖVE 0.11.0
Deprecates love.math.decompress.

Decompresses a CompressedData or previously compressed string or Data object.

Function

Synopsis

decompressedData = love.data.decompress( container, compressedData )

Arguments

ContainerType container
What type to return the decompressed data as.
CompressedData compressedData
The compressed data to decompress.

Returns

value decompressedData
Data/string containing the raw decompressed data.

Function

Synopsis

decompressedData = love.data.decompress( container, format, compressedString )

Arguments

ContainerType container
What type to return the decompressed data as.
CompressedDataFormat format
The format that was used to compress the given string.
string compressedString
A string containing data previously compressed with love.data.compress.

Returns

value decompressedData
Data/string containing the raw decompressed data.

Function

Synopsis

decompressedData = love.data.decompress( container, format, data )

Arguments

ContainerType container
What type to return the decompressed data as.
CompressedDataFormat format
The format that was used to compress the given data.
Data data
A Data object containing data previously compressed with love.data.compress.

Returns

value decompressedData
Data/string containing the raw decompressed data.

See Also

Other Languages