Difference between revisions of "love.filesystem.write"

(Add second return value (error message))
m (See Also: Added love.filesystem.read.)
 
(One intermediate revision by one other user not shown)
Line 25: Line 25:
 
{{param|boolean|success|If the operation was successful.}}
 
{{param|boolean|success|If the operation was successful.}}
 
{{param|string|message|Error message if operation was unsuccessful.}}
 
{{param|string|message|Error message if operation was unsuccessful.}}
 +
 +
== Example ==
 +
<source lang="lua">
 +
local success, message =love.filesystem.write( filename, "")
 +
if success then
 +
print ('file created')
 +
else
 +
print ('file not created: '..message)
 +
end
 +
</source>
 +
 +
 +
  
 
== Notes ==
 
== Notes ==
Line 32: Line 45:
  
 
== See Also ==
 
== See Also ==
 +
* [[love.filesystem.append]]
 +
* [[love.filesystem.read]]
 
* [[parent::love.filesystem]]
 
* [[parent::love.filesystem]]
* [[love.filesystem.append]]
+
 
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Write data to a file.}}
 
{{#set:Description=Write data to a file.}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 +
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.filesystem.write}}
 
{{i18n|love.filesystem.write}}

Latest revision as of 10:00, 13 August 2022

Write data to a file in the save directory. If the file existed already, it will be completely replaced by the new contents.

Function

Synopsis

success, message = love.filesystem.write( name, data, size )

Arguments

string name
The name (and path) of the file.
string data
The string data to write to the file.
number size (all)
How many bytes to write.

Returns

boolean success
If the operation was successful.
string message
Error message if operation was unsuccessful.

Function

Synopsis

success, message = love.filesystem.write( name, data, size )

Arguments

string name
The name (and path) of the file.
Data data
The Data object to write to the file.
number size (all)
How many bytes to write.

Returns

boolean success
If the operation was successful.
string message
Error message if operation was unsuccessful.

Example

local success, message =love.filesystem.write( filename, "")
if success then 
	print ('file created')
else 
	print ('file not created: '..message)
end



Notes

If you are getting the error message "Could not set write directory", try setting the save directory. This is done either with love.filesystem.setIdentity or by setting the identity field in love.conf.

Writing to multiple lines: In Windows, some text editors (e.g. Notepad) only treat CRLF ("\r\n") as a new line.

See Also


Other Languages