Scripting Documentation

Appearance

fs class ​

fs.exists ​

lua
function fs.exists(path) end

Checks if the specified path exists.

Parameters ​

  • path: string: The file path relative to the Flarial folder.

Returns ​

  • boolean: True if the path exists.

fs.isDirectory ​

lua
function fs.isDirectory(path) end

Checks if the specified path is a directory.

Parameters ​

  • path: string: The file path relative to the Flarial folder.

Returns ​

  • boolean: True if the path is a directory.

fs.create ​

lua
function fs.create(path) end

Creates a directory at the specified path.

Parameters ​

  • path: string: The directory path relative to the Flarial folder.

Returns ​

  • boolean: True if the directory was successfully created.

fs.remove ​

lua
function fs.remove(path) end

Removes the file or directory at the specified path.

Parameters ​

  • path: string: The file or directory path relative to the Flarial folder.

Returns ​

  • boolean: True if removal was successful.

fs.readFile ​

lua
function fs.readFile(path) end

Reads the contents of a file at the specified path.

Parameters ​

  • path: string: The file path relative to the Flarial folder.

Returns ​

  • string: The file’s content.

fs.writeFile ​

lua
function fs.writeFile(path, content) end

Writes content to the file at the specified path.

Parameters ​

  • path: string: The file path relative to the Flarial folder.
  • content: string: The content to write.

Returns ​

  • boolean: True if writing was successful.

fs.listDirectory ​

lua
function fs.listDirectory(path) end

Lists the contents of the directory at the specified path.

Parameters ​

  • path: string: The directory path relative to the Flarial folder.

Returns ​

  • string[]: An array of file and directory names.

Reference: fs.lua