Difference between revisions of "love.filesystem.remove"
(Add example for recursively removing files.) |
(Add note about files in the .love) |
||
Line 11: | Line 11: | ||
== Notes == | == Notes == | ||
The directory must be empty before removal or else it will fail. Simply remove all files and folders in the directory beforehand. | The directory must be empty before removal or else it will fail. Simply remove all files and folders in the directory beforehand. | ||
+ | |||
+ | If the file exists in the .love but not in the save directory, it returns <code>false</code> as well. | ||
== Examples == | == Examples == | ||
Create a bunch of folders in the save folder and remove them and any file they may contain as soon as the game is quit. | Create a bunch of folders in the save folder and remove them and any file they may contain as soon as the game is quit. |
Revision as of 19:39, 9 February 2015
Removes a file or empty directory.
Contents
Function
Synopsis
ok = love.filesystem.remove( name )
Arguments
string name
- The file or directory to remove.
Returns
boolean ok
- True if the file/directory was removed, false otherwise.
Notes
The directory must be empty before removal or else it will fail. Simply remove all files and folders in the directory beforehand.
If the file exists in the .love but not in the save directory, it returns false
as well.
Examples
Create a bunch of folders in the save folder and remove them and any file they may contain as soon as the game is quit.
function love.load()
local dir = 'a';
for _ = 1, 10 do
dir = dir .. '/a';
end
love.filesystem.createDirectory(dir);
end
function love.quit()
local function recursivelyDelete(item, depth)
if love.filesystem.isDirectory(item) then
for _, child in pairs(love.filesystem.getDirectoryItems(item)) do
recursivelyDelete(item .. '/' .. child, depth + 1);
love.filesystem.remove(item .. '/' .. child);
end
elseif love.filesystem.isFile(item) then
love.filesystem.remove(item);
end
love.filesystem.remove(item)
end
recursivelyDelete('a', 0);
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info