Difference between revisions of "love.filesystem.newFileData"

(Updated for 11.0)
m
 
Line 1: Line 1:
Creates a new [[FileData]] object.
+
Creates a new [[FileData]] object from a file on disk, or from a string in memory.
  
 
== Function ==
 
== Function ==
 +
Creates a new FileData object from a string in memory.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 7: Line 8:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|contents|The contents of the file.}}
+
{{param|string|contents|The contents of the file in memory represented as a string.}}
{{param|string|name|The name of the file.}}
+
{{param|string|name|The name of the file. The extension may be parsed and used by LÖVE when passing the FileData object into [[love.audio.newSource]].}}
 
=== Returns ===
 
=== Returns ===
{{param|FileData|data|Your new FileData.}}
+
{{param|FileData|data|The new FileData.}}
  
 
== Function ==
 
== Function ==
Line 42: Line 43:
 
* [[Constructs::FileData]]
 
* [[Constructs::FileData]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Creates a new [[FileData]] object.}}
+
{{#set:Description=Creates a new [[FileData]] object from a file on disk, or from a string in memory.}}
 
{{#set:Since=070}}
 
{{#set:Since=070}}
 
{{#set:PrettySince=0.7.0}}
 
{{#set:PrettySince=0.7.0}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.filesystem.newFileData}}
 
{{i18n|love.filesystem.newFileData}}

Latest revision as of 23:56, 14 January 2020

Creates a new FileData object from a file on disk, or from a string in memory.

Function

Creates a new FileData object from a string in memory.

Synopsis

data = love.filesystem.newFileData( contents, name )

Arguments

string contents
The contents of the file in memory represented as a string.
string name
The name of the file. The extension may be parsed and used by LÖVE when passing the FileData object into love.audio.newSource.

Returns

FileData data
The new FileData.

Function

Available since LÖVE 0.9.0
This variant is not supported in earlier versions.

Creates a new FileData from a file on the storage device.

Synopsis

data, err = love.filesystem.newFileData( filepath )

Arguments

string filepath
Path to the file.

Returns

FileData data
The new FileData, or nil if an error occurred.
string err
The error string, if an error occurred.

Function

Removed in LÖVE 11.0
The variant which decodes base64 data has been replaced by love.data.decode.

Synopsis

data = love.filesystem.newFileData( contents, name, decoder )

Arguments

string contents
The contents of the file.
string name
The name of the file.
FileDecoder decoder
The method to use when decoding the contents.

Returns

FileData data
Your new FileData.

See Also


Other Languages