Difference between revisions of "Lua API:File System"
m (Reverted edits by LittleProgramming (talk) to last revision by gamax92) |
(Add fs.isLink and "replace" parameter for fs.move) |
||
| Line 18: | Line 18: | ||
boolean fs.isDirectory(string path) | boolean fs.isDirectory(string path) | ||
Returns a boolean indicating whether "path" exists as a folder (i.e not a file) | Returns a boolean indicating whether "path" exists as a folder (i.e not a file) | ||
| + | |||
| + | === fileSystem.isLink === | ||
| + | boolean fs.isLink(string path) | ||
| + | '''This function is part of an upcoming version, and not present in 97.0''' | ||
| + | |||
| + | Returns a boolean indicating whether "path" is a symbolic link | ||
=== fileSystem.makeDirectory === | === fileSystem.makeDirectory === | ||
| Line 32: | Line 38: | ||
=== fileSystem.move === | === fileSystem.move === | ||
| − | boolean fs.move(string path, string newPath) | + | boolean fs.move(string path, string newPath, bool replace) |
| − | Moves the file or folder specified by "path" to "newPath". This function returns true on success and false on failure. | + | Moves the file or folder specified by "path" to "newPath". This function returns true on success and false on failure. |
| + | |||
| + | '''The following note is for an upcoming version, and does not apply to 97.0''' | ||
| + | |||
| + | The "replace" parameter controls whether or not the rename should fail if "newPath" already exists. By default, replace is false. | ||
=== fileSystem.copy === | === fileSystem.copy === | ||
Revision as of 03:39, 22 November 2023
The File System API contains functions for creating, deleting, modifying and enumerating files and folders.
Contents
Methods
fileSystem.list
table fs.list(string folder)
Returns a table containing a list of files and folders in "folder"
fileSystem.exists
boolean fs.exists(string path)
Returns a boolean indicating whether "path" exists as either a file or folder
fileSystem.isFile
boolean fs.isFile(string path)
Returns a boolean indicating whether "path" exists as a file (i.e not a folder)
fileSystem.isDirectory
boolean fs.isDirectory(string path)
Returns a boolean indicating whether "path" exists as a folder (i.e not a file)
fileSystem.isLink
boolean fs.isLink(string path)
This function is part of an upcoming version, and not present in 97.0
Returns a boolean indicating whether "path" is a symbolic link
fileSystem.makeDirectory
boolean fs.makeDirectory(string path)
Creates the folder "path", this function is not recursive and won't create parent directories (makeDirectory("parent/child") will fail if "parent" does not exist). This function returns true on success and false on failure.
fileSystem.removeDirectory
boolean fs.removeDirectory(string path)
Removes the empty folder specified by "path". This function returns true on success and false on failure.
fileSystem.removeFile
boolean fs.removeFile(string path)
Removes the file "path". This function returns true on success and false on failure.
fileSystem.move
boolean fs.move(string path, string newPath, bool replace)
Moves the file or folder specified by "path" to "newPath". This function returns true on success and false on failure.
The following note is for an upcoming version, and does not apply to 97.0
The "replace" parameter controls whether or not the rename should fail if "newPath" already exists. By default, replace is false.
fileSystem.copy
boolean fs.copy(string path, string newPath)
Copies the file "path" to "newPath". This function returns true on success and false on failure.
